Create a worker national identifier
post
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers
Request
Path Parameters
-
workersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.
Header Parameters
-
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
-
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the national identifier. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the national identifier. -
LegislationCode(required): string
Title:
Country
Maximum Length:30
Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov. -
NationalIdentifierNumber(required): string
Title:
National ID
Maximum Length:30
National identification number. -
nationalIdentifiersDFF: array
nationalIdentifiersDFF
-
NationalIdentifierType(required): string
Title:
National ID Type
Maximum Length:30
Type of national identifier. Valid values are defined in the commonLookupsLOV. -
PlaceOfIssue: string
Title:
Place of Issue
Maximum Length:30
Place where the national identifier was issued. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:255
Indicates whether the national identifier is the person's primary national identifier.
Nested Schema : workers-nationalIdentifiers-nationalIdentifiersDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
NationalIdentifierId: integer
(int64)
Title:
National Identifier ID
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 : workers-nationalIdentifiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the national identifier record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the national identifier record was created. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the national identifier. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the national identifier. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the national identifier record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the national identifier record. -
LegislationCode: string
Title:
Country
Maximum Length:30
Legislation code of the national identifier. Valid values are defined in the hcmCountriesLov. -
LegislationName: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the person's legislation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NationalIdentifierId: integer
(int64)
Title:
National Identifier ID
Read Only:true
Surrogate identifier for the national identifier record. -
NationalIdentifierNumber: string
Title:
National ID
Maximum Length:30
National identification number. -
nationalIdentifiersDFF: array
nationalIdentifiersDFF
-
NationalIdentifierType: string
Title:
National ID Type
Maximum Length:30
Type of national identifier. Valid values are defined in the commonLookupsLOV. -
NationalIdentifierTypeMeaning: string
Title:
National ID Type
Read Only:true
Maximum Length:80
Meaning of the person's national identifier type. -
PlaceOfIssue: string
Title:
Place of Issue
Maximum Length:30
Place where the national identifier was issued. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:255
Indicates whether the national identifier is the person's primary national identifier.
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.
Nested Schema : workers-nationalIdentifiers-nationalIdentifiersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NationalIdentifierId: integer
(int64)
Title:
National Identifier ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- legislationCodesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: LegislationCode; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName
- nationalIdentifierTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{NationalIdentifierType}%2CLookupType%3DPER_NATIONAL_IDENTIFIER_TYPE%2CLegislationCode%3D{LegislationCode}
The following properties are defined on the LOV link relation:- Source Attribute: NationalIdentifierType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- nationalIdentifiersDFF
-
Parameters:
- NationalIdentifierId:
$request.path.NationalIdentifierId
- workersUniqID:
$request.path.workersUniqID
- NationalIdentifierId:
Examples
The following example shows how to create a worker national identifier 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" -H "REST-Framework-Version: 4" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/nationalIdentifiers"
Example of Payload
The following is an example of the payload.
{ "LegislationCode":"US", "NationalIdentifierType":"ORA_TIN", "NationalIdentifierNumber":"123456789" }
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.
{ "NationalIdentifierId": 300100188720867, "LegislationCode": "US", "NationalIdentifierType": "ORA_TIN", "NationalIdentifierNumber": "123456789", "IssueDate": null, "ExpirationDate": null, "PlaceOfIssue": null, "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T16:52:21+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T16:52:21.333+00:00", "PrimaryFlag": true, "links": [ {... } ] }