Update an address
patch
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
Request
Path Parameters
-
addressesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Addresses resource and used to uniquely identify an instance of Addresses. The client should not generate the hash key value. Instead, the client should query on the Addresses collection resource in order to navigate to a specific instance of Addresses to get the hash key.
-
hcmContactsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the HCM Contacts resource and used to uniquely identify an instance of HCM Contacts. The client should not generate the hash key value. Instead, the client should query on the HCM Contacts collection resource in order to navigate to a specific instance of HCM Contacts to get the hash key.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AddlAddressAttribute1: string
Title:
Additional Address Attribute 1
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute2: string
Title:
Additional Address Attribute 2
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute3: string
Title:
Additional Address Attribute 3
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute4: string
Title:
Additional Address Attribute 4
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute5: string
Title:
Additional Address Attribute 5
Maximum Length:150
Additional address column used by localizations. -
addressesDFF: array
addressesDFF
-
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
First line of the primary mail address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
Second line of the primary mail address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
Third line of the primary mail address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
Fourth line of the primary mail address. -
Building: string
Title:
Building
Maximum Length:240
Building information associated with the address. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
Floor number associated with the building. -
Latitude: number
Title:
Latitude
Distance between the equator and an address located to its north or south, expressed in degrees and minutes. -
Longitude: number
Title:
Longitude
Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes. -
LongPostalCode: string
Title:
Long Postal Code
Maximum Length:30
Long postal code of the primary mail address. -
PostalCode: string
Title:
Postal Code
Maximum Length:30
Postal code of the primary mail address. -
PrimaryFlag: boolean
Title:
Primary Mailing
Indicates whether the address is the primary mailing address. -
Provider: string
Title:
Provider
Maximum Length:150
Company that has validated the address. -
Region1: string
Title:
Region 1
Maximum Length:120
Primary region in which the address is located. -
Region2: string
Title:
Region 2
Maximum Length:120
Secondary region within the primary region. -
Region3: string
Title:
Region 3
Maximum Length:120
Additional secondary region within the primary region. -
TownOrCity: string
Title:
Town or City
Maximum Length:60
Town or city in which the address is located. -
ValidationStatusCode: string
Title:
Validation Status Code
Maximum Length:120
Level of accuracy of an address, as determined by an address provider.
Nested Schema : hcmContacts-addresses-addressesDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : hcmContacts-addresses-item-response
Type:
Show Source
object
-
AddlAddressAttribute1: string
Title:
Additional Address Attribute 1
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute2: string
Title:
Additional Address Attribute 2
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute3: string
Title:
Additional Address Attribute 3
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute4: string
Title:
Additional Address Attribute 4
Maximum Length:150
Additional address column used by localizations. -
AddlAddressAttribute5: string
Title:
Additional Address Attribute 5
Maximum Length:150
Additional address column used by localizations. -
addressesDFF: array
addressesDFF
-
AddressId: integer
(int64)
Title:
Address ID
Surrogate identifier for the address record. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
First line of the primary mail address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
Second line of the primary mail address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
Third line of the primary mail address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
Fourth line of the primary mail address. -
AddressType: string
Title:
Type
Maximum Length:30
Type of address. Valid values are defined in the commonLookupsLOV. -
AddressTypeMeaning: string
Title:
Address Type
Read Only:true
Maximum Length:80
Meaning of the contact's address type. -
Building: string
Title:
Building
Maximum Length:240
Building information associated with the address. -
Country: string
Title:
Country
Maximum Length:60
Country in which the address is located. Valid values are defined in the hcmCountriesLov. -
CountryName: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the country in which the contact's address is located. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the address. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the address was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
End date of the date-effective changes to the record. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Start date of the date-effective changes to the record. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
Floor number associated with the building. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the address was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the address. -
Latitude: number
Title:
Latitude
Distance between the equator and an address located to its north or south, expressed in degrees and minutes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Title:
Longitude
Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes. -
LongPostalCode: string
Title:
Long Postal Code
Maximum Length:30
Long postal code of the primary mail address. -
PersonAddrUsageId: integer
(int64)
Title:
Person Address Usage ID
Read Only:true
Surrogate identifier for the address usage record. -
PostalCode: string
Title:
Postal Code
Maximum Length:30
Postal code of the primary mail address. -
PrimaryFlag: boolean
Title:
Primary Mailing
Indicates whether the address is the primary mailing address. -
Provider: string
Title:
Provider
Maximum Length:150
Company that has validated the address. -
Region1: string
Title:
Region 1
Maximum Length:120
Primary region in which the address is located. -
Region2: string
Title:
Region 2
Maximum Length:120
Secondary region within the primary region. -
Region3: string
Title:
Region 3
Maximum Length:120
Additional secondary region within the primary region. -
TownOrCity: string
Title:
Town or City
Maximum Length:60
Town or city in which the address is located. -
ValidationStatusCode: string
Title:
Validation Status Code
Maximum Length:120
Level of accuracy of an address, as determined by an address provider.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hcmContacts-addresses-addressesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
-
EffectiveStartDate: string
(date)
Title:
Effective Start Date
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonAddrUsageId: integer
(int64)
Title:
Person Address Usage ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- addressTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupType%3DADDRESS_TYPE%2CLookupCode%3D{AddressType}
The following properties are defined on the LOV link relation:- Source Attribute: AddressType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- addressesDFF
-
Parameters:
- addressesUniqID:
$request.path.addressesUniqID
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- addressesUniqID:
- countriesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: Country; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName