summaryYard

GET /api/dashboard/summary/yard

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

yard_id integer(int64)

yard_id
show_other_carriers boolean

show_other_carriers
carrier_id integer(int64)

carrier_id

Responses

200 */*

OK
Hide response attribute Show response attribute object
- yards array[object]
  
  Hide yards attributes Show yards attributes object
  
  max_capacity integer(int32)
  
  other_carriers_count integer(int32)
  
  place_id string
  
  spots_available integer(int32)
  
  usage_percent integer(int32)
  
  yard_address string
  
  yard_capacity_mode string
  
  Values are FILTERED_CARRIERS or YARD_TOTAL.
  
  yard_id integer(int64)
  
  yard_name string
401

Unauthorized
403

Forbidden
404

Not Found

GET /api/dashboard/summary/yard

curl \
 -X GET http://127.0.0.1:8080/api/dashboard/summary/yard

Response examples (200)

{
  "yards": [
    {
      "max_capacity": 42,
      "other_carriers_count": 42,
      "place_id": "string",
      "spots_available": 42,
      "usage_percent": 42,
      "yard_address": "string",
      "yard_capacity_mode": "FILTERED_CARRIERS",
      "yard_id": 42,
      "yard_name": "string"
    }
  ]
}