Update a Worker Home Address

Alex has relocated to a new home and his home address needs to be updated effective from the date of his relocation.

To update the home address:

  1. Retrieve (GET) the worker addresses and obtain the address item link.
  2. Perform a PATCH operation on this URL by providing the new home address in the request body.

Example URL

Use this resource URL format.

PATCH

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{PersonAddrUsageId}

Example Request

Here's an example of the request body in JSON format.

Provide the headers.

Content-Type : application/vnd.oracle.adf.resourceitem+json
REST-Framework-Version : 4
effective-Of : RangeMode=UPDATE;RangeStartDate=2019-06-10;RangeEndDate=4712-12-31
{
"AddressLine1":"300 Main Drive",
"TownOrCity":"Suwanee",
"Region1":"Gwinnett",
"Region2":"GA",
"PostalCode":"30024",
"Country":"US",
"PrimaryFlag":true
}

Example Response

Here's an example of the response body in JSON format.

{
"AddressId": 300100180005741,
"EffectiveStartDate": "2019-06-10",
"EffectiveEndDate": "4712-12-31",
"AddressLine1": "300 Main Drive",
"AddressLine2": null,
"AddressLine3": null,
"AddressLine4": null,
"TownOrCity": "Suwanee",
"Region1": "Gwinnett",
"Region2": "GA",
"Region3": null,
"Country": "US",
"PostalCode": "30024",
"LongPostalCode": null,
"AddlAddressAttribute1": null,
"AddlAddressAttribute2": null,
"AddlAddressAttribute3": null,
"AddlAddressAttribute4": null,
"AddlAddressAttribute5": null,
"CreatedBy": "HCM_INTEGRATION_SPEC",
"CreationDate": "2019-06-07T15:52:00.336+00:00",
"LastUpdatedBy": "HCM_INTEGRATION_SPEC",
"LastUpdateDate": "2019-06-10T20:08:49.319+00:00",
"PersonAddrUsageId": 300100180005742,
"AddressType": "HOME",
"PrimaryFlag": true,
"links": [...]
}