Get the list of addresses for a specific client by client Id
get
/PASService/rest/services/v1/clients/{clientId}/addresses
Gets addresses for a client based on the specified client Id.
Request
Path Parameters
-
clientId(required): string(guid)
Client Id
Query Parameters
-
expand(required): 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(required): 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(required): 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(required): 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 all the addresses for a specific client by client Id successfully.
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 "Content-Type: application/json" \ -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \ -L "http://server:port/PASService/rest/services/v1/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/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": {}, "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" } ] }