Create a drivers license
post
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses
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.
Header Parameters
-
Metadata-Context: string
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: string
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: string
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-
driverLicensesDDF: array
driverLicensesDDF
-
driverLicensesDFF: array
driverLicensesDFF
-
FromDate: string
(date)
Title:
From DateStart date of the contact's driver's license. -
IssuingAuthority: string
Title:
Issuing AuthorityMaximum Length:100Issuing authority of the contact's driver's license. -
IssuingCountry(required): string
Title:
Issuing CountryMaximum Length:30Country in which the contact's driver's license was issued. Valid values are defined in the hcmCountriesLov. -
IssuingLocation: string
Title:
Place of IssueMaximum Length:100Location where the driver's license was issued. -
LicenseNumber: string
Title:
License NumberMaximum Length:150Driver's license number of the contact. -
LicenseSuspendedFlag: boolean
Title:
License SuspendedMaximum Length:30Default Value:falseIndicates whether the contact's driver's license is suspended. -
LicenseType: string
Title:
License TypeMaximum Length:30Type of driver's license. Valid values are defined in the commonLookupsLOV. -
NumberOfPoints: integer
(int64)
Title:
Number of PointsNumber of penalty points on the license. -
SuspendedFromDate: string
(date)
Title:
Suspended-from DateStart date of suspension period, if any. -
SuspendedToDate: string
(date)
Title:
Suspension-to DateEnd date of suspension period, if any. -
ToDate: string
(date)
Title:
To DateEnd date of the contact's driver's license. -
Violations: integer
(int64)
Title:
ViolationsNumber of violations on the license.
Nested Schema : driverLicensesDDF
Type:
Show Source
array-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "BR":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFBRVO-item-post-request", "DE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFDEVO-item-post-request" } }
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFBRVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Drivers License CategoryMaximum Length:30Default Value:BRDrivers License Category -
__FLEX_Context_DisplayValue: string
Title:
Drivers License CategoryDrivers License Category -
_ORA_HRX_BR_FIRST_ISSUE_DATE: string
(date)
Title:
First Issue DateFirst Issue Date -
DriversLicenseId: integer
(int64)
Title:
Drivers License ID
Nested Schema : oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFDEVO-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Drivers License CategoryMaximum Length:30Default Value:DEDrivers License Category -
__FLEX_Context_DisplayValue: string
Title:
Drivers License CategoryDrivers License Category -
_HRX_DE_A: string
Title:
AMaximum Length:150A -
_HRX_DE_A1: string
Title:
A1Maximum Length:150A1 -
_HRX_DE_A2: string
Title:
A2Maximum Length:150A2 -
_HRX_DE_AM: string
Title:
AMMaximum Length:150AM -
_HRX_DE_B: string
Title:
BMaximum Length:150B -
_HRX_DE_BE: string
Title:
BEMaximum Length:150BE -
_HRX_DE_C: string
Title:
CMaximum Length:150C -
_HRX_DE_C1: string
Title:
C1Maximum Length:150C1 -
_HRX_DE_C1E: string
Title:
C1EMaximum Length:150C1E -
_HRX_DE_CE: string
Title:
CEMaximum Length:150CE -
_HRX_DE_D: string
Title:
DMaximum Length:150D -
_HRX_DE_D1: string
Title:
D1Maximum Length:150D1 -
_HRX_DE_D1E: string
Title:
D1EMaximum Length:150D1E -
_HRX_DE_DE: string
Title:
DEMaximum Length:150DE -
_HRX_DE_L: string
Title:
LMaximum Length:150L -
_HRX_DE_LIC_LAST_VALID_DT: string
(date)
Title:
Last ValidatedLast Validated -
_HRX_DE_M: string
Title:
MMaximum Length:150M -
_HRX_DE_TS: string
Title:
T/SMaximum Length:150T/S -
DriversLicenseId: integer
(int64)
Title:
Drivers License ID
Nested Schema : hcmContacts-driverLicenses-driverLicensesDFF-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DriversLicenseTypeId: integer
(int64)
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-driverLicenses-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the contact's driver's license record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the contact's driver's license record was created. -
driverLicensesDDF: array
driverLicensesDDF
-
driverLicensesDFF: array
driverLicensesDFF
-
DriversLicenseId: integer
(int64)
Title:
Drivers License IDRead Only:trueSurrogate identifier for the driver's license of a contact. -
FromDate: string
(date)
Title:
From DateStart date of the contact's driver's license. -
IssuingAuthority: string
Title:
Issuing AuthorityMaximum Length:100Issuing authority of the contact's driver's license. -
IssuingCountry: string
Title:
Issuing CountryMaximum Length:30Country in which the contact's driver's license was issued. Valid values are defined in the hcmCountriesLov. -
IssuingCountryName: string
Title:
Issuing CountryRead Only:trueMaximum Length:80Name of the country issuing the contact's license. -
IssuingLocation: string
Title:
Place of IssueMaximum Length:100Location where the driver's license was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time when the contact's driver's license record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the contact's driver's license record. -
LicenseNumber: string
Title:
License NumberMaximum Length:150Driver's license number of the contact. -
LicenseSuspendedFlag: boolean
Title:
License SuspendedMaximum Length:30Default Value:falseIndicates whether the contact's driver's license is suspended. -
LicenseType: string
Title:
License TypeMaximum Length:30Type of driver's license. Valid values are defined in the commonLookupsLOV. -
LicenseTypeMeaning: string
Title:
License TypeRead Only:trueMaximum Length:80Meaning of the contact's license type. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberOfPoints: integer
(int64)
Title:
Number of PointsNumber of penalty points on the license. -
SuspendedFromDate: string
(date)
Title:
Suspended-from DateStart date of suspension period, if any. -
SuspendedToDate: string
(date)
Title:
Suspension-to DateEnd date of suspension period, if any. -
ToDate: string
(date)
Title:
To DateEnd date of the contact's driver's license. -
Violations: integer
(int64)
Title:
ViolationsNumber of violations on the license.
Nested Schema : driverLicensesDDF
Type:
Show Source
array-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "BR":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFBRVO-item-response", "DE":"#/components/schemas/oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFDEVO-item-response" } }
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
objectDiscriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFBRVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Drivers License CategoryMaximum Length:30Default Value:BRDrivers License Category -
__FLEX_Context_DisplayValue: string
Title:
Drivers License CategoryDrivers License Category -
_ORA_HRX_BR_FIRST_ISSUE_DATE: string
(date)
Title:
First Issue DateFirst Issue Date -
DriversLicenseId: integer
(int64)
Title:
Drivers License ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : oracle_apps_hcm_people_core_flex_personDriversLicenseLegDDF_view_PersonDriversLicenseLegDDFDEVO-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Drivers License CategoryMaximum Length:30Default Value:DEDrivers License Category -
__FLEX_Context_DisplayValue: string
Title:
Drivers License CategoryDrivers License Category -
_HRX_DE_A: string
Title:
AMaximum Length:150A -
_HRX_DE_A1: string
Title:
A1Maximum Length:150A1 -
_HRX_DE_A2: string
Title:
A2Maximum Length:150A2 -
_HRX_DE_AM: string
Title:
AMMaximum Length:150AM -
_HRX_DE_B: string
Title:
BMaximum Length:150B -
_HRX_DE_BE: string
Title:
BEMaximum Length:150BE -
_HRX_DE_C: string
Title:
CMaximum Length:150C -
_HRX_DE_C1: string
Title:
C1Maximum Length:150C1 -
_HRX_DE_C1E: string
Title:
C1EMaximum Length:150C1E -
_HRX_DE_CE: string
Title:
CEMaximum Length:150CE -
_HRX_DE_D: string
Title:
DMaximum Length:150D -
_HRX_DE_D1: string
Title:
D1Maximum Length:150D1 -
_HRX_DE_D1E: string
Title:
D1EMaximum Length:150D1E -
_HRX_DE_DE: string
Title:
DEMaximum Length:150DE -
_HRX_DE_L: string
Title:
LMaximum Length:150L -
_HRX_DE_LIC_LAST_VALID_DT: string
(date)
Title:
Last ValidatedLast Validated -
_HRX_DE_M: string
Title:
MMaximum Length:150M -
_HRX_DE_TS: string
Title:
T/SMaximum Length:150T/S -
DriversLicenseId: integer
(int64)
Title:
Drivers License ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : hcmContacts-driverLicenses-driverLicensesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context Value -
__FLEX_Context_DisplayValue: string
Title:
Context ValueContext Value -
DriversLicenseTypeId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- driverLicensesDDF
-
Parameters:
- driverLicensesUniqID:
$request.path.driverLicensesUniqID - hcmContactsUniqID:
$request.path.hcmContactsUniqID
- driverLicensesUniqID:
- driverLicensesDFF
-
Parameters:
- driverLicensesUniqID:
$request.path.driverLicensesUniqID - hcmContactsUniqID:
$request.path.hcmContactsUniqID
- driverLicensesUniqID:
- issuingCountriesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: IssuingCountry; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName
- licenseTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupType%3DPER_DRIVERS_LICENSE_TYPE%2CLookupCode%3D{LicenseType}%2CLegislationCode%3D{IssuingCountry}
The following properties are defined on the LOV link relation:- Source Attribute: LicenseType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: