Get list of clients
get
/PASService/rest/services/clients
Gets a list of the latest 100 clients. Also, define expand attributes to expand a client by its sub-resources, such as addresses and phones
Request
Query Parameters
-
expand(optional): string
addresses, phones, codes
-
q(optional): string
Search Parameter
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get a list of the latest 100 clients. Also, define expand attributes to expand a client by its sub-resources, such as addresses and phones.
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"
Example Response Body
The following shows an example of the response body in JSON format:
"{
"count": 100,
"offset": 0,
"limit": 100,
"clients": [
{
"links": [
{
"href": "http://server:port/PASService/rest/services/clients/2C3D7F85-8B29-46D3-A978-F1262798729D",
"rel": "self",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/clients/2C3D7F85-8B29-46D3-A978-F1262798729D/addresses",
"rel": "addresses",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/clients/2C3D7F85-8B29-46D3-A978-F1262798729D/phones",
"rel": "phones",
"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=01",
"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=MaritalStatus&codeValue=02",
"rel": "codes/maritalStatus",
"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"
}
],
"multiFields": {
"MultiFieldSETA": [
{
"index": 0,
"HiddenField12": "Hashton",
"HiddenField1": "Aston"
}
]
},
"dateOfBirth": "1991-01-01T00:00:00Z",
"dateOfDeath": "2084-01-01T00:00:00Z",
"prefix": "01",
"sex": "01",
"legalResidenceCountryCode": "CA",
"maritalStatus": "02",
"birthCountryCode": "CA",
"citizenshipCountryCode": "CA",
"entityTypeCode": "CLIENT",
"clientId": "2C3D7F85-8B29-46D3-A978-F1262798729D",
"firstName": "Abhishek_API",
"lastName": "Mishra_API",
"middleInitial": "Middle_API",
"taxId": "534465876",
"type": "02",
"status": "Active",
"RadioTest": {
"textValue": "01",
"optionText": "Yes"
},
"ComboField": {
"textValue": "01",
"optionText": "Savings"
},
"TaxIDSource": {
"textValue": "01",
"optionText": "Application"
},
"LetterSendDate": "2001-01-01T00:00:00Z",
"TransactionField": "Best",
"TestField": "Test"
}
"