Get Assignments
get
/drivers/{driverGid}/assignments
Request
Path Parameters
-
driverGid(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : drivers.assignments
Type:
Show Source
object
-
description: string
Remarks or comments related to shipment(s) assigned to the driver.
-
domainName: string
Database domain where this data is stored.
-
driverAssignmentSeqNo: number
(int64)
Driver assignment sequence number.
-
isSystemGenerated: boolean
Check box indicating whether the shipment assigned was system generated.
-
links: array
links
Read Only:
true
-
nextAvailableLocGid: string
The GID for the next available location (NAL) for the driver.
-
nextAvailableTime:
nextAvailableTime
The GID for the next available time (NAT) for the driver.
-
prevDriverAssignmentSeqNum: number
(int64)
Refers to the previous driver assignment record for the driver.
-
shipmentGid: string
The GID of the shipments assigned to the driver.
Nested Schema : nextAvailableTime
The GID for the next available time (NAT) for the driver.
Match All
Show Source
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format