API Docs
YMS API
Data Models
Location
Location View

LocationView

{
  "locationId": "string",
  "locationName": "string",
  "locationType": "DOCK",
  "locationStatus": "AVAILABLE",
  "assignedScore": 0,
  "enabled": true,
  "yardActivity": "DROP_OFF_EMPTY",
  "dockActivity": "LIVE_DELIVERY",
  "locationActivities": [
    "LIVE_DELIVERY"
  ],
  "loadTaskType": "LIVE_LOAD",
  "carrierIds": [
    "string"
  ],
  "carrierNames": [
    "string"
  ],
  "customerIds": [
    "string"
  ],
  "customerNames": [
    "string"
  ],
  "stagingLocationIds": [
    "string"
  ],
  "stagingLocationNames": [
    "string"
  ],
  "allowedTypes": [
    "TRACTOR_ONLY"
  ],
  "companyCode": "string",
  "activeTimeFrom": "string",
  "activeTimeTo": "string",
  "notes": "string",
  "locationPhoto": "string",
  "currentCarrierId": "string",
  "currentTaskType": "string",
  "currentDriverId": "string",
  "currentEntryId": "string",
  "arrivalTime": "string",
  "zoneTag": "string",
  "groupName": "string",
  "createdTime": "string",
  "updatedTime": "string",
  "currentDriveName": "string",
  "currentCarrierName": "string",
  "dynamicFieldValues": [
    {
      "entityId": "string",
      "entityType": "RECEIPT",
      "fieldCode": "string",
      "value": "string",
      "fieldName": "string",
      "longValue": "string",
      "shortValue": "string"
    }
  ],
  "displayName": "string",
  "iotResult": {
    "spo_id": "string",
    "s3_image_url": "string",
    "recognize_result": "string",
    "recognize_item": {
      "src_x": 0,
      "src_y": 0,
      "dst_x": 0,
      "dst_y": 0,
      "class_id": 0,
      "class_name": "string",
      "score": 0
    },
    "imageUrl": "string",
    "area": "string",
    "dockEvent": {
      "id": "string",
      "name": "string",
      "type": "string",
      "status": "string",
      "dockStatus": "string",
      "spaceStatus": "string",
      "entryId": "string",
      "category": "string",
      "equipmentNo": [
        "string"
      ],
      "createdWhen": "string",
      "updatedWhen": "string"
    }
  },
  "linkedLocations": [
    {
      "locationId": "string",
      "locationType": "DOCK",
      "linkId": "string",
      "linkName": "string",
      "linkType": "DOCK",
      "locationStatus": "AVAILABLE"
    }
  ],
  "sequenceNo": 0,
  "deleted": true,
  "windowConfigs": [
    {
      "id": 0,
      "locationId": "string",
      "windowId": 0,
      "windowStartTime": "string",
      "windowEndTime": "string",
      "locationActivity": [
        "string"
      ],
      "carrierIds": [
        "string"
      ],
      "customerIds": [
        "string"
      ],
      "carrierNames": [
        "string"
      ],
      "customerNames": [
        "string"
      ]
    }
  ],
  "currentWindowLocationActivities": [
    "string"
  ],
  "currentWindowCustomerIds": [
    "string"
  ],
  "currentWindowCustomerNames": [
    "string"
  ],
  "currentWindowCarrierIds": [
    "string"
  ],
  "currentWindowCarrierNames": [
    "string"
  ]
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
locationIdstringfalsenoneLocation ID
locationNamestringfalsenoneLocation name
locationTypestringfalsenoneLocation type (DOCK/SPOT/STAGING)
locationStatusstringfalsenoneLocation status (AVAILABLE/OCCUPIED/ASSIGNED)
assignedScoreintegerfalsenoneAssigned score, 0-100
enabledbooleanfalsenoneWhether the location is enabled
yardActivitystringfalsenonenone
dockActivitystringfalsenonenone
locationActivities[string]falsenoneLocation activities list: LIVE_DELIVERY/LIVE_LOAD/PRE_LOAD/SHARED/DROP_OFF_DELIVERY/DROP_OFF_EMPTY/PICK_UP_PRELOAD/PICK_UP_EMPTY/PARKING/DROP_OFF_FULL
loadTaskTypestringfalsenoneLoad task type: LIVE_LOAD/PRE_LOAD/ALL
carrierIds[string]falsenoneCarrier IDs list
carrierNames[string]falsenoneCarrier names list
customerIds[string]falsenoneCustomer IDs list
customerNames[string]falsenoneCustomer names list
stagingLocationIds[string]falsenoneStaging Location IDs list
Used to store IDs of staging locations associated with dock-type locations
stagingLocationNames[string]falsenoneStaging Location names list
Used to store names of staging locations associated with dock-type locations
allowedTypes[string]falsenoneAllowed equipment types list
List of allowed equipment types, used for type filtering during location suggestions
If empty or null, no equipment type restrictions apply
companyCodestringfalsenoneCompany code: UT,UF,CUBEWORK
activeTimeFromstringfalsenoneActive time from
activeTimeTostringfalsenoneActive time to
notesstringfalsenoneNotes
locationPhotostringfalsenoneLocation photo
currentCarrierIdstringfalsenoneCurrent carrier ID
currentTaskTypestringfalsenoneCurrent task type
currentDriverIdstringfalsenoneCurrent driver ID
currentEntryIdstringfalsenoneCurrent Entry Ticket ID
arrivalTimestringfalsenoneArrival time
zoneTagstringfalsenoneZone tag
groupNamestringfalsenoneLocation Group Name
createdTimestringfalsenoneCreated time
updatedTimestringfalsenoneUpdated time
currentDriveNamestringfalsenoneCurrent driver Name
currentCarrierNamestringfalsenoneCurrent carrier Name
dynamicFieldValues[DynamicFieldValueView]falsenoneDynamic field values
displayNamestringfalsenoneDisplay name (limited to 4 characters)
iotResultDockIotResultfalsenonenone
linkedLocations[LinkedLocationView]falsenoneLinked locations list
sequenceNointegerfalsenonenone
deletedbooleanfalsenonenone
windowConfigs[LocationExtendConfigView]falsenoneWindow configs list
currentWindowLocationActivities[string]falsenoneCurrent window location activities
Location activities for the current time window (if any)
This is distinguished from the default locationActivities field
currentWindowCustomerIds[string]falsenoneCurrent window customer IDs
Customer IDs for the current time window (if any)
currentWindowCustomerNames[string]falsenoneCurrent window customer names
Customer names for the current time window (if any)
currentWindowCarrierIds[string]falsenoneCurrent window carrier IDs
Carrier IDs for the current time window (if any)
currentWindowCarrierNames[string]falsenoneCurrent window carrier names
Carrier names for the current time window (if any)

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
loadTaskTypeLIVE_LOAD
loadTaskTypePRE_LOAD
loadTaskTypeALL