API Docs
YMS API
Data Models
Vehicle View

VehicleView

{
  "id": 0,
  "vehicleId": "string",
  "licensePlate": "ABC123",
  "platePhoto": "string",
  "vehicleType": "TRACTOR",
  "usdotNumber": "string",
  "mcNumber": "string",
  "usdotPhoto": "string",
  "truckPhotos": [
    "string"
  ],
  "notes": "string",
  "createdTime": "string",
  "createdBy": "string",
  "updatedTime": "string",
  "updatedBy": "string",
  "carrierId": "string",
  "carrierName": "string",
  "customerId": "string",
  "customerName": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenoneUnique numeric identifier for the vehicle record
vehicleIdstringfalsenoneUnique identifier string for the vehicle
licensePlatestringfalsenoneVehicle plate number
platePhotostringfalsenoneVehicle plate photo (URL or file identifier)
vehicleTypestringfalsenoneType of vehicle
usdotNumberstringfalsenoneUnited States Department of Transportation (USDOT) number associated with the vehicle
mcNumberstringfalsenoneMotor Carrier (MC) number
usdotPhotostringfalsenoneUSDOT photo (URL or file identifier)
truckPhotos[string]falsenonePhotos of the truck (URLs or file identifiers)
notesstringfalsenoneAdditional notes about the vehicle
createdTimestringfalsenoneTimestamp when the vehicle record was created
createdBystringfalsenoneUser who created the vehicle record
updatedTimestringfalsenoneTimestamp when the vehicle record was last updated
updatedBystringfalsenoneUser who last updated the vehicle record
carrierIdstringfalsenoneAssociated carrier ID
carrierNamestringfalsenoneAssociated carrier name
customerIdstringfalsenoneAssociated customer ID
customerNamestringfalsenoneAssociated customer name

Enum Values

PropertyValue
vehicleTypeBOX_TRUCK
vehicleTypeCAR
vehicleTypeTRACTOR
vehicleTypeOTHER