searchRelationshipsService

An important component of Person Data Management is the ability to understand and define how two person identities are related to one another.

With Verato, a user can create direct relationships between Person entities (mapped from LinkID to LinkID). Verato supplies pre-defined relationship types, sometimes referred to as “verbs”, to define the relationship that exists between two entities. Examples may include is parent of or is caregiver for. Customers can work with Verato customer support representatives to define additional relationship types on an as-needed basis. Relationship domains–for example PERSON–are a way to group common relationship types together.

The searchRelationshipsService web service enables users to search for existing relationships between Person entities. This service is crucial for users who need to identify and analyze the connections between Persons, facilitating better data management and decision-making processes.

Sample URL

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

searchRelationshipsService JSON request

• The request requires:
  • A trackingId for audit and traceability
  • A relationshipFilter object containing options to:
    • filter relationships by the subject Verato LinkId
    • filter relationships by the subject or object Verato LinkId
    • filter relationships by the object Verato LinkId
    • filter relationships by verb

• {
    "trackingId": "string",
    "content": {
      "relationshipFilter": {
        "filterBySubjectVeratoId": "string",
        "filterBySubjectOrObjectVeratoId": "string",
        "filterByObjectVeratoId": "string",
        "filterByRelationshipVerb": "string"
      }
    }
  }

searchRelationshipsService JSON response

• The response includes:
  • A trackingId for audit and traceability
  • Several Boolean and string values with more information about the success/failure of the service
  • A list of relationship objects containing the relationships found by the service, including:
    • The relationship id
    • The subject Verato linkId - the subject of the relationship
    • The object Verato linkId - the object of the relationship
    • The domain that the verb is configured under - for Person relationships, this will mostly be PERSON
    • The start date of the relationship, if asserted
    • The end date of the relationship, if asserted

• {
    "success": boolean,
    "message": "string",
    "content": {
      "relationships": [
        {
          "id": "string",
          "subjectVeratoId": "string",
          "objectVeratoId": "string",
          "domain": "string",
          "relationshipVerb": "string",
          "startDate": "string",
          "endDate": "string",
          "status": "string",
          "trustFactor": "string"
        }
      ]
    },
    "trackingId": "string",
    "auditId": "string",
    "retryableError": boolean
  }