Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/truck_drivers.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE" -d '{"firstname":"John", "lastname":"Doe"}'
  {
   "truck_drivers" : [
      {
         "license_number" : "N/A",
         "twic" : 'TEST123',
         "active" : true,
         "firstname" : "JOHN",
         "lastname" : "DOE",
         "number" : "",
         "id" : 3
      },
      {
         "license_number" : "CAM12311",
         "twic" : 'AF123131',
         "active" : true,
         "firstname" : "JOHN",
         "lastname" : "BEAST",
         "number" : "",
         "id" : 4
      }
   ],
   "actions" : {
      "next" : {
         "url" : "http://localhost:3000/api/v1/truck_drivers.json?page=2",
         "method" : "GET"
      },
      "last" : {
         "method" : "GET",
         "url" : "http://localhost:3000/api/v1/truck_drivers.json?page=3"
      },
      "previous" : {
         "method" : "GET",
         "url" : "http://localhost:3000/api/v1/truck_drivers.json?page=0"
      },
      "index" : {
         "url" : "http://localhost:3000/api/v1/truck_drivers",
         "method" : "GET"
      }
   }
}

Params

Param name Description
firstname
optional

Filter truck drivers by first name

Validations:

  • Must be String

lastname
optional

Filter truck drivers by last name

Validations:

  • Must be String

twic
optional

Filter truck drivers by TWIC

Validations:

  • Must be String

license_number
optional

Filter truck drivers by license number

Validations:

  • Must be String

number
optional

Filter truck drivers by number

Validations:

  • Must be String

email
optional

Filter truck drivers by email

Validations:

  • Must be String

active
optional

If true, will return active truck drivers. If false, will return inactive truck drivers. If absent, Octopi will return both active and inactive truck drivers.

Validations:

  • Must be String