Sample Response
V1
Documentation
Introduction
This endpoint returns a structured description, battery size (actual and usable) and availability information for an electric van.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://bjbiy52iua.execute-api.eu-west-2.amazonaws.com/dev/evdatabase/uk/van/coredata/?evdb_vehicle_id=1234
Example Sandbox Request
https://bjbiy52iua.execute-api.eu-west-2.amazonaws.com/dev/evdatabase/uk/van/coredata/?evdb_vehicle_id=1234&sandbox=1
Request Parameters
evdb_vehicle_id
mandatory, string, e.g. 1234
EV Database Vehicle ID
Sample Response
{
"success": true,
"result": {
"evdb_vehicle_id": 12345,
"manufacturer_desc": "Fiat",
"model_range_desc": "Ducato",
"model_desc": "H2",
"model_length_desc": "M",
"model_height_desc": "H2",
"derivative_desc": "47 kWh",
"gross_vehicleweight_desc": "3.5T",
"body_type_desc": "PanelVan",
"battery_capacity_usable_kwh": 42,
"battery_capacity_kwh": 47,
"is_battery_capacity_estimated": true,
"availability_status": "Vehicle currently available to order in market / region",
"introduced_date": "2020-01-01",
"is_introduced_date_estimated": false,
"discontinued_date": "2022-01-01",
"evdb_fuel_type_desc": "BEV",
"successor_evdb_vehicle_id": 23456
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
evdb_vehicle_id
e.g. 12345
EV Database Vehicle ID
manufacturer_desc
e.g. Fiat
Manufacturer description
model_range_desc
e.g. Ducato
Model range description.
model_desc
e.g. H2
Model description.
model_length_desc
e.g. M
The model length description
model_height_desc
e.g. H2
The model height description
derivative_desc
e.g. 47 kWh
Derivative description.
gross_vehicleweight_desc
e.g. 3.5T
The gross vehicle weight description
body_type_desc
e.g. PanelVan
The body type description
battery_capacity_usable_kwh
e.g. 42
Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh
battery_capacity_kwh
e.g. 47
Battery capacity in kwh
is_battery_capacity_estimated
e.g. true
Is the battery capacity based on an estimate?
availability_status
e.g. Vehicle currently available to order in market / region
Vehicle's UK availability status
introduced_date
e.g. 2020-01-01
The date the vehicle was available in the market from
is_introduced_date_estimated
e.g. false
Is the date the vehicle was available in the market from estimated?
discontinued_date
e.g. 2022-01-01
The date the vehicle was available to in the market
evdb_fuel_type_desc
e.g. BEV
EV Database fuel type description
successor_evdb_vehicle_id
e.g. 23456
The related EV Database Vehicle ID
error
e.g. If there is an error the message would go here
Details of what went wrong with the api call
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com