/
Driver Object v2

Driver Object v2

Owned by Matt Sullivan (Unlicensed)
Last updated: Feb 08, 2024 by Kieran Mitchell (Unlicensed)
2 min read

Path Parameters

HTTP Header

api-key status:REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

relationship ID status:REQUIRED
integer - ID of your chosen relationship

driver ID status:Optional
integer - ID of your chosen driver

Driver Requests status:GEt status:Post status:put

status:Get status:Post - Retrieve drivers linked to a relationship or add a new driver into a relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/drivers/

Example Payload status:POSt

{ "forename":"Joe", "surname":"Bloggs", "date_of_birth":"1970-02-08", "email_address":"jbloggs@example.com" }

Response

status:200
Returned if the request is successful.

{ "items": [ { "driver_id": 28422, "forename": "Joe", "middle_name": null, "surname": "Bloggs", "employee_number": null, "date_of_birth": "1970-02-08", "position": null, "telephone_number": null, "mobile_number": null, "email_address": "jbloggs@example.com", "driving_licence_number": null, "driving_licence_status": null, ... } ], "first": { "$ref": "https://matt.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/drivers/" } }

status:400
Returned if the request sent is invalid.

status:404
Returned if the request is not found or the user does not have permission to view it.

status:Put - Update an existing driver

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/driver/{id}/

Example Payload status:PUT

{ "forename":"Joe", "surname":"Bloggs", "email_address":"jbloggs456@example.com", "driving_licence_status":"Live" }

Response

status:200
Returned if the request is successful.

A successful status:put request will not return a response object.

{}

status:400
Returned if the request sent is invalid.

status:404
Returned if the request is not found or the user does not have permission to view it.

Driver Attributes

When updating/adding a new driver via the API, there are a number of fields needed.

Mandatory Fields

forename - string

surname - string

Non Mandatory Fields

driver_id - number
Must not be supplied when using status:POST or status:PUT

employee_number - string

middle_name - string

position - string

email_address - string
Must be a valid email address.

telephone_number - string

mobile_number - string

date_of_birth - string
yyyy-mm-dd

driving_licence_number - string

driving_licence_checked - date
Must be a valid date

driving_licence_expiry - string
Must be a valid date

driving_licence_status - string
Must be either Live, Suspended, Provisional or Revoked

driving_licence_points - number
Must be a number between 0 and 99

income_tax_rate - number
Must be a valid income tax rate

ice_contact_details - string

primary_location - string

vip_flag - string
Y or N

annual_salary - number

must be a whole number

Related content