Client Relationships Resource

A Client may have one or many Relationships. Directs client Relationships search where it is a root element. It includes the below APIs:

  • GET client's relationships
  • GET client's relationships with search query or criteria

GET Client's Relationships

Retrieves all client's relationships for a specific client. Returns all the data Asclientrelationship, AsClientRelationshipField and AsClientRelationshipMVF for a client with ID specified. This ID is the secondaryclientguid in AsClientRelationship table.

Resource/Request URI

http://server:port/PASService/rest/services/clients/{id}/clientRelationships

Method

GET

Example

/clients/239DDEDE-0B26-4500-B674-01F8B3BDAFC9/clientRelationships

GET Client's Relationships with Search Query or Criteria

Returns client's relationships for the specified search criteria. 

Example 1:
/clientRelationships? q=memberId eq "1234*"

Here memberId is a dynamic field in AsClientRelationshipField 

Example 2:
/clientRelationships? q=primaryClientId='501D8245-730C-4CA5-87EC-A823AE428691'

The response will include Asclientrelationship, AsClientRelationshipField and AsClientRelationshipMVF and also links to client object for Primary Client Guid and Secondary Client Guid. The response includes information of fixed fields from AsClient table.

Resource/Request URI

http://server:port/PASService/rest/services//clientrelatonships?q=

Method

GET

Sample JSON Response

{
    "count": "3",
    "clientRelationships": [{
            "clientRelationshipId": "A2797587-9131-4B68-BBD5-CDEEB37AF4E5",
            "primaryClientId": "423883E9-DBA4-4601-B5E1-25765ECD9657",
            "secondaryclientId": "6FB7E2E3-046E-409D-A6B6-C2D2E8B00FB3",
            "primaryrelationshipType": "Employment",
            "secondaryrelationshipType": "FULLTIME",
            "recordStatus": "ACTIVE",
            "clientRelationshipparentId": "BC143B53-C245-4E52-B611-A9506B080D57",
            "updatedBy": "nickn2",
            "activeDateTime": "2017 - 07 - 17 T19: 04: 49 - 04: 00 ",
            "effectiveFrom": "2017 - 07 - 17 T19: 04: 49 - 04: 00 ",
            "updatedDateTime": "2017-07-17T19:04:49-04:00",
            "baseSalary": "1000.35",
            "businessUnit": "Legal",
            "customerEmploymentStatus": "active",
            "eligibilityNotes": "eligible",
            "memberId": "KLM1234",
            "primaryClient": {
                "clientId": "ACD5CB8E-4035-43CC-9D75-12158666A593",
                "clientType": "Individual",
                "firstName": "Johny",
                "lastName": "jack",
                "taxId": "1265118",
                "dateOfBirth": "1988-07-17T19:04:49-04:00",
                "updatedDateTime": "2017-07-17T19:04:49-04:00",
                "legalResidence": "SG",
                "entityType": "Client",
                "statuscode": "Active"
            },
            "secondaryClient": {
                "clientId": "5012334343",
                "clientType": "Company",
                "companyName": "Charlis Inc",
                "updatedDateTime": "2017-07-17T19:04:49-04:00",
                "legalResidence": "SG",
                "entityType": "Groupcustomer",
                "statuscode": "Active"
            }
        }
    ]
}