Retrieve Dock

Get a dock at a specified facility by a given id.

SecurityAPIKeyHeader
Request
path Parameters
dock_id
required
string (Dock Id)
facility_id
required
string (Facility Id) = 26 characters
Responses
200

Successful Response

Response Schema: application/json
name
required
string (Name)
color
required
string (Color) ^#([A-Fa-f0-9]{6})$
total_max_concurrent_appointments
integer (Total Max Concurrent Appointments)
Default: 10000

Maximum number of appointments of all types that may be loading/unloading at this dock simultaneously

id
required
string (Id)
facility_id
required
string (Facility Id)
400

Validation Error

get/facilities/{facility_id}/docks/{dock_id}
Request samples
Response samples
application/json
{
  • "name": "string",
  • "color": "string",
  • "total_max_concurrent_appointments": 10000,
  • "id": "string",
  • "facility_id": "string"
}
Copyright © Shipwell 2024. All right reserved.