Create a location address
post
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses
Request
Path Parameters
-
locationsV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Locations V2 resource and used to uniquely identify an instance of Locations V2. The client should not generate the hash key value. Instead, the client should query on the Locations V2 collection resource in order to navigate to a specific instance of Locations V2 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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AddlAddressAttribute1: string
Title:
Additional Address Attribute 1
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute2: string
Title:
Additional Address Attribute 2
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute3: string
Title:
Additional Address Attribute 3
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute4: string
Title:
Additional Address Attribute 4
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute5: string
Title:
Additional Address Attribute 5
Maximum Length:150
Additional address attribute, used by localizations. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
First line of the location address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
Second line of the location address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
Third line of the location address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
Fourth line of the location address. -
AddressUsageType: string
Title:
Address Usage Type Code
Maximum Length:30
Type of the address usage. -
Building: string
Title:
Building
Maximum Length:240
Building name of the address. -
Country: string
Title:
Country
Maximum Length:60
Country for the location address. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date for the location address. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date for the location address. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
Floor number of the address. -
Latitude: number
Title:
Latitude
Distance between the equator and a location address located to its north or south, expressed in degrees and minutes. -
LocAddressUsageId: integer
(int64)
Title:
Location Address Usage ID
Unique identifier for the address usage type. -
Longitude: number
Title:
Longitude
Distance between the prime meridian and a location address located to its east or west, expressed in degrees and minutes. -
LongPostalCode: string
Title:
Long Postal Code
Maximum Length:30
Long postal code for the location address. Long postal codes are used in some countries in addition to the short postal codes. -
PostalCode: string
Title:
Postal Code
Maximum Length:30
Postal code for the location address. -
Provider: string
Title:
Provider
Maximum Length:150
Company that has validated a location address. -
Region1: string
Title:
Region 1
Maximum Length:120
Primary region in which the address is located. This value may be required depending on the country specified. -
Region2: string
Title:
Region 2
Maximum Length:120
Secondary region withing the primary region. -
Region3: string
Title:
Region 3
Maximum Length:120
Subregion within the secondary region. -
TimezoneCode: string
Title:
Time Zone Code
Maximum Length:50
Code of the time zone. -
TownOrCity: string
Title:
Town or City
Maximum Length:60
Town or city of the location address. This value may be required depending on the country specified. -
ValidationStatusCode: string
Title:
Validation Status Code
Maximum Length:120
Level of accuracy of a location address as determined by an address provider.
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 : locationsV2-addresses-item-response
Type:
Show Source
object
-
AddlAddressAttribute1: string
Title:
Additional Address Attribute 1
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute2: string
Title:
Additional Address Attribute 2
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute3: string
Title:
Additional Address Attribute 3
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute4: string
Title:
Additional Address Attribute 4
Maximum Length:150
Additional address attribute, used by localizations. -
AddlAddressAttribute5: string
Title:
Additional Address Attribute 5
Maximum Length:150
Additional address attribute, used by localizations. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
First line of the location address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
Second line of the location address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
Third line of the location address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
Fourth line of the location address. -
AddressUsageType: string
Title:
Address Usage Type Code
Maximum Length:30
Type of the address usage. -
AddressUsageTypeMeaning: string
Title:
Location Address Type
Read Only:true
Maximum Length:80
Meaning of the address usage. -
Building: string
Title:
Building
Maximum Length:240
Building name of the address. -
Country: string
Title:
Country
Maximum Length:60
Country for the location address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the address record was created. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Effective end date for the location address. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Effective start date for the location address. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
Floor number of the address. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the address record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the address record. -
Latitude: number
Title:
Latitude
Distance between the equator and a location 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. -
LocAddressUsageId: integer
(int64)
Title:
Location Address Usage ID
Unique identifier for the address usage type. -
Longitude: number
Title:
Longitude
Distance between the prime meridian and a location address located to its east or west, expressed in degrees and minutes. -
LongPostalCode: string
Title:
Long Postal Code
Maximum Length:30
Long postal code for the location address. Long postal codes are used in some countries in addition to the short postal codes. -
PostalCode: string
Title:
Postal Code
Maximum Length:30
Postal code for the location address. -
Provider: string
Title:
Provider
Maximum Length:150
Company that has validated a location address. -
Region1: string
Title:
Region 1
Maximum Length:120
Primary region in which the address is located. This value may be required depending on the country specified. -
Region2: string
Title:
Region 2
Maximum Length:120
Secondary region withing the primary region. -
Region3: string
Title:
Region 3
Maximum Length:120
Subregion within the secondary region. -
Timezone: string
Title:
Time Zone
Read Only:true
Time zone of the location address. -
TimezoneCode: string
Title:
Time Zone Code
Maximum Length:50
Code of the time zone. -
TownOrCity: string
Title:
Town or City
Maximum Length:60
Town or city of the location address. This value may be required depending on the country specified. -
ValidationStatusCode: string
Title:
Validation Status Code
Maximum Length:120
Level of accuracy of a location 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 : 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
- addressUsageTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DLOCATION_ADDRESS_USAGE_TYPE
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- countriesLov
-
The hcmCountriesLov resource includes the list of values for countries.
- timezonesLOV
-
The list of values for time zones.
Examples
The following example shows how to create a location address by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/locationsV2/00020000000EACED00057708000110F0851C63840000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001725894180078/child/addresses"
Example of Payload
The following is an example of the payload.
{ "AddressUsageType": "MAILING", "AddressLine1": "AddressLine1", "AddressLine2": "AddressLine2", "AddressLine3": "AddressLine3", "AddressLine4": "AddressLine4", "TownOrCity": "REDWOOD SHORES", "Region1": "SAN MATEO", "Region2": "CA", "Region3": null, "Country": "US", "PostalCode": "94065" }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 201 Created Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "EffectiveStartDate": "2020-05-28", "EffectiveEndDate": "4712-12-31", "AddressLine1": "AddressLine1", "AddressLine2": "AddressLine2", "AddressLine3": "AddressLine3", "AddressLine4": "AddressLine4", "TownOrCity": "REDWOOD SHORES", "Region1": "SAN MATEO", "Region2": "CA", "Region3": null, "Country": "US", "PostalCode": "94065", "LongPostalCode": null, "AddlAddressAttribute1": null, "AddlAddressAttribute2": null, "AddlAddressAttribute3": null, "AddlAddressAttribute4": null, "AddlAddressAttribute5": null, "Building": null, "FloorNumber": null, "CreatedBy": "HCM_INTEGRATION_SPEC", "CreationDate": "2020-05-28T17:59:09+00:00", "LastUpdatedBy": "HCM_INTEGRATION_SPEC", "LastUpdateDate": "2020-05-28T17:59:09.288+00:00", "LocAddressUsageId": 300100188145452, "AddressUsageType": "MAILING", "AddressUsageTypeMeaning": "Mailing address usage type", "links": [ {.... } ] }