Retrieve Facility

Retrieve a facility by a given id.

SecurityAPIKeyHeader
Request
path Parameters
facility_id
required
string (Facility Id)
query Parameters
include
Array of strings (FacilityIncludeQueryOptionEnum)

Include child entities that are not returned by default

Items Enum: "DOCKS" "DOCK_COUNT" "CONTACT_COUNT" "LOAD_TYPE_COUNT"
Responses
200

Successful Response

Response Schema: application/json
name
required
string (Name)
location_type
required
string (LocationTypes)

An enumeration.

Enum: "AIRPORT" "BUSINESS_WITH_DOCK_OR_FORKLIFT" "BUSINESS_WITHOUT_DOCK_OR_FORKLIFT" "COMMERCIAL_FARM_RANCH_MARINA" "CONSTRUCTION_SITE" "GOVERNMENT_LOCATION" "MILITARY_BASE" "OTHER_SECURED_OR_LIMITED_ACCESS_LOCATION" "RELIGIOUS_INSTITUTION" "RESIDENCE_HOME_BUSINESS" "RESTAURANT_HOTEL_GOLF_COURSE_PARK" "SCHOOL_COLLEGE" "SELF_MINI_STORAGE_FACILITY" "TERMINAL" "TRADE_SHOW_CONVENTION_CENTER"
required
object (FacilityAddress)
facility_services
required
Array of strings (FacilityServices)
Items Enum: "RESTROOMS" "OVERNIGHT_PARKING" "INTERIOR_PARKING" "EXTERIOR_PARKING" "LOUNGE_AREA" "WIFI" "FOOD" "SECURITY" "SPANISH"
external_reference
string (External Reference) <= 255 characters
notes
string (Notes)
carrier_instructions
string (Carrier Instructions)
disclaimers
string (Disclaimers)
appointment_lead_time_duration
required
string <duration> (Appointment Lead Time Duration)
late_appointment_threshold_duration
required
string <duration> (Late Appointment Threshold Duration)
first_appointment_start_time
string <time> (First Appointment Start Time)
last_appointment_end_time
string <time> (Last Appointment End Time)
exclude_dock_assignment_from_appointment_scheduling
required
boolean (Exclude Dock Assignment From Appointment Scheduling)
id
required
string (Id)
created_at
required
string <date-time> (Created At)
updated_at
required
string <date-time> (Updated At)
dock_count
integer (Dock Count)

Number of Docks at the Facility.

contact_count
integer (Contact Count)

Number of Contacts at the Facility.

load_type_count
integer (Load Type Count)

Number of LoadTypes at the Facility.

Array of objects (Docks)

Child docks

400

Validation Error

get/facilities/{facility_id}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "location_type": "AIRPORT",
  • "address": {
    },
  • "facility_services": [
    ],
  • "external_reference": "string",
  • "notes": "string",
  • "carrier_instructions": "string",
  • "disclaimers": "string",
  • "appointment_lead_time_duration": "P1DT23H30M4.000000S",
  • "late_appointment_threshold_duration": "P1DT23H30M4.000000S",
  • "first_appointment_start_time": "14:15:22Z",
  • "last_appointment_end_time": "14:15:22Z",
  • "exclude_dock_assignment_from_appointment_scheduling": true,
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "dock_count": 0,
  • "contact_count": 0,
  • "load_type_count": 0,
  • "docks": [
    ]
}
Copyright © Shipwell 2024. All right reserved.