This resource lets clients find, create, update or list truck drivers truck driver information.
Code | Description |
---|---|
400 | Bad Request. |
404 | Resource Not Found. |
500 | Internal Server Error. |
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" : "https://app.octopi.co/api/v1/truck_drivers.json?page=2", "method" : "GET" }, "last" : { "method" : "GET", "url" : "https://app.octopi.co/api/v1/truck_drivers.json?page=3" }, "previous" : { "method" : "GET", "url" : "https://app.octopi.co/api/v1/truck_drivers.json?page=0" }, "index" : { "url" : "https://app.octopi.co/api/v1/truck_drivers", "method" : "GET" } } }
Param name | Description |
---|---|
firstname optional |
Filter truck drivers by first name Validations:
|
lastname optional |
Filter truck drivers by last name Validations:
|
twic optional |
Filter truck drivers by TWIC Validations:
|
license_number optional |
Filter truck drivers by license number Validations:
|
number optional |
Filter truck drivers by number Validations:
|
email optional |
Filter truck drivers by email Validations:
|
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:
|
Creates a new truck driver.
Code | Description |
---|---|
400 | Bad Request. |
404 | Resource Not Found. |
500 | Internal Server Error. |
curl "https://app.octopi.co/api/v1/truck_drivers.json" -d '{"truck_driver": { "number": "1231NU78", "first_name": "Juan", "last_name": "Torres", "license_number": "N/A" }}' -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"
Param name | Description |
---|---|
first_name required |
The first name of the driver. Validations:
|
last_name required |
The last name of the driver. Validations:
|
license_number required |
The license number of the driver or N/A if not available. Validations:
|
number optional |
A unique number used by the terminal to identify the driver. Validations:
|
trucking_company_name optional |
Name of the trucking company for the driver. Validations:
|
Updates a truck driver record
Code | Description |
---|---|
400 | Bad Request. |
404 | Resource Not Found. |
500 | Internal Server Error. |
curl "https://app.octopi.co/api/v1/truck_drivers/:number.json" -d '{"truck_driver": { "first_name": "Juan", "last_name": "Torres", "license_number": "new_license_number" }}' -X PATCH -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"
Param name | Description |
---|---|
first_name required |
The first name of the driver. Validations:
|
last_name required |
The last name of the driver. Validations:
|
license_number required |
The license number of the driver or N/A if not available. Validations:
|
number optional |
A unique number used by the terminal to identify the driver. Validations:
|
trucking_company_name optional |
Name of the trucking company for the driver. Validations:
|
Searches for a driver based on license number or number
Code | Description |
---|---|
400 | Bad Request. |
404 | Resource Not Found. |
500 | Internal Server Error. |
curl "https://app.octopi.co/api/v1/truck_driver.json?number=1234" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN" curl "https://app.octopi.co/api/v1/truck_driver.json?license_number=1234" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"
Param name | Description |
---|---|
license_number optional |
Search for truck driver by license number Validations:
|
number optional |
Search for truck driver by number Validations:
|