API Docs
YMS API
Data Models
Driver
Driver Snapshot

DriverSnapshot

{
  "driverId": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "driverPhone": "string",
  "phone": "string",
  "licenseNumber": "string",
  "licenseExpirationDate": "string",
  "licenseState": "string",
  "email": "string",
  "licensePlate": "ABC123",
  "carrierName": "string",
  "carrierId": "string",
  "usdot": "string",
  "equipmentNo": "string",
  "equipmentType": "VEHICLE",
  "cargoStatus": "UNKNOWN"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
driverIdstringfalsenoneDriver ID
firstNamestringfalsenoneDriver's first name
middleNamestringfalsenoneDriver's middle name
lastNamestringfalsenoneDriver's last name
driverPhonestringfalsenoneDriver's phone number
phonestringfalsenoneDriver's phone number
licenseNumberstringfalsenoneDriver's license number
licenseExpirationDatestringfalsenoneDriver's license expiration date
licenseStatestringfalsenoneDriver's license state
emailstringfalsenoneDriver's email
licensePlatestringfalsenoneVehicle license plate number
carrierNamestringfalsenoneCarrier name
carrierIdstringfalsenoneCarrier ID
usdotstringfalsenoneUSDOT number
equipmentNostringfalsenoneEquipment number
equipmentTypestringfalsenoneEquipment type
cargoStatusstringfalsenonecargoStatus

Enum Values

PropertyValue
equipmentTypeVEHICLE
equipmentTypeTRAILER
equipmentTypeCHASSIS
equipmentTypeCONTAINER
equipmentTypeFLATBED
equipmentTypeOTHER
equipmentTypeNO_EQUIPMENT
cargoStatusUNKNOWN
cargoStatusFULL
cargoStatusEMPTY
cargoStatusFULL_AFTER_LOADED
cargoStatusEMPTY_AFTER_OFFLOAD