Drivers

Retrieve a single driver

Retrieves information for a driver by its id

get/v2/drivers/{id}

Request

  • Base URL: https://api.onswitchboard.com
  • URL: https://api.onswitchboard.com/v2/drivers/{id}
  • Auth: API key in header x-api-id and API key in header x-api-key

Path parameters

idstring required

The ID of the driver

Response

Successfully retrieved driver

firstNamestring required

Driver's first name

lastNamestring required

Driver's last name

phoneNumberstring required

Driver's phone number

driversLicensestring required

Driver's License ID

driversLicenseCountrystring required

Driver's license country

driversLicenseJurisdictionstring required

Driver's license jurisdiction

canCycleTypeinteger required

Driver's Canadian HOS cycle type. Related to ELD HOS rules the driver will follow in Canada. Valid values: 1: 70 hour / 7 Day 2: 120 hour / 14 Day 3: Oil Well Service 4: 80 hour / 7 day 5: 120 hour / 14 day 6: Alberta 7: Loggers

usaCycleTypeinteger required

Driver's US HOS cycle type. Related to ELD HOS rules the driver will follow in the USA. Valid values: 1: 70 hour / 8 Day 2: 60 hour / 7 Day 3: Oilfield 70 hour / 8 day 4: Motion Picture 60 hour / 7 day 5: Motion Picture 70 hour / 8 day 6: Construction 60 hour / 7 day 7: Construction 70 hour / 8 day 8: Ground Water Well 60 hour / 7 day 9: Ground Water Well 70 hour / 8 day 10: Intrastate 70 hour / 7 day 11: Alaska: 70 hour / 7 day 12: Alaska: 80 hour / 8 day 13: California: Intrastate 80 hour / 8 day 14: California: Motion Picture 80 hour / 8 day 15: USA: Passenger-carrying 60 hour / 7 Day 16: USA: Passenger-carrying 70 hour / 8 Day 17: Alaska: Passenger-carrying 70 hour / 7 day 18: Alaska: Passenger-carrying 80 hour / 8 day 19: USA: Oversized 60 hour / 7 day 20: USA: Oversized 70 hour / 8 day 21: California: Passenger-carrying 80 hour / 8 day 26: USA: Agricultural 60 hour / 7 Day 27: USA: Agricultural 70 hour / 8 Day

timezonestring required

Driver's timezone

usernamestring required

Driver's username

enabledboolean

Vehicle enabled status

exemptboolean required

Driver's exemption status

yardMovesboolean

Driver's yard moves status

personalUseCMVboolean

Driver's personal use CMV status

sendTextToDriverboolean

Send text to driver on registration or password change

medicalCheckDatestring date

Driver's medical expiry date

notesstring

Additional driver notes

passwordstring password

Driver's password

exemptionReasonstring

Driver's exemption reason

dotNumberstring

Driver's DOT number

idstring

Driver Object Id

Example response

{
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "8586770459",
  "driversLicense": "655-3892",
  "driversLicenseCountry": "CA",
  "driversLicenseJurisdiction": "BC",
  "timezone": "America/Vancouver",
  "username": "johndoe123",
  "enabled": true,
  "exempt": true,
  "sendTextToDriver": true,
  "medicalCheckDate": "2022-01-01",
  "notes": "Example Notes",
  "password": "password",
  "exemptionReason": "Exemption Reason",
  "dotNumber": "973457",
  "id": "yrKsyRstu1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.