Get all addresses
get
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses
Request
Path Parameters
-
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.
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> -
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all the contact addresses that match the specified primary key criteria.
Finder Variables- AddressId; integer; Surrogate identifier for the contact's address.
- EffectiveEndDate; string; End date of the date-effective changes to the record.
- EffectiveStartDate; string; Start date of the date-effective changes to the record.
- PersonAddrUsageId; integer; Surrogate identifier for the contact's address usage record.
- findByPersonAddrUsageId Finds all the contact addresses that match the address usage identifier specified.
Finder Variables- PersonAddrUsageId; integer; Surrogate identifier for the address usage record.
- SysEffectiveDate; object;
- PrimaryKey Finds all the contact addresses that match the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AddressId; integer; Surrogate identifier for the address record.
- AddressType; string; Type of address. Valid values are defined in the commonLookupsLOV.
- AddressTypeMeaning; string; Meaning of the contact's address type.
- Building; string; Building information associated with the address.
- Country; string; Country in which the address is located. Valid values are defined in the hcmCountriesLov.
- CountryName; string; Name of the country in which the contact's address is located.
- EffectiveEndDate; string; End date of the date-effective changes to the record.
- EffectiveStartDate; string; Start date of the date-effective changes to the record.
- FloorNumber; string; Floor number associated with the building.
- Latitude; number; Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
- LongPostalCode; string; Long postal code of the primary mail address.
- Longitude; number; Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
- PersonAddrUsageId; integer; Surrogate identifier for the address usage record.
- PostalCode; string; Postal code of the primary mail address.
- PrimaryFlag; boolean; Indicates whether the address is the primary mailing address.
- Provider; string; Company that has validated the address.
- Region1; string; Primary region in which the address is located.
- Region2; string; Secondary region within the primary region.
- Region3; string; Additional secondary region within the primary region.
- TownOrCity; string; Town or city in which the address is located.
- ValidationStatusCode; string; Level of accuracy of an address, as determined by an address provider.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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:
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.