API Docs
YMS API
Data Models
Location
Location Query

LocationQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "id": 0,
  "ids": [
    0
  ],
  "excludeLocationIds": [
    "string"
  ],
  "locationId": "string",
  "locationIds": [
    "string"
  ],
  "locationName": "string",
  "groupName": "string",
  "locationType": "DOCK",
  "locationTypes": [
    "DOCK"
  ],
  "locationStatus": "AVAILABLE",
  "locationStatuses": [
    "AVAILABLE"
  ],
  "enabled": true,
  "yardActivity": "DROP_OFF_EMPTY",
  "dockActivity": "LIVE_DELIVERY",
  "customerIds": [
    "string"
  ],
  "customerId": "string",
  "carrierIds": [
    "string"
  ],
  "carrierId": "string",
  "stagingLocationIds": [
    "string"
  ],
  "stagingLocationId": "string",
  "allowedTypes": [
    "TRACTOR_ONLY"
  ],
  "allowedType": "TRACTOR_ONLY",
  "notEqStatus": "AVAILABLE",
  "deleted": true,
  "currentEntryId": "string",
  "sequenceNo": 0,
  "companyCode": "string"
}

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField]falsenonenone
idinteger(int64)falsenoneLocation ID
ids[integer]falsenoneLocation IDs
excludeLocationIds[string]falsenonenone
locationIdstringfalsenoneLocation ID
locationIds[string]falsenoneLocation IDs
locationNamestringfalsenoneLocation name
groupNamestringfalsenonenone
locationTypestringfalsenoneLocation type
locationTypes[string]falsenoneLocation types
locationStatusstringfalsenoneLocation status
locationStatuses[string]falsenoneLocation statuses
enabledbooleanfalsenoneWhether the location is enabled
yardActivitystringfalsenoneYard Activity
dockActivitystringfalsenoneDock Activity
customerIds[string]falsenoneCustomer ID
customerIdstringfalsenoneCustomer ID
carrierIds[string]falsenoneCarrier ID
carrierIdstringfalsenoneCarrier ID
stagingLocationIds[string]falsenonenone
stagingLocationIdstringfalsenonenone
allowedTypes[string]falsenoneAllowed equipment types
Allowed equipment type filter, query locations containing the specified equipment type
allowedTypestringfalsenoneSingle allowed equipment type
Single allowed equipment type filter
notEqStatusstringfalsenoneNot equal to a specific location status
deletedbooleanfalsenonedeleted
currentEntryIdstringfalsenonedeleted
sequenceNointegerfalsenoneSequence No.
companyCodestringfalsenoneCompany code: UT,UF,CUBEWORK

Enum Values

PropertyValue
locationTypeDOCK
locationTypeSPOT
locationTypeSTAGING
locationTypeLOCATION
locationStatusAVAILABLE
locationStatusOCCUPIED
locationStatusDELETED
locationStatusASSIGNED
yardActivityDROP_OFF_EMPTY
yardActivityDROP_OFF_DELIVERY
yardActivityPICK_UP_PRELOAD
yardActivityPICK_UP_EMPTY
yardActivityPARKING
yardActivitySHARED
dockActivityLIVE_DELIVERY
dockActivityLIVE_LOAD
dockActivityPRE_LOAD
dockActivitySHARED
dockActivityDROP_OFF_DELIVERY
allowedTypeTRACTOR_ONLY
allowedTypeBOX_TRUCK
allowedTypeCAR
allowedTypeTRACTOR_COMBO
allowedTypeOTHER
notEqStatusAVAILABLE
notEqStatusOCCUPIED
notEqStatusDELETED
notEqStatusASSIGNED
Rpage Result Location ViewEntry Ticket View