Find vehicles (POST) · v1.1 Search the electric vehicle database

BeMap name: Find vehicles (POST) · v1.1

POST/vehicle/1.1/findvehicles

The same vehicle search, with its criteria sent in a JSON body rather than in the address.

The whole description

In BeMap's words

Returns the list of available vehicles.

Requires the Vehicle or EV smart routing option. Allow to get the information of vehicle. Not enabled on your account? Ask your BeNomad contact.

Request body

JSON, Content-Type: application/json. Schema VehicleRequestV1Dot1.

geoserverstring
Geoserver name.
vehiclestring
Vehicle id (uuid key).
brandIdstring
EV vehicle brand ID.
namestring
Vehicle model name.
variantstring
Vehicle model variant name.
yearstring
Year of release and end of series in format yyyy or yyyy-yyyy.
batteryNamestring
Battery name.
batteryCapacitystringdeprecated
Battery capacity.
motorTypeenum
Define the type of motor (engine), is an electric or PHEV motor.
3 accepted values
EV Electric Vehicle.
HEV Hybrid Electric Vehicle.
PHEV Plug-in Hybrid Electric Vehicle (with electric plug).
chargerPowerDCnumber (double)
DC Power in kW of vehicle charger.
chargerPowerACnumber (double)
AC Power in kW of vehicle charger.
enableDatasheetboolean
Enable the returned datasheet of vehicle. See field encDatasheet.
coordinateCoordinateV1Dot1
WGS84 coordinate. Used to filter vehicle data such as available connectors in this country.
CoordinateV1Dot1 fields
- lonnumber (double)required
  Longitude in degrees decimal (WGS84).
  Also accepted as longitude.
- latnumber (double)required
  Latitude in degrees decimal (WGS84).
  Also accepted as latitude.
countryCodestring
ISO-3 country code. Used to filter vehicle data such as available connectors in this country.

Response

200, schema VehicleModelsResponseV1Dot1.

Response fields

vehiclesVehicleInfoV1Dot1[]
A list of vehicle information.
VehicleInfoV1Dot1 fields
- motorTypeenum
  Motor type of vehicle.
  4 accepted values
  EV Electric Vehicle.
  HEV Hybrid Electric Vehicle.
  PHEV Plug-in Hybrid Electric Vehicle (with electric plug).
  NOT_SUPPORTED_VALUE Not supported value for this API version.
- keystring
  Key of vehicle, used to select the vehicle to perform the routing calculation.
- brandIdstring
  Brand ID of vehicle, can be used for display.
- brandNamestring
  Brand name of vehicle, can be used for display.
- namestring
  Name of vehicle, can be used for display.
- yearstring
  Year of release and end of series in format yyyy or yyyy-yyyy.
- variantstring
  Variant or sub name of vehicle.
- transportTypeenum
  Transport type.
  9 accepted values
  PEDESTRIAN Pedestrian.
  BICYCLE Bicycle.
  MOTORCYCLE Motorcycle.
  CAR Passenger car, tourist car.
  TAXI Taxi.
  PUBLIC_BUS Public bus.
  EMERGENCY Emergency vehicle.
  DELIVERY_TRUCK Delivery truck.
  TRUCK Truck.
- heightinteger (int32)
  Height in cm.
- widthinteger (int32)
  Width in cm.
- lengthinteger (int32)
  Length in cm.
- batteryNamestring
  The commercial name or power of vehicle battery.
- chargerPowerAcSinglePhasenumber (double)
  Maximum charge power (in kW) in AC 1 phase current type.
- chargerPowerAcThreePhasesnumber (double)
  Maximum charge power (in kW) in AC 3 phases current type.
- chargerPowerDCnumber (double)
  Maximum charge power (in kW) in DC current type.
- maxWeightinteger (int32)
  Maximum weight in tenth of ton.
- maxWeightPerAxleinteger (int32)
  Maximum weight per axle in tenth of ton.
- connectorTypesinteger (int32)[]
  List of default connector types defined by the server vehicle profile.
- plugAndAutoChargePlugAndAutoChargeFront
  Defines if the vehicle has the AutoCharge capability. AutoCharge is an EV charging technology that enables automatic authentication and initiation of a charging session by recognising a unique identifier from the EV. AutoCharge shares similarities with Plug and Charge (PnC) technology, but there are important distinctions between the two. PnC is a more comprehensive authentication standard, established by the ISO 15118 protocol.
  PlugAndAutoChargeFront fields
  - availablebooleanrequired
    Define if the vehicle has the capability of plug and aotomatic starting the charge. Ture if available.
  - iso15118boolean
    Plug & Charge: The ISO 15118 standard is supported. If Autocharge is OCPP version 2, the ISO 15118 and OCPP can be checked.
  - ocppboolean
    The OCPP standard is supported. The Autocharge use OCPP version 1. If Autocharge is OCPP version 2, the ISO 15118 and OCPP can be checked.
- wltpVehicleWltp
  WLTP information of vehicle.
  VehicleWltp fields
  - urbanWltpnumber (double)
    The WLTP provided by the vehicle manufacturer for an urban cycle. Containing only the first two phases of the complete WLTP cycle.
  - completeWltpnumber (double)
    The WLTP provided by the vehicle manufacturer for a complete cycle. Containing all four phases of WLTP.
- consumptionInWhPerKmnumber (float)
  Vehicle consumption in Wh/km.
- encDatasheetstring
  Base64 encoded and encrypted JSON that contains the vehicle datasheet.

Errors

400 Bad Request, ErrorResponseV1Dot1
302 No credentials were sent. Do not follow the redirect.
401 The account or the API key is wrong.

How to read each one: Errors.

Tutorials

Reference pages

Find vehicles · v1.1

curl -X POST 'https://bemap.benomad.com/bgis/service/vehicle/1.1/findvehicles' \ -u 'YOUR_ACCOUNT:YOUR_API_KEY' \ --fail-with-body \ -H 'Content-Type: application/json' \ -d '{ "brandId": "5e903acb9548987051674126", "name": "Zoe" }'

{ "vehicles": [ { "motorType": "EV", "key": "29b8cbcd-a75e-48db-a29f-c26745013d20", "brandId": "5e903acb9548987051674126", "brandName": "Renault", "name": "Zoe", "year": "2019-2024", "variant": "ZE50 R135", "transportType": "CAR", "height": 156, "width": 179, "length": 409, "batteryName": "54.7", "chargerPowerAcSinglePhase": 7.33, "chargerPowerAcThreePhases": 22, "chargerPowerDC": 46, "maxWeight": 2, "maxWeightPerAxle": 0, "connectorTypes": [ 32, 38 ], "wltp": { "completeWltp": 385 }, "consumptionInWhPerKm": 135.06 }, { "motorType": "EV", "key": "44587c46-88a4-453e-9763-2cfb7a3661f4", "brandId": "5e903acb9548987051674126", "brandName": "Renault", "name": "Zoe", "year": "2017", "variant": "R240", "transportType": "CAR", "height": 156, "width": 173, "length": 408, "batteryName": "22", "chargerPowerAcSinglePhase": 7.33, "chargerPowerAcThreePhases": 22, "maxWeight": 2, "maxWeightPerAxle": 0, "connectorTypes": [ 32 ] } ] }

Write the code that calls the BeMap API operation "Find vehicles (POST) · v1.1": POST https://bemap.benomad.com/bgis/service/vehicle/1.1/findvehicles - Authenticate with HTTP Basic: the BeMap account as the user name, the API key as the password. Do not follow redirects: a 302 means the credentials were not sent. - Send JSON (Content-Type: application/json) of type `VehicleRequestV1Dot1`. - Use only the fields the reference lists: BeMap ignores an unknown field name without an error, so a misspelt field configures nothing. - A 400 with "Access Denied" means the account lacks the Vehicle or EV smart routing option; a 401, a wrong account or key. Reference, with every field and what each value means: https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-findvehicles-v1-1-post.md

`EV`	Electric Vehicle.
`HEV`	Hybrid Electric Vehicle.
`PHEV`	Plug-in Hybrid Electric Vehicle (with electric plug).

`EV`	Electric Vehicle.
`HEV`	Hybrid Electric Vehicle.
`PHEV`	Plug-in Hybrid Electric Vehicle (with electric plug).
`NOT_SUPPORTED_VALUE`	Not supported value for this API version.

`PEDESTRIAN`	Pedestrian.
`BICYCLE`	Bicycle.
`MOTORCYCLE`	Motorcycle.
`CAR`	Passenger car, tourist car.
`TAXI`	Taxi.
`PUBLIC_BUS`	Public bus.
`EMERGENCY`	Emergency vehicle.
`DELIVERY_TRUCK`	Delivery truck.
`TRUCK`	Truck.