Path Parameters
HTTP Header
api-key REQUIRED string - Your Accelerate API Key | URL Substitution
subdomain REQUIRED
relationship ID REQUIRED
driver ID OPTIONAL |
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
Expand to see example of a successful response. { |
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
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
Expand to see the list of mandatory fields
forename - string
surname - string
Non- mandatory Fields
Expand to see the list of 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