Get a specific client by client Id
get
/PASService/rest/services/clients/{id}
Gets a client based on the specified 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
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get a client based on the specified 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"
Example Response Body
The following shows an example of the response body in JSON format:
"{ "client": { "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/clients/196770A7-8662-4161-8DEE-F5F45B702FB7/addresses", "rel": "addresses", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/clients/196770A7-8662-4161-8DEE-F5F45B702FB7/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=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" } ], "multiFields": {}, "codes": [ { "codeName": "ASCODEENTITYTYPE", "codeValue": "CLIENT", "longDescription": "Client", "shortDescription": "Client" }, { "codeName": "AsCodeClientType", "codeValue": "02", "longDescription": "Individual", "shortDescription": "Individual" }, { "codeName": "AsCodeClientStatus", "codeValue": "Active", "longDescription": "Client Status 'Active'", "shortDescription": "Active" } ], "dateOfBirth": "1998-10-24T17:00:00Z", "email": "Enroll_LNApr16@test.com", "sex": "M", "entityTypeCode": "CLIENT", "addresses": [ { "links": [ { "href": "http://server:port/PASService/rest/services/clients/196770A7-8662-4161-8DEE-F5F45B702FB7/addresses/295D23F3-12D8-41D1-B78B-083ED3C16225", "rel": "self", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/codes?codeName=AddressRole&codeValue=02", "rel": "codes/addressType", "mediaType": "application/json", "method": "GET" }, { "href": "http://server:port/PASService/rest/services/codes?codeName=State&codeValue=38", "rel": "codes/state", "mediaType": "application/json", "method": "GET" } ], "multiFields": {}, "codes": [ { "codeName": "AsCodeAddressRole", "codeValue": "02", "longDescription": "Home", "shortDescription": "Home" }, { "codeName": "AsCodeState", "codeValue": "38", "longDescription": "Pennsylvania", "shortDescription": "PA" } ], "addressLine1": "1801 Walnut Street", "city": "Philadelphia", "addressType": "02", "clientId": "196770A7-8662-4161-8DEE-F5F45B702FB7", "addressId": "295D23F3-12D8-41D1-B78B-083ED3C16225", "state": "38", "country": "US", "phone": "123-123-1233", "ReturnMailIndicator": "CHECKED", } ], "clientId": "196770A7-8662-4161-8DEE-F5F45B702FB7", "firstName": "Test_FN_DI_493178704", "lastName": "Test_LN_DI_493178704", "middleInitial": "Test_MN_DI_493178704", "taxId": "493178704", "type": "02", "status": "Active", "TaxIDSource": "01", "PersonSponsorID": "493178704" } } "