Get list of addresses by client
get
/PASService/rest/services/clients/{id}/addresses
Get addresses for 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
Query Parameters
-
expand(optional): string
codes
Response
Supported Media Types
- application/json
Default Response
successful operation
Examples
This example describes how to get addresses for 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/addresses"
Example Response Body
The following shows an example of the response body in JSON format:
"{ "count": 1, "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": {}, "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" } ] } "