Chassis
This resource allows you to retrieve data for one chassis from Octopi.

Supported Formats

json
>>>

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
>>>

GET /api/v1/chassis/:number.json

This chassis API endpoint allows querying for one 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/MYCHASSIS.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

{
  "chassis": {
    "id": 12345,
    "number": "MYCHASSIS",
    "active": true,
    "owner": null,
    "size": 40,
    "axles": 3,
    "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": "Terminal A",
    "container": "ABC12345",
    "damage_state": "Not damaged",
    "license_plate_number": null,
    "created_at": "2021-01-31T16:53:29Z",
    "updated_at": "2021-09-04T17:14:12Z"
  }
}
>>>

POST /api/v1/chassis.json
Create a new chassis

This API endpoint allows you to create a new 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 POST -d '{ "chassis": { "number": "TEST1234", "active": true, "owner_type": "Shipping Line", "owner_id": 10, "size": 40, "axles": 3, "shipping_line_id": 12345, "equipment_condition": "good", "license_plate_number": "BACD1234" } }' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"

{
  "chassis": {
    "id": 4262,
    "number": "TEST1234",
    "active": true,
    "owner": "HAMBURG SUD",
    "size": 40,
    "axles": 3,
    "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": "Good",
    "current_location": null,
    "container": null,
    "license_plate_number": "BACD1234",
    "created_at": "2022-07-06T08:39:06Z",
    "updated_at": "2022-07-06T08:39:06Z"
  }
}

Params

Param name Description
chassis
required

Validations:

  • Must be a Hash
chassis[number]
required

The chassis number. Must be unique.

Validations:

  • Must be a String
chassis[active]
optional

Whether the chassis is active or not.

Validations:

  • Must be one of: true, false.
chassis[owner_type]
optional

The owner type for this chassis. Defaults to ‘Organization’.

Validations:

  • Must be one of: Container owner, Organization, Other, Shipping line, Trucking company.
chassis[owner_id]
optional

The owner id for this chassis

Validations:

  • Must be a Integer
chassis[size]
optional

The chassis size.

Validations:

  • Must be one of: 10, 20, 40, 45, 53.
chassis[axles]
optional

The number of axles on the chassis.

Validations:

  • Must be a Integer
chassis[shipping_line_id]
optional

The shipping line id of this chassis

Validations:

  • Must be a Integer
chassis[equipment_condition]
optional

The chassis condition.

Validations:

  • Must be a String
chassis[current_location_type]
optional

The chassis current location type.

Validations:

  • Must be one of: Consignee, Other, Port, Ship, Terminal, Train visit, Voyage, Yard area, Yard slot.
chassis[current_location_id]
optional

The chassis current location id.

Validations:

  • Must be a Integer
chassis[container]
optional

The container number for this chassis.

Validations:

  • Must be a String
chassis[license_plate_number]
optional

The chassis license plate number. Must be unique.

Validations:

  • Must be a String
>>>

PATCH /api/v1/chassis/:number.json
Update an existing chassis

This API endpoint allows you to update an existing 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/TEST1234.json" -X POST -d '{ "chassis": { "size": 20, "equipment_condition": "excellent", "license_plate_number": "NEW123", "axles": 1, "shipping_line_id": 12345 } }' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"

{
  "chassis": {
    "id": 4262,
    "number": "TEST1234",
    "active": true,
    "owner": "HAMBURG SUD",
    "size": 20,
    "axles": 1,
    "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": "Excellent",
    "current_location": null,
    "container": null,
    "license_plate_number": "NEW123",
    "created_at": "2022-07-06T08:39:06Z",
    "updated_at": "2022-07-06T08:39:06Z"
  }
}

Params

Param name Description
chassis
required

Validations:

  • Must be a Hash
chassis[number]
required

The chassis number. Must be unique.

Validations:

  • Must be a String
chassis[active]
optional

Whether the chassis is active or not.

Validations:

  • Must be one of: true, false.
chassis[owner_type]
optional

The owner type for this chassis. Defaults to ‘Organization’.

Validations:

  • Must be one of: Container owner, Organization, Other, Shipping line, Trucking company.
chassis[owner_id]
optional

The owner id for this chassis

Validations:

  • Must be a Integer
chassis[size]
optional

The chassis size.

Validations:

  • Must be one of: 10, 20, 40, 45, 53.
chassis[axles]
optional

The number of axles on the chassis.

Validations:

  • Must be a Integer
chassis[shipping_line_id]
optional

The shipping line id of this chassis

Validations:

  • Must be a Integer
chassis[equipment_condition]
optional

The chassis condition.

Validations:

  • Must be a String
chassis[current_location_type]
optional

The chassis current location type.

Validations:

  • Must be one of: Consignee, Other, Port, Ship, Terminal, Train visit, Voyage, Yard area, Yard slot.
chassis[current_location_id]
optional

The chassis current location id.

Validations:

  • Must be a Integer
chassis[container]
optional

The container number for this chassis.

Validations:

  • Must be a String
chassis[license_plate_number]
optional

The chassis license plate number. Must be unique.

Validations:

  • Must be a String