BeMapAPI
BeMap 4.1.0
API reference: GET /evsmartrouting/vehiclemodels/list/1.0 POST /evsmartrouting/vehiclemodels/list/1.0

REST API, Service version 1.0.0

EV vehicles#

List of electrical vehicle model.

DEPRECATED API: please use the Find vehicle API of Vehicle Service.

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#

  • vehiclestring

    Vehicle id (uuid key).

  • brandIdstring

    EV vehicle brand ID.

  • namestring

    Vehicle model name.

  • batteryNamestring

    Battery name.

  • batteryCapacitystringdeprecated

    Battery capacity.

  • yearstring

    Year of release and end of series in format yyyy or yyyy-yyyy.

  • motorTypeenum

    Define the type of motor (engine), is an electric or PHEV motor.

    3 accepted values
    EVElectric Vehicle.
    HEVHybrid Electric Vehicle.
    PHEVPlug-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.

  • coordinateCoordinate

    WGS84 coordinate. Used to filter vehicle data such as available connectors in this country.

    Coordinate 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#

Details of fields#

  • vehiclesVehicleInfo[]

    A list of vehicle information.

    VehicleInfo fields
    • 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.

    • titlestringdeprecated

      Title 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.

    • motorTypeenum

      Motor type of vehicle.

      4 accepted values
      EVElectric Vehicle.
      HEVHybrid Electric Vehicle.
      PHEVPlug-in Hybrid Electric Vehicle (with electric plug).
      NOT_SUPPORTED_VALUENot supported value for this API version.
    • batteryNamestring

      The commercial name or power of vehicle battery.

    • connectorTypesinteger (int32)[]

      List of default connector types defined by the server vehicle profile.

    • encDatasheetstring

      Base64 encoded and encrypted JSON that contains the vehicle datasheet.

    • 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.

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
            ]
        }
	]
}