Get all drivers licenses
get
/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.
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 -
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 drivers licenses that match the specified primary key criteria.
Finder Variables- DriversLicenseId; integer; Surrogate identifier for the contact's driver license.
- PrimaryKey Finds all the contact drivers licenses 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:- DriversLicenseId; integer; Surrogate identifier for the driver's license of a contact.
- IssuingCountry; string; Country in which the contact's driver's license was issued. Valid values are defined in the hcmCountriesLov.
- IssuingCountryName; string; Name of the country issuing the contact's license.
- LicenseNumber; string; Driver's license number of the contact.
- LicenseSuspendedFlag; boolean; Indicates whether the contact's driver's license is suspended.
- LicenseType; string; Type of driver's license. Valid values are defined in the commonLookupsLOV.
- LicenseTypeMeaning; string; Meaning of the contact's license type.
- SuspendedFromDate; string; Start date of suspension period, if any.
- SuspendedToDate; string; End date of suspension period, if any.
- ToDate; string; End date of the contact's driver's license.
-
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
-
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-driverLicenses
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-driverLicenses-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the contact's driver's license record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the contact's 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 contact. -
FromDate: string
(date)
Title:
From Date
Start date of the contact's driver's license. -
IssuingAuthority: string
Title:
Issuing Authority
Maximum Length:100
Issuing authority of the contact's driver's license. -
IssuingCountry: string
Title:
Issuing Country
Maximum Length:30
Country in which the contact's 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 contact'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 contact's driver's license record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the contact's driver's license record. -
LicenseNumber: string
Title:
License Number
Maximum Length:150
Driver's license number of the contact. -
LicenseSuspendedFlag: boolean
Title:
License Suspended
Maximum Length:30
Default Value:false
Indicates whether the contact's driver's license is suspended. -
LicenseType: string
Title:
License Type
Maximum Length:30
Type of driver's license. Valid values are defined in the commonLookupsLOV. -
LicenseTypeMeaning: string
Title:
License Type
Read Only:true
Maximum Length:80
Meaning of the contact'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
End date of the contact's driver's license. -
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 : hcmContacts-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