Get a specific address for a specific client by client Id and address Id
get
/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}
Gets the address for a client based on the client Id and address Id.
Request
Path Parameters
-
addressId(required): string
Address Id
-
clientId(required): string(guid)
Client Id
There's no request body for this operation.
Back to TopResponse
200 Response
This operation fetches specific address for a specific client by client Id and address Id.
Examples
This example describes how to get the address for a client based on the client Id and address 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/addresses/295D23F3-12D8-41D1-B78B-083ED3C16225"
Example Response Body
The following shows an example of the response body in JSON format:
{
"address": {
"links": [
{
"href": "http://server:port/PASService/rest/services/v1/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/v1/codes?codeName=AddressRole&codeValue=02",
"rel": "codes/addressType",
"mediaType": "application/json",
"method": "GET"
},
{
"href": "http://server:port/PASService/rest/services/v1/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",
}
}