Skip to main content

Driver Object v2

A technical guide to retrieving, adding, and updating driver information in QV Systems Accelerate using API v2.

Funmilola Olorode avatar
Written by Funmilola Olorode
Updated over 7 months ago

Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

relationship ID REQUIRED
integer - ID of your chosen relationship

driver ID OPTIONAL
integer - ID of your chosen driver

Driver Requests

GET POST PUT

GET 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

POST

{
    "forename":"Joe",
    "surname":"Bloggs",
    "date_of_birth":"1970-02-08",
    "email_address":"[email protected]"
}

Response

400
​

Returned if the request sent is invalid.

404
​

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

200
Returned if the request is successful.

Expand to see example of a successful response.

{
    "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": "[email protected]",
            "driving_licence_number": null,
            "driving_licence_status": null,
            ...
        }
    ],
    "first": {
        "$ref": "https://matt.quotevineapp.com/qvine/quotevine/api/v2/relationships/2300191/drivers/"
    }
}

PUT - Update an existing driver

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

Example Payload

PUT

{
    "forename":"Joe",
    "surname":"Bloggs",
    "email_address":"[email protected]",
    "driving_licence_status":"Live"
}

Response

400
​

Returned if the request sent is invalid.

404
​

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

200
Returned if the request is successful.

Expand to see example of a successful response.

A successful PUT request will not return a response object.

{}

Driver Attributes

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

Mandatory Fields

Expand to see the list of mandatory fields

forename - string

surname - string

Non- mandatory Fields

Expand to see the list of non-mandatory fields

driver_id - number
Must not be supplied when using POST or 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 Articles
Relationships Search v2
Address Object v2
Contact Object v2
Contact Address Object v2
Proposal Object v2
Did this answer your question?