Get a worker drivers license
get
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}
Request
Path Parameters
-
driverLicensesUniqID(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=
-
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.
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
-
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 : workers-driverLicenses-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the driver's license record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the driver's license record was created. -
driverLicensesDDF: array
driverLicensesDDF
-
driverLicensesDFF: array
driverLicensesDFF
-
DriversLicenseId: integer
(int64)
Title:
Drivers License ID
Read Only:true
Surrogate identifier for the driver's license of a worker. -
FromDate: string
(date)
Title:
From Date
Date from when the driver's license is valid. -
IssuingAuthority: string
Title:
Issuing Authority
Maximum Length:100
Issuing authority of the driver's license. -
IssuingCountry: string
Title:
Issuing Country
Maximum Length:30
Country in which the driver's license was issued. Valid values are defined in the hcmCountriesLov. -
IssuingCountryName: string
Title:
Issuing Country
Read Only:true
Maximum Length:80
Name of the country issuing the person's license. -
IssuingLocation: string
Title:
Place of Issue
Maximum Length:100
Location where the driver's license was issued. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the driver's license record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the driver's license record. -
LicenseNumber: string
Title:
License Number
Maximum Length:150
Driver's license number. -
LicenseSuspendedFlag: boolean
Title:
License Suspended
Maximum Length:30
Default Value:false
Indicates whether the driver's license is suspended. -
LicenseType: string
Title:
License Type
Maximum Length:30
Type of license. Valid values are defined in the commonLookupsLOV. -
LicenseTypeMeaning: string
Title:
License Type
Read Only:true
Maximum Length:80
Meaning of the person's license type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPoints: integer
(int64)
Title:
Number of Points
Number of penalty points on the license. -
SuspendedFromDate: string
(date)
Title:
Suspended-from Date
Start date of suspension period, if any. -
SuspendedToDate: string
(date)
Title:
Suspension-to Date
End date of suspension period, if any. -
ToDate: string
(date)
Title:
To Date
Date until when the driver's license is valid. -
Violations: integer
(int64)
Title:
Violations
Number 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __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 Category
Maximum Length:30
Default Value:BR
-
__FLEX_Context_DisplayValue: string
Title:
Drivers License Category
-
_ORA_HRX_BR_FIRST_ISSUE_DATE: string
(date)
Title:
First Issue Date
-
DriversLicenseId: integer
(int64)
Title:
Drivers License ID
-
links: array
Links
Title:
Links
The 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 Category
Maximum Length:30
Default Value:DE
-
__FLEX_Context_DisplayValue: string
Title:
Drivers License Category
-
_HRX_DE_A: string
Title:
A
Maximum Length:150
-
_HRX_DE_A1: string
Title:
A1
Maximum Length:150
-
_HRX_DE_A2: string
Title:
A2
Maximum Length:150
-
_HRX_DE_AM: string
Title:
AM
Maximum Length:150
-
_HRX_DE_B: string
Title:
B
Maximum Length:150
-
_HRX_DE_BE: string
Title:
BE
Maximum Length:150
-
_HRX_DE_C: string
Title:
C
Maximum Length:150
-
_HRX_DE_C1: string
Title:
C1
Maximum Length:150
-
_HRX_DE_C1E: string
Title:
C1E
Maximum Length:150
-
_HRX_DE_CE: string
Title:
CE
Maximum Length:150
-
_HRX_DE_D: string
Title:
D
Maximum Length:150
-
_HRX_DE_D1: string
Title:
D1
Maximum Length:150
-
_HRX_DE_D1E: string
Title:
D1E
Maximum Length:150
-
_HRX_DE_DE: string
Title:
DE
Maximum Length:150
-
_HRX_DE_L: string
Title:
L
Maximum Length:150
-
_HRX_DE_LIC_LAST_VALID_DT: string
(date)
Title:
Last Validated
-
_HRX_DE_M: string
Title:
M
Maximum Length:150
-
_HRX_DE_TS: string
Title:
T/S
Maximum Length:150
-
DriversLicenseId: integer
(int64)
Title:
Drivers License ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-driverLicenses-driverLicensesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
DriversLicenseTypeId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- driverLicensesDDF
-
Parameters:
- driverLicensesUniqID:
$request.path.driverLicensesUniqID
- workersUniqID:
$request.path.workersUniqID
- driverLicensesUniqID:
- driverLicensesDFF
-
Parameters:
- driverLicensesUniqID:
$request.path.driverLicensesUniqID
- workersUniqID:
$request.path.workersUniqID
- driverLicensesUniqID:
- issuingCountriesLov
-
The hcmCountriesLov resource includes the list of values for countries.
- licenseTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupType%3DPER_DRIVERS_LICENSE_TYPE%2CLookupCode%3D{LicenseType}%2CLegislationCode%3D{IssuingCountry}
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:
Examples
The following example shows how to retrieve a worker's drivers license by submitting a GET 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 GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/driverLicenses/00020000000EACED00057708000110F085254CE30000000EACED00057708000110F085254CE4"
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK 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.
{ "DriversLicenseId": 300100188720355, "LicenseType": null, "IssuingCountry": "DE", "LicenseNumber": null, "IssuingAuthority": null, "IssuingLocation": null, "FromDate": null, "ToDate": null, "NumberOfPoints": null, "Violations": null, "LicenseSuspendedFlag": false, "SuspendedFromDate": null, "SuspendedToDate": null, "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T11:53:58.001+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T11:53:58.533+00:00", "links": [ {... } ] }