GET /api/v1/yard_areas/:id.json

This API endpoint allows you to fetch information about a yard area.

Supported Formats

json

Errors

Code	Description
404	Not Found
400	Invalid request.
500	Server crashed.

Examples

curl "https://app.octopi.co/api/v1/yard_areas/54321.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

 {
  "yard_area": {
   "id": 54321,
   "name": "A",
   "description": "Area used for reefers",
   "area_type": "grid",
   "capacity": "20x9x2",
   "terminal": {"id": 2, "name": "Port Miami"},
   "current_containers_count": 73,
   "current_teu_count": 146,
   "yard_slots": [
      {
        "id": 5,
        "custom_name": "slot 1",
        "description": nil,
        "row": 1,
        "depth": 1,
        "height": 1,
        "lat": nil,
        "lng": nil,
        "enabled": true
      }
    ]
  }
}