Partially update a specific client address for a specific client by client Id and address Id
patch
/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}
Partially updates the address of the client based on the specified client Id and address Id
Request
Path Parameters
-
addressId(required): string(guid)
Address Id
-
clientId(required): string(guid)
Client Id
Supported Media Types
- application/json
Root Schema : schema
Type:
stringResponse
204 Response
successful operation
Examples
This example describes how to update a client address partially for the fields given in request body for a specified client by client Id and address Id.
Note
Below is the list of Fields that are not allowed for update using PATCH.
- addressId
- addressType
- countryCode
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-L "http://server:port/PASService/rest/services/v1/clients/DE91F107-6BCC-46AB-877C-05D810E5C563/addresses" \
-d '{"Use this placeholder to plug-in the example request body given below"}'
Example Request Body
The following shows an example of the request body in JSON format:
{
"address": {
"state": "01",
"country": "US",
"phone": "7890231900",
"ReturnMailIndicator": "CHECKED",
"CostOfStamp": {
"value": 24,
"currency": "USD"
}
}
}