getRelationshipDefinitionV2Service

The getRelationshipDefinitionV2Service retrieves all the available relationships that an API user or MDM Cloud UI user can define between two person identities.

Sample URL

The URL for this request is of the format https://custXXXX.verato-connect.com/link-ws/svc/getRelationships/Service , where XXXX is a 4-digit number.

getRelationshipDefinitionV2Service JSON request

• Since we are only retrieving the definitions of the available relationship types, there are no parameters needed for this API request.

• {
    "content": {}
  }

getRelationshipDefinitionV2Service JSON response

• The response includes:
  • An ‘echo’ of the same tracking ID from the request
  • Several Boolean and string values with more information about the success/failure of the service

  • A list of relationship definitions, each consisting of the following:

    • the relationship between identity A and B
    • the relationship’s inverse - the relationship between identity B and A
    • the subject entity type
    • the object entity type

    Currently, only Person to Person relationships are supported.

• {
    "success": true,
    "message": "RelDefs",
    "content": {
      "relationshipDefinitions": [
        {
          "name": "Person",
          "restricted": false,
          "verbDefinitions": [
            {
              "verb": "is parent of",
              "inverse": "is child of",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is twin of",
              "inverse": "is twin of",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is sibling to",
              "inverse": "is sibling to",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is next of kin for",
              "inverse": "is next of kin of",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is guardian for",
              "inverse": "under guardianship of",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "has dependent",
              "inverse": "is dependent of",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "employs",
              "inverse": "is employed by",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is guarantor for",
              "inverse": "is guaranteed by",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is caregiver for",
              "inverse": "is cared for by",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is interpreter for",
              "inverse": "is interpreted by",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is power of attorney for",
              "inverse": "has granted power of attorney to",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is durable power of attorney for",
              "inverse": "has granted durable power of attorney to",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is special power of attorney for",
              "inverse": "has granted special power of attorney to",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is healthcare power of attorney for",
              "inverse": "has granted healthcare power of attorney to",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is the billing contact for",
              "inverse": "has billing contact of",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            },
            {
              "verb": "is emergency contact for",
              "inverse": "is emergency contact of",
              "subjectType": "PERSON",
              "objectType": "PERSON"
            }
          ]
        }
      ]
    },
    "auditId": "8982f1d4-0f9b-4ec4-afcf-5bfc01802b37",
    "retryableError": false
  }