API Docs
YMS API
Data Models
Location
Page Result Location View

PageResultLocationView

{
  "list": [
    {
      "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": [
            null
          ],
          "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"
      ]
    }
  ],
  "totalCount": 0,
  "currentPage": 0,
  "pageSize": 0,
  "totalPage": 0
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
list[LocationView]falsenonenone
totalCountinteger(int64)falsenonenone
currentPageinteger(int64)falsenonenone
pageSizeinteger(int64)falsenonenone
totalPageinteger(int64)falsenonenone