Gensets
This resource allows you to retrieve data for one genset from Octopi.

Supported Formats

json
>>>

GET /api/v1/gensets.json

This genset API endpoint allows querying all gensets.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Genset Not Found
500 Internal Server Error.

Examples

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

{
  "gensets": [
    {
      "id": 123,
      "number": "G085",
      "seal": "5885304",
      "chassis": null,
      "has_battery": true,
      "created_by": "Peter Parker",
      "updated_by": null,
      "created_at": "2018-08-20T18:43:54.138-04:00",
      "updated_at": "2019-05-31T17:23:49.144-04:00",
      "equipment_condition": null,
      "fuel_level": "1.5",
      "container": null,
      "current_location": "Terminal: Happy Terminals",
      "shipping_line": "Shipping Line: Evergreen",
      "active": false,
      "hours": null
    },
    {
      "id": 456,
      "number": "G086",
      "seal": null,
      "chassis": null,
      "has_battery": true,
      "created_by": null,
      "updated_by": null,
      "created_at": "2019-09-11T15:37:59.355-04:00",
      "updated_at": "2019-09-11T15:37:59.355-04:00",
      "equipment_condition": null,
      "fuel_level": null,
      "container": null,
      "current_location": null,
      "shipping_line": "Shipping Line: King Ocean",
      "active": true,
      "hours": null
    }
  ]
}

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/gensets/:number.json

This genset API endpoint allows querying for one genset.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Genset Not Found
500 Internal Server Error.

Examples

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

{
  "genset": {
    "id": 1234,
    "number": "G000123",
    "seal": null,
    "chassis": null,
    "has_battery": true,
    "created_by": null,
    "updated_by": null,
    "created_at": "2022-09-23T11:09:57.098-04:00",
    "updated_at": "2022-09-23T11:09:57.098-04:00",
    "equipment_condition": null,
    "fuel_level": null,
    "container": null,
    "current_location": null,
    "active": true,
    "shipping_line": null,
    "hours": null
  }
}