Trimble Drivers API

Retrieves, creates, updates and deletes TruckMate driver profiles. Driver profiles can be viewed and maintained in the TruckMate Driver Profiles application.

GitHub OpenAPI

Operations 6

GET /drivers Retrieve drivers #
POST /drivers Create a new driver #
GET /drivers/{driverId} Retrieve a driver #
PUT /drivers/{driverId} Update a driver #
DELETE /drivers/{driverId} Delete a driver #
GET /drivers/{driverId}/availability Retrieve a driver's projected availability #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-drivers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trimble-drivers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: MasterData Drivers API
  description: 'The Master Data management API allows for an external system to create, retrieve, update or delete TruckMate configuration data, such as Client, Vendor and Driver profiles, as well as sites, zones, commodity codes etc.


    Download latest released OpenAPI


    This documentation is based on the most currently released version of TruckMate. Documentation for previous versions can be accessed by navigating to the openapi.json endpoint for any given API (the service must be set up and running). For example: http://DOMAIN/openapi.json


    ---


    © 2026, Trimble Inc. All rights reserved. Unauthorized copying prohibited. Software functions, including our APIs and their specification, are subject to change without notice. Information contained herein is Trimble Confidential Information, used under license.


    ---'
  version: '1'
  x-tm-release: 26.3.125.0
tags:
- name: Drivers
  description: Retrieves, creates, updates and deletes TruckMate driver profiles. Driver profiles can be viewed and maintained in the TruckMate Driver Profiles application.
paths:
  /drivers:
    get:
      summary: Retrieve drivers
      description: 'Retrieves driver records.


        Driver profiles can be viewed in the Driver Profiles application.'
      operationId: GetDrivers
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Drivers
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDrivers200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    post:
      summary: Create a new driver
      description: 'Creates one or more driver records.


        Driver profiles can be viewed in the Driver Profiles application.'
      operationId: PostDrivers
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Drivers
      requestBody:
        description: An array of JSON objects containing the properties of the driver to be created.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefDriversPostRequest'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostDrivers201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /drivers/{driverId}:
    parameters:
    - name: driverId
      in: path
      description: driver Id
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a driver
      description: 'Retrieves a driver record.


        Driver profiles can be viewed in the Driver Profiles application.'
      operationId: GetDriver
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Drivers
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/driver'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    put:
      summary: Update a driver
      description: 'Updates one or more properties of a specific driver record.


        Driver profiles can be viewed in the Driver Profiles application.'
      operationId: PutDriver
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Drivers
      requestBody:
        description: A JSON objects containing the properties of the Driver to be updated.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefDriverPutRequest'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/driver'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    delete:
      summary: Delete a driver
      description: 'Deletes a specific driver record.


        Driver profiles can be viewed in the Driver Profiles application.'
      operationId: DeleteDriver
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Drivers
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /drivers/{driverId}/availability:
    parameters:
    - name: driverId
      in: path
      description: driver Id
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a driver's projected availability
      description: 'Retrieves a driver''s projected availability record, allowing for efficient planning of available drivers for new load assignments.


        Driver profiles can be viewed in the Driver Profiles application.'
      operationId: DriversGetDriverAvailability
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Drivers
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/driverAvailability'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Specifies the number of items to skip before beginning to select the records to return.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: Specifies the maximum number of items to include in the response results.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 20
    orderBy:
      name: $orderBy
      in: query
      description: Field(s) to order returned resource by, with optional direction. E.g., "fieldName desc, fieldName2"
      required: false
      style: form
      explode: true
      schema:
        type: string
    select:
      name: $select
      in: query
      description: Select allows to request a specified set of properties, see [Selecting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31361040)
      required: false
      style: form
      explode: true
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter). Note, not all features of oData filter syntax are supported.
      required: false
      style: form
      explode: true
      schema:
        type: string
  schemas:
    DriverAvailabilityCountry:
      type: object
      properties:
        code:
          type: string
          maxLength: 4
        name:
          type: string
          maxLength: 40
    ARTErrors:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          enum:
          - 400
          - 401
          - 403
          - 404
          - 405
          - 409
          - 429
          - 500
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ARTError'
    DriverAvailabilityTrailers:
      type: object
      properties:
        equipmentId:
          type: string
          maxLength: 10
        equipmentDisplayId:
          type: string
          maxLength: 10
    RefDriverPostRequest:
      type: object
      properties:
        driverId:
          type: string
          maxLength: 10
          pattern: ^[^'"]*$
        currentZone:
          type: string
          maxLength: 10
        status:
          type: string
          maxLength: 10
        seniority:
          type: string
          maxLength: 10
        name:
          type: string
          maxLength: 30
        driverType:
          type: string
          enum:
          - brokerageAgent
          - company
          - ownerOperator
        payType:
          type: string
          enum:
          - driverCheque
          - payroll
          - vendorCheque
        vendorCode:
          type: string
          maxLength: 10
        payrollCode:
          type: string
          maxLength: 10
        defaultPunit:
          type: string
          maxLength: 10
        otherCategory:
          type: string
          maxLength: 10
        licenceNumber:
          type: string
          maxLength: 20
        expiryDate:
          type: string
          description: 'Date: yyyy-MM-dd'
          pattern: ^\d{4}-(?:(0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|02-(0[1-9]|1\d|2[0-9]))$
        cellPhone:
          type: string
          maxLength: 20
        email:
          oneOf:
          - type: string
            enum:
            - ''
          - type: string
            maxLength: 128
            format: email
        phone:
          type: string
          maxLength: 20
        driverCycle:
          type: string
          enum:
          - '7'
          - '8'
          - '14'
          - BFM
          - STD
          - WA
        driverCycleZone:
          type: string
          enum:
          - AU
          - CA
          - US
        homeZone:
          type: string
          maxLength: 10
        drugTest:
          type: string
          enum:
          - 'False'
          - 'True'
        roadTest:
          type: string
          enum:
          - 'False'
          - 'True'
        twic:
          type: string
          enum:
          - 'False'
          - 'True'
        tdgCert:
          type: string
          enum:
          - 'False'
          - 'True'
        highValue:
          type: string
          enum:
          - 'False'
          - 'True'
        tdgExpiryDate:
          type: string
          description: 'Date: yyyy-MM-dd'
          pattern: ^\d{4}-(?:(0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|02-(0[1-9]|1\d|2[0-9]))$
        abstractExpiryDate:
          type: string
          description: 'Date: yyyy-MM-dd'
          pattern: ^\d{4}-(?:(0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|02-(0[1-9]|1\d|2[0-9]))$
      required:
      - driverId
      - currentZone
    driverAvailability:
      type: object
      properties:
        id:
          type: string
          maxLength: 10
        projectedAvailableDatetime:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        updatedBy:
          type: string
        createdBy:
          type: string
        driverDisplayId:
          type: string
        updatedAtDateTime:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        createdAtDateTime:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        powerUnit:
          $ref: '#/components/schemas/DriverAvailabilityPowerUnit'
        projectedAvailableLocation:
          $ref: '#/components/schemas/DriverAvailabilityProjectedLocation'
        trailers:
          type: array
          items:
            $ref: '#/components/schemas/DriverAvailabilityTrailers'
    driver:
      type: object
      properties:
        driverId:
          type: string
          maxLength: 10
        status:
          type: string
          maxLength: 10
        currentZone:
          type: string
          maxLength: 10
        finalDestination:
          type: string
          maxLength: 10
        deliverBy:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        remainingHoursCan7:
          type:
          - number
          - 'null'
        remainingHoursCan8:
          type:
          - number
          - 'null'
        remainingHoursCan14:
          type:
          - number
          - 'null'
        remainingHoursUs7:
          type:
          - number
          - 'null'
        remainingHoursUs8:
          type:
          - number
          - 'null'
        seniority:
          type: string
          maxLength: 10
        name:
          type: string
          maxLength: 30
        driverType:
          type: string
          enum:
          - brokerageAgent
          - company
          - ownerOperator
          - ''
        payType:
          type: string
          enum:
          - driverCheque
          - vendorCheque
          - payroll
          - ''
        vendorCode:
          type: string
          maxLength: 10
        payrollCode:
          type: string
          maxLength: 10
        defaultPunit:
          type: string
          maxLength: 10
        etaZone:
          type: string
          maxLength: 10
        etaDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        lastLocDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        currentZoneDesc:
          type: string
          maxLength: 30
        etaZoneDesc:
          type: string
          maxLength: 30
        currentTrip:
          type:
          - integer
          - 'null'
        lastTrip:
          type:
          - integer
          - 'null'
        otherCategory:
          type: string
          maxLength: 10
        licenceNumber:
          type: string
          maxLength: 20
        expiryDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        cellPhone:
          type: string
          maxLength: 20
        email:
          type: string
          maxLength: 128
          oneOf:
          - enum:
            - ''
          - format: email
        phone:
          type: string
          maxLength: 20
        lastSatZone:
          type: string
          maxLength: 10
        lastSatDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        lastSatLoc:
          type: string
          maxLength: 80
        nextTrip:
          type:
          - integer
          - 'null'
        finalDestinationDesc:
          type: string
          maxLength: 30
        currentLocClient:
          type: string
          maxLength: 10
        teamDriverId:
          type: string
          maxLength: 10
        remainingHours:
          type:
          - number
          - 'null'
        currentDuty:
          type: string
          enum:
          - driving
          - offDuty
          - onDuty
          - sleeper
          - unknown
          - ''
        driverCycle:
          type: string
          enum:
          - '7'
          - '8'
          - '14'
          - BFM
          - STD
          - WA
          - ''
        driverCycleZone:
          type: string
          enum:
          - AU
          - CA
          - US
          - ''
        hosViolationAt:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        hosCumulativeHours:
          type:
          - number
          - 'null'
        poslat:
          type: string
          maxLength: 10
        poslong:
          type: string
          maxLength: 10
        homeZone:
          type: string
          maxLength: 10
        homeZoneDesc:
          type: string
          maxLength: 30
        drugTest:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        roadTest:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        twic:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        tdgCert:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        highValue:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        tdgExpiryDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        abstractExpiryDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        contractId:
          type:
          - integer
          - 'null'
        firstName:
          type: string
          maxLength: 35
        middleName:
          type: string
          maxLength: 25
        lastName:
          type: string
          maxLength: 40
        gender:
          type: string
          enum:
          - female
          - male
          - ''
        birthDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        isActiveInPay:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        address1:
          type: string
          maxLength: 255
        address2:
          type: string
          maxLength: 255
        city:
          type: string
          maxLength: 50
        province:
          type: string
          maxLength: 20
        postalCode:
          type: string
          maxLength: 10
        countryCode:
          type: string
          maxLength: 2
        emergencyContact:
          type: string
          maxLength: 30
        emergencyPhone:
          type: string
          maxLength: 20
        hireDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        seniorityDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        terminationDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        createdDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        modifiedDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        createdBy:
          type: string
          maxLength: 128
        modifiedBy:
          type: string
          maxLength: 128
        startDate:
          type:
          - string
          - 'null'
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\d)((T| )([01]\d|2[0-3]):([0-5]\d):([0-5]\d))?$
        isActiveInDispatch:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
    DriverAvailabilityAddress:
      type: object
      properties:
        streetAddress:
          type: string
          maxLength: 40
        extendedAddress:
          type: string
          maxLength: 40
        city:
          type: string
          maxLength: 30
        postalCode:
          type: string
          maxLength: 10
        state:
          $ref: '#/components/schemas/DriverAvailabilityState'
        country:
          $ref: '#/components/schemas/DriverAvailabilityCountry'
    PostDrivers201:
      type: object
      properties:
        drivers:
          type: array
          items:
            $ref: '#/components/schemas/driver'
    RefDriverPutRequest:
      type: object
      properties:
        status:
          type: string
          maxLength: 10
        seniority:
          type: string
          maxLength: 10
        name:
          type: string
          maxLength: 30
        driverType:
          type: string
          enum:
          - brokerageAgent
          - company
          - ownerOperator
        payType:
          type: string
          enum:
          - driverCheque
          - payroll
          - vendorCheque
        vendorCode:
          type: string
          maxLength: 10
        payrollCode:
          type: string
          maxLength: 10
        defaultPunit:
          type: string
          maxLength: 10
        otherCategory:
          type: string
          maxLength: 10
        licenceNumber:
          type: string
          maxLength: 20
        expiryDate:
          type: string
          description: 'Date: yyyy-MM-dd'
          pattern: ^\d{4}-(?:(0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|02-(0[1-9]|1\d|2[0-9]))$
        cellPhone:
          type: string
          maxLength: 20
        email:
          oneOf:
          - type: string
            enum:
            - ''
          - type: string
            maxLength: 128
            format: email
        phone:
          type: string
          maxLength: 20
        driverCycle:
          type: string
          enum:
          - '7'
          - '8'
          - '14'
          - BFM
          - STD
          - WA
        driverCycleZone:
          type: string
          enum:
          - AU
          - CA
          - US
        homeZone:
          type: string
          maxLength: 10
        drugTest:
          type: string
          enum:
          - 'False'
          - 'True'
        roadTest:
          type: string
          enum:
          - 'False'
          - 'True'
        twic:
          type: string
          enum:
          - 'False'
          - 'True'
        tdgCert:
          type: string
          enum:
          - 'False'
          - 'True'
        highValue:
          type: string
          enum:
          - 'False'
          - 'True'
        tdgExpiryDate:
          type: string
          description: 'Date: yyyy-MM-dd'
          pattern: ^\d{4}-(?:(0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|02-(0[1-9]|1\d|2[0-9]))$
        abstractExpiryDate:
          type: string
          description: 'Date: yyyy-MM-dd'
          pattern: ^\d{4}-(?:(0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|02-(0[1-9]|1\d|2[0-9]))$
    DriverAvailabilityProjectedLocation:
      type: object
      properties:
        trimblePlaceId:
          type:
          - string
          - 'null'
        customPlaceId:
          type:
          - string
          - 'null'
        name:
          type: string
        address:
          $ref: '#/components/schemas/DriverAvailabilityAddress'
        coordinates:
          $ref: '#/components/schemas/DriverAvailabilityCoords'
    DriverAvailabilityCoords:
      type: object
      properties:
        latitude:
          type: number
        longitude:
          type: number
    ARTError:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        code:
          type: string
          description: Error code (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
        description:
          type: string
          description: Human-readable description (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
    DriverAvailabilityPowerUnit:
      type: object
      properties:
        equipmentId:
          type: string
          maxLength: 10
        equipmentDisplayId:
          type: string
          maxLength: 10
    DriverAvailabilityState:
      type: object
      properties:
        code:
          type: string
          maxLength: 4
        name:
          type: string
          maxLength: 40
    GetDrivers200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        filter:
          type: string
        sort:
          type: string
        select:
          type: string
        count:
          type: integer
        drivers:
          type: array
          items:
            $ref: '#/components/schemas/driver'
    RefDriversPostRequest:
      type: object
      properties:
        drivers:
          type: array
          items:
            $ref: '#/components/schemas/RefDriverPostRequest'
  securitySchemes:
    tidJwtAuth:
      type: http
      description: A time-limited JSON Web Token generated via separate POST request using TID
      scheme: bearer
    webuserJwtAuth:
      type: http
      description: A fresh JSON Web Token expires in four hours. It can be renewed by making a GET request to /login endpoint, or generated by making a POST request to /login endpoint
      scheme: bearer
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
externalDocs:
  url: https://learn.transportation.trimble.com/