Get a location address
get
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses/{addressesUniqID}
Request
Path Parameters
-
addressesUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.