API Docs
YMS API
Data Models
Equipment
Equipment Status Query

EquipmentStatusQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "equipmentId": "string",
  "equipmentNo": "string",
  "equipmentNos": [
    "string"
  ],
  "equipmentIds": [
    "string"
  ],
  "equipmentType": "VEHICLE",
  "excludeEquipmentType": "VEHICLE",
  "excludeEquipmentTypes": [
    "VEHICLE"
  ],
  "containEquipmentTypes": [
    "string"
  ],
  "carrierId": "string",
  "carrierIds": [
    "string"
  ],
  "customerId": "string",
  "customerIds": [
    "string"
  ],
  "checkInEntry": "string",
  "inYard": true,
  "yardId": "string",
  "locationId": "string",
  "locationIdNotNull": true,
  "lastEntryId": "string",
  "sealNumber": "string",
  "keyword": "string",
  "locationIds": [
    "string"
  ],
  "lastEntryIds": [
    "string"
  ],
  "cargoStatus": "UNKNOWN",
  "cargoStatuses": [
    "UNKNOWN"
  ],
  "excludeEquipmentIds": [
    "string"
  ],
  "fillEquipmentActivity": false,
  "referenceNos": [
    "string"
  ],
  "referenceNo": "string",
  "equipmentOperationStatuses": [
    "DROP_OFF_FULL"
  ],
  "companyCode": "string",
  "companyCodes": [
    "string"
  ],
  "excludeLastEntryIds": [
    "string"
  ],
  "taskNotInProgress": true
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField (opens in a new tab)]falsenonenone
equipmentIdstringfalsenoneEquipment ID
equipmentNostringfalsenoneEquipment number
equipmentNos[string]falsenoneEquipment Nos
equipmentIds[string]falsenoneEquipment IDs
equipmentTypestringfalsenoneEquipment type
excludeEquipmentTypestringfalsenonenone
excludeEquipmentTypes[string]falsenonenone
containEquipmentTypes[string]falsenonenone
carrierIdstringfalsenoneCarrier ID
carrierIds[string]falsenoneCarrier IDs
customerIdstringfalsenoneCustomer ID
customerIds[string]falsenoneCustomer IDs
checkInEntrystringfalsenoneCheck-in entry identifier
inYardbooleanfalsenoneIs in yard
yardIdstringfalsenoneYard ID
locationIdstringfalsenoneLocation ID
locationIdNotNullbooleanfalsenoneLocation ID not null filter
lastEntryIdstringfalsenoneLast Entry ID
sealNumberstringfalsenonenone
keywordstringfalsenonenone
locationIds[string]falsenoneLocation ID
lastEntryIds[string]falsenoneLast Entry IDs
cargoStatusstringfalsenonenone
cargoStatuses[string]falsenonenone
excludeEquipmentIds[string]falsenonenone
fillEquipmentActivitybooleanfalsenonenone
referenceNos[string]falsenonenone
referenceNostringfalsenonenone
equipmentOperationStatuses[string]falsenoneEquipment operation statuses
companyCodestringfalsenoneEquipment ID
companyCodes[string]falsenonenone
excludeLastEntryIds[string]falsenonenone
taskNotInProgressbooleanfalsenonenone

Enum Values

PropertyValue
equipmentTypeVEHICLE
equipmentTypeTRAILER
equipmentTypeCHASSIS
equipmentTypeCONTAINER
equipmentTypeFLATBED
equipmentTypeOTHER
equipmentTypeNO_EQUIPMENT
excludeEquipmentTypeVEHICLE
excludeEquipmentTypeTRAILER
excludeEquipmentTypeCHASSIS
excludeEquipmentTypeCONTAINER
excludeEquipmentTypeFLATBED
excludeEquipmentTypeOTHER
excludeEquipmentTypeNO_EQUIPMENT
cargoStatusUNKNOWN
cargoStatusFULL
cargoStatusEMPTY
cargoStatusFULL_AFTER_LOADED
cargoStatusEMPTY_AFTER_OFFLOAD