# EV vehicles

REST API, Service version 1.0.0

> API reference: [`GET /evsmartrouting/vehiclemodels/list/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-vehiclemodels-list-get.md), [`POST /evsmartrouting/vehiclemodels/list/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-vehiclemodels-list-post.md)

List of electrical vehicle model.

__DEPRECATED API__: please use the [Find vehicle API of Vehicle Service](https://benomad.com/dev/doc/bemap-api/guides/services/vehicle-findvehicles-v1-1.md).

## Summary
1. Request
 1. Parameters
2. Response
 1. Details of fields
 2. Response samples

## Request
The request must be sent with the HTTP method `GET`.
If you want to use the HTTP method `POST` add the HTTP header `Content-Type` set to `application/json`.

Sample:
URI: `/bgis/service/evsmartrouting/vehiclemodels/list/1.0`

### __Parameters__

- `vehicle` (string): Vehicle id (uuid key).
- `brandId` (string): EV vehicle brand ID.
- `name` (string): Vehicle model name.
- `batteryName` (string): Battery name.
- `batteryCapacity` (string, deprecated): Battery capacity.
- `year` (string): Year of release and end of series in format yyyy or yyyy-yyyy.
- `motorType` (enum): Define the type of motor (engine), is an electric or PHEV motor.
  - `EV`: Electric Vehicle.
  - `HEV`: Hybrid Electric Vehicle.
  - `PHEV`: Plug-in Hybrid Electric Vehicle (with electric plug).
- `chargerPowerDC` (number (double)): DC Power in kW of vehicle charger.
- `chargerPowerAC` (number (double)): AC Power in kW of vehicle charger.
- `enableDatasheet` (boolean): Enable the returned datasheet of vehicle. See field encDatasheet.
- `coordinate` (Coordinate): WGS84 coordinate. Used to filter vehicle data such as available connectors in this country.
  - `lon` (number (double), required): Longitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `longitude`.
  - `lat` (number (double), required): Latitude in degrees decimal ([WGS84](https://benomad.com/dev/doc/bemap-api/guides/reference/glossary-coordinate-system.md)). Also accepted as `latitude`.
- `countryCode` (string): ISO-3 country code. Used to filter vehicle data such as available connectors in this country.

## Response

### Details of fields

- `vehicles` (VehicleInfo[]): A list of vehicle information.
  - `key` (string): Key of vehicle, used to select the vehicle to perform the routing calculation.
  - `brandId` (string): Brand ID of vehicle, can be used for display.
  - `brandName` (string): Brand name of vehicle, can be used for display.
  - `title` (string, deprecated): Title of vehicle, can be used for display.
  - `name` (string): Name of vehicle, can be used for display.
  - `year` (string): Year of release and end of series in format yyyy or yyyy-yyyy.
  - `variant` (string): Variant or sub name of vehicle.
  - `motorType` (enum): Motor type of vehicle.
    - `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.
  - `batteryName` (string): The commercial name or power of vehicle battery.
  - `connectorTypes` (integer (int32)[]): List of default connector types defined by the server vehicle profile.
  - `encDatasheet` (string): Base64 encoded and encrypted JSON that contains the vehicle datasheet.
  - `chargerPowerAcSinglePhase` (number (double)): Maximum charge power (in kW) in AC 1 phase current type.
  - `chargerPowerAcThreePhases` (number (double)): Maximum charge power (in kW) in AC 3 phases current type.
  - `chargerPowerDC` (number (double)): Maximum charge power (in kW) in DC current type.

### Response samples
JSON Sample:
```javascript
{
    "vehicles":[
        {
            "key":"8724c12d-1ec8-426f-af2a-84ac1a030001",
            "title":"500e 24.0kWh DC:50.0kW AC3:11.0kW",
            "connectorTypes":[
                32,
                38,
                48
            ]
        },
        {
            "key":"b8527b78-6240-4a32-8d23-66ccbdd10def",
            "title":"500e 42.0kWh DC:85.0kW AC3:11.0kW",
            "connectorTypes":[
                32,
                38,
                48
            ]
        },
        {
            "key":"444720e1-4591-42e2-bec2-b6f5d3351909",
            "title":"500e US 24.0kWh AC1:6.6kW",
            "connectorTypes":[
                31
            ]
        },
        {
            "key":"d65b5971-9fc4-4903-b187-96b1530335d4",
            "title":"Ami 5.5kWh AC1:2.3kW",
            "connectorTypes":[
                48
            ]
        }
	]
}
```