Update a specific client address for a specific client by client Id and address Id

put

/PASService/rest/services/v1/clients/{clientId}/addresses/{addressId}

Updates the address of the client based on the specified client Id and address Id.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: string
Back to Top

Response

204 Response

This operation updates a specific client address for a specific client by client Id and address Id successfully.
Back to Top

Examples

This example describes how to update the address of the client based on the specified client Id and address Id.

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"}'

Note:

The request body for updating a Client address using a Client ID and AddressID dynamic and depends on the Client schema i.e. the configuration the fields, multifield etc. It will differ from case to case based on the configuration.

Example Request Body

The following code shows an example of the request body in JSON format:

{
  "address": {
    "multiFields": {},
        "codes": [
            {
                "codeName": "AsCodeAddressRole",
                "codeValue": "04",
                "longDescription": "Billing",
                "shortDescription": "Billing"
            },
            {
                "codeName": "AsCodeState",
                "codeValue": "01",
                "longDescription": "NY",
                "shortDescription": "NY"
            }
        ],
        "defaultFlag": null,
        "eMailCorrespondenceFlag": null,
        "effectiveDate": "2020-06-15T00:00:00Z",
        "addressLine1": "Hydernagar Plot",
        "addressLine2": null,
        "addressLine3": null,
        "addressLine4": null,
        "addressLine5": null,
        "addressLine6": null,
        "city": "Hyderabad",
        "postalID": "500072",
        "email": "arunsai.kumar12@gmail.com",
        "faxNumber": null,
        "phones": null,
        "addressType": "04",
        "clientId": "02295BF1-AFE0-4A22-8037-5A7F8512F36B",
        "addressId": "F38F33DF-1491-4A3E-BDF7-F0E81E6E1D5D",
        "expiryDate": null,
        "region": null,
        "municipality": null,
        "state": "01",
        "country": "US",
        "phone": null,
        "ReturnMailIndicator": "CHECKED",
        "SystemDateGSM": "2020-06-15T00:00:00Z",
        "ReturnedMailDate": null,
        "CostOfStamp": {
            "value": 0.0,
            "currency": "USD"
        },
        "TestInteger": 0,
        "ClientGUID": {
            "textValue": "02295BF1-AFE0-4A22-8037-5A7F8512F36B",
            "optionText": "bye bye"
        },
        "LetterMailDate": null,
        "BankAccountNumber": null,
        "TestDecimal": 0.0
    }
}
Back to Top