Get the list of client relationships for a specific client by client Id
get
/PASService/rest/services/v1/clients/{clientId}/clientRelationships
Gets a list of client relationships for a client based on the client Id.
Request
Path Parameters
-
clientId(required): string(guid)
Client Id
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "the name of the child resource". More than one child can be specified using comma as a separator. Example:?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers). More than one child can be specified using comma as a separator. For example: "?expand=Employees,Localizations". Nested children can also be provided following the format: "Child.NestedChild" For example:"?expand=Employees.Managers" If a nested child is provided (Example:Employees.Managers), the missing children will be processed implicitly i.e.,"?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers", which will expand both Employees and Managers.
-
limit: integer(int32)
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer(int32)
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;loc!="NY.
There's no request body for this operation.
Back to TopResponse
200 Response
This operation fetches list of client relationships for a specific client by client Id successfully.
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 "Content-Type: application/json" \ -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \ -L "http://server:port//PASService/rest/services/v1/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/v1/clients/196770A7-8662-4161-8DEE-F5F45B702FB7/clientRelationships",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/clients/8D3A6424-006F-4B19-A486-E444E649FCA2",
"rel": "primaryClient",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/clients/196770A7-8662-4161-8DEE-F5F45B702FB7",
"rel": "secondaryClient",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/codes?codeName=SecondaryRelationshipType&codeValue=FULLTIME",
"rel": "codes/secondaryRelationshipType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/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/v1/clients/8D3A6424-006F-4B19-A486-E444E649FCA2",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/codes?codeName=ENTITYTYPE&codeValue=GROUPCUST",
"rel": "codes/entityTypeCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/codes?codeName=ClientType&codeValue=20",
"rel": "codes/type",
"mediaType": "application/json",
"method": "GET"
}
]
},
"secondaryClient": {
"links": [
{
"href": "http://server:port//PASService/rest/services/v1/clients/196770A7-8662-4161-8DEE-F5F45B702FB7",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/codes?codeName=ENTITYTYPE&codeValue=CLIENT",
"rel": "codes/entityTypeCode",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/codes?codeName=ClientSex&codeValue=M",
"rel": "codes/sex",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/codes?codeName=ClientType&codeValue=02",
"rel": "codes/type",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port//PASService/rest/services/v1/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",
}
]
}