The Driver object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

full_name string required
status string required
transporter string
employee string
cell_number string
license_number string
issuing_date string
expiry_date string
address string
user string
The Driver object 
{
  "id": "driver_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "full_name": "full_name_example",
  "status": "draft",
  "transporter": "transporter_example",
  "employee": "employee_example",
  "cell_number": "cell_number_example",
  "license_number": "license_number_example",
  "issuing_date": "2024-01-15",
  "expiry_date": "2024-01-15",
  "address": "address_example",
  "user": "user_example"
}
GET /api/setup/driver/{id}

Retrieve a driver

Retrieves the details of an existing driver. Supply the unique driver ID that was returned from a previous request.

Path parameters

id string required

The identifier of the driver to retrieve.

Returns

Returns the driver object if a valid identifier was provided.

GET /api/setup/driver/{id} 
curl https://api.overplane.dev/api/setup/driver/driver_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "driver_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "full_name": "full_name_example",
  "status": "draft",
  "transporter": "transporter_example",
  "employee": "employee_example",
  "cell_number": "cell_number_example",
  "license_number": "license_number_example",
  "issuing_date": "2024-01-15",
  "expiry_date": "2024-01-15",
  "address": "address_example",
  "user": "user_example"
}
GET /api/setup/driver

List all drivers

Returns a list of drivers. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of driver objects.

GET /api/setup/driver 
curl https://api.overplane.dev/api/setup/driver \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "driver_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "full_name": "full_name_example",
      "status": "draft",
      "transporter": "transporter_example",
      "employee": "employee_example",
      "cell_number": "cell_number_example",
      "license_number": "license_number_example",
      "issuing_date": "2024-01-15",
      "expiry_date": "2024-01-15",
      "address": "address_example",
      "user": "user_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/driver

Create a driver

Creates a new driver object.

Body parameters

full_name string required
status string required
transporter string
employee string
cell_number string
license_number string
issuing_date string
expiry_date string
address string
user string

Returns

Returns the newly created driver object if the call succeeded.

POST /api/setup/driver 
curl https://api.overplane.dev/api/setup/driver \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"full_name":"full_name_example","status":"draft"}'
Response 
{
  "id": "driver_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "full_name": "full_name_example",
  "status": "draft",
  "transporter": "transporter_example",
  "employee": "employee_example",
  "cell_number": "cell_number_example",
  "license_number": "license_number_example",
  "issuing_date": "2024-01-15",
  "expiry_date": "2024-01-15",
  "address": "address_example",
  "user": "user_example"
}
PATCH /api/setup/driver/{id}

Update a driver

Updates the specified driver by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the driver to update.

Body parameters

full_name string
status string
transporter string
employee string
cell_number string
license_number string
issuing_date string
expiry_date string
address string
user string

Returns

Returns the updated driver object.

PATCH /api/setup/driver/{id} 
curl https://api.overplane.dev/api/setup/driver/driver_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"full_name":"full_name_example","status":"draft"}'
Response 
{
  "id": "driver_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "full_name": "full_name_example",
  "status": "draft",
  "transporter": "transporter_example",
  "employee": "employee_example",
  "cell_number": "cell_number_example",
  "license_number": "license_number_example",
  "issuing_date": "2024-01-15",
  "expiry_date": "2024-01-15",
  "address": "address_example",
  "user": "user_example"
}
DELETE /api/setup/driver/{id}

Delete a driver

Permanently deletes a driver. This cannot be undone.

Path parameters

id string required

The identifier of the driver to delete.

Returns

Returns a confirmation that the driver has been deleted.

DELETE /api/setup/driver/{id} 
curl https://api.overplane.dev/api/setup/driver/driver_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "driver_abc123",
  "deleted": true
}

Line items

Child objects that belong to this driver. These are accessed via the parent's ID.

Driving License Category

Attributes

idx integer
driver_id string required
class string
description string
issuing_date string
expiry_date string

Endpoints

GET /api/setup/driving-license-category?parent_id={id}
POST /api/setup/driving-license-category
PATCH /api/setup/driving-license-category/{id}
DELETE /api/setup/driving-license-category/{id}
POST /api/setup/driving-license-category/reorder
Driving License Category object 
{
  "id": "driving-license-category_abc123",
  "idx": 1,
  "driver_id": "driver_id_example",
  "class": "class_example",
  "description": "description_example",
  "issuing_date": "2024-01-15",
  "expiry_date": "2024-01-15"
}