Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/drivers.assignments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object drivers.assignments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/drivers.assignments"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : drivers.assignments

Type: object

Show Source

• 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.

{
    "properties":{
        "driverAssignmentSeqNo":{
            "description":"Driver assignment sequence number.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"The GID of the shipments assigned to the driver.",
            "type":"string"
        },
        "nextAvailableLocGid":{
            "description":"The GID for the next available location (NAL) for the driver.",
            "type":"string"
        },
        "nextAvailableTime":{
            "description":"The GID for the next available time (NAT) for the driver.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "prevDriverAssignmentSeqNum":{
            "description":"Refers to the previous driver assignment record for the driver.",
            "type":"number",
            "format":"int64"
        },
        "description":{
            "description":"Remarks or comments related to shipment(s) assigned to the driver.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Check box indicating whether the shipment assigned was system generated.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : nextAvailableTime

The GID for the next available time (NAT) for the driver.

Match All

The GID for the next available time (NAT) for the driver.

Show Source

• object dateTimeType

{
    "description":"The GID for the next available time (NAT) for the driver.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Back to Top