POST Update Location/Level 1

Introduction

Updates an existing location's configuration in the Yard Management System (YMS). This endpoint allows modifications to location properties, access controls, operational settings, and real-time status information. Supports both manual configuration updates (activities, customer assignments, operating hours) and automated system updates (occupancy status, current carrier/driver). Used when business requirements change, during operational reconfigurations, or when equipment arrives/departs from locations.

API Request

POST /location/{locationId}/update

Body Request Parameters

{
  "locationId": "string",
  "locationName": "string",
  "locationType": "DOCK",
  "locationStatus": "AVAILABLE",
  "assignedScore": 0,
  "yardActivity": "DROP_OFF_EMPTY",
  "dockActivity": "LIVE_DELIVERY",
  "locationActivities": [
    "LIVE_DELIVERY"
  ],
  "loadTaskType": "LIVE_LOAD",
  "carrierIds": [
    "string"
  ],
  "customerIds": [
    "string"
  ],
  "stagingLocationIds": [
    "string"
  ],
  "allowedTypes": [
    "TRACTOR_ONLY"
  ],
  "companyCode": "string",
  "activeTimeFrom": "string",
  "activeTimeTo": "string",
  "notes": "string",
  "locationPhoto": "string",
  "zoneTag": "string",
  "groupName": "string",
  "currentCarrierId": "string",
  "currentTaskType": "string",
  "currentDriverId": "string",
  "currentEntryId": "string",
  "arrivalTime": "string",
  "displayName": "stri",
  "dynamicFieldValues": [
    {
      "entityId": "string",
      "entityType": "RECEIPT",
      "fieldCode": "string",
      "shortValue": "string",
      "longValue": "string",
      "value": "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": [
    {
      "linkId": "string",
      "linkType": "DOCK"
    }
  ],
  "deleted": true,
  "sequenceNo": 0,
  "windowConfigs": [
    {
      "windowId": 0,
      "locationActivity": [
        "string"
      ],
      "carrierIds": [
        "string"
      ],
      "customerIds": [
        "string"
      ]
    }
  ]
}

Request Parameters

Name	Location	Type	Required	Description
locationId	path	string	Yes	none
X-Tenant-ID	header	string	No	none
X-Yard-ID	header	string	No	none
Item-Time-Zone	header	string	No	none
Authorization	header	string	No	none
body	body	LocationUpdateCmd	No	none

Response Example

200 Response

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

Response

Status Code	Definition	Description	Data Model
200	OK (opens in a new tab)	none	RLocationView

POST Create Location Level 1 GET Get Location by ID