GET /api/v1/chassis.json

This chassis API endpoint allows querying all chassis.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Chassis Not Found
422 Unprocessable entity
500 Internal Server Error.

Examples

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

{
  "chassis": [
    {
      "id": 54756,
      "number": "44090",
      "active": false,
      "owner": null,
      "size": 40,
      "shipping_line": {
        "id": 12345,
        "code": "UNKN",
        "name": "Unknown",
        "synonyms": [],
        "carrier_type": "ocean",
        "address": "",
        "empty_container_storage_teu_quota": null,
        "email": "",
        "contact_person": "",
        "phone": "",
        "receive_email_alerts_on_container_damages": false,
        "vat_number": "",
        "general_ledger_id": "",
        "dock_receipt_email": ""
      },
      "equipment_condition": "Average",
      "current_location": "UNKNOWN",
      "container": "KOSU1356283",
      "damage_state": "Not damaged",
      "license_plate_number": null,
      "created_at": "2020-01-31T16:53:29Z",
      "updated_at": "2020-09-04T17:14:12Z"
    },
    {
      "id": 47843,
      "number": "ANCA332101",
      "active": true,
      "owner": null,
      "size": 20,
      "axles": 2,
      "equipment_condition": null,
      "current_location": "FREIGHT FORWARDER",
      "container": "KOSU145383",
      "damage_state": "Not damaged",
      "license_plate_number": null,
      "created_at": "2018-11-14T00:05:05Z",
      "updated_at": "2021-11-09T03:50:20Z"
    }
  ],
  "actions": {
    "index": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/chassis"
    },
    "next": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/chassis?page=2"
    },
    "previous": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/chassis?page=0"
    },
    "last": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/chassis?page=50"
    }
  }
}

Params

Param name Description
page
optional

Specify which page of results to fetch. This value defaults to 1.

Validations:

  • Must be a Integer
per
optional

The number of items to be displayed. This value defaults to 10 and accepts a maximum of 100.

Validations:

  • Must be a Integer