Yms apiLocation level 1
GET Get Location by ID
GET Get Location by ID
Introduction
Retrieves detailed information for a specific location by its unique identifier. This endpoint returns comprehensive location data including type, status, activities, customer/carrier assignments, current occupancy details, and operational settings. Used by operations staff to view location details, by appointment systems to verify location availability, and by real-time dashboards to display current location status and equipment positioning.
API Request
GET /location/{locationId}
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 |
Response Example
200 Response
Response
Status Code | Definition | Description | Data Model |
|---|---|---|---|
200 | OK | none | RLocationView |