Get client relationships for a specific client
get
/PASService/rest/services/clients/{id}/clientRelationships
Gets a list of client relationships for a client based on the client Id
Request
Path Parameters
-
id: string
Pattern:
\{?[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}\}?Client Id
Query Parameters
-
expand(optional): string
codes
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get a list of client relationships for a client based on the client Id.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/clients/196770A7-8662-4161-8DEE-F5F45B702FB7/clientRelationships"
Example Response Body
The following shows an example of the response body in JSON format:
"{
"count": 1,
"clientRelationships": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/clients/196770A7-8662-4161-8DEE-F5F45B702FB7/clientRelationships",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/clients/8D3A6424-006F-4B19-A486-E444E649FCA2",
"rel": "primaryClient",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/clients/196770A7-8662-4161-8DEE-F5F45B702FB7",
"rel": "secondaryClient",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=SecondaryRelationshipType&codeValue=FULLTIME",
"rel": "codes/secondaryRelationshipType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=PrimaryRelationshipType&codeValue=Employment",
"rel": "codes/primaryRelationshipType",
"mediaType": "application/json",
"method": "GET"
}
],
"multiFields": {},
"primaryRelationshipType": "Employment",
"secondaryRelationshipType": "FULLTIME",
"effectiveFrom": "2009-12-31T16:00:00Z",
"createdBy": "qatester3",
"updatedBy": "qatester3",
"primaryClient": {
"links": [
{
"href": "http://server:port/PASService/rest/services/clients/8D3A6424-006F-4B19-A486-E444E649FCA2",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=ENTITYTYPE&codeValue=GROUPCUST",
"rel": "codes/entityTypeCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=ClientType&codeValue=20",
"rel": "codes/type",
"mediaType": "application/json",
"method": "GET"
}
]
},
"secondaryClient": {
"links": [
{
"href": "http://server:port/PASService/rest/services/clients/196770A7-8662-4161-8DEE-F5F45B702FB7",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=ENTITYTYPE&codeValue=CLIENT",
"rel": "codes/entityTypeCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=ClientSex&codeValue=M",
"rel": "codes/sex",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=ClientType&codeValue=02",
"rel": "codes/type",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/codes?codeName=ClientStatus&codeValue=Active",
"rel": "codes/status",
"mediaType": "application/json",
"method": "GET"
}
]
},
"clientRelationshipId": "4177748F-711F-4269-B78C-940600E26DA7",
"clientRelationshipparentId": "16B94A90-FED8-4722-AF34-2DE516167831",
"primaryClientId": "8D3A6424-006F-4B19-A486-E444E649FCA2",
"secondaryClientId": "196770A7-8662-4161-8DEE-F5F45B702FB7",
"activeDateTime": "2019-05-28T13:39:51Z",
"recordStatus": "ACTIVE",
"updatedDateTime": "2019-05-28T13:39:51Z",
"JobStatus": "Active",
"SalaryMultiplier": 3,
"PastSalary": {
"value": 24,
"currency": "USD"
},
"CustomerEmploymentStatusCode": "ACTIVE",
"EmploymentStatus": {
"textValue": "02",
"optionText": "Inactive"
},
"EmployeeSalary": {
"value": 55000,
"currency": "USD"
},
"BusinessUnit": "FULLTIME",
}
]
}
"