BeMapAPI
BeMap 4.1.0
API reference: GET /vehicle/1.1/findvehicles POST /vehicle/1.1/findvehicles

REST API, Service version 1.1.0

Find vehicles · v1.1#

To retrieve vehicles or vehicle information.

Find vehicles#

Returns the list of available vehicles. HTTP method GET or POST. URI: /bgis/service/vehicle/1.1/findvehicles

Parameters:

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

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

Details of fields#

  • 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.
  • 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
    PEDESTRIANPedestrian.
    BICYCLEBicycle.
    MOTORCYCLEMotorcycle.
    CARPassenger car, tourist car.
    TAXITaxi.
    PUBLIC_BUSPublic bus.
    EMERGENCYEmergency vehicle.
    DELIVERY_TRUCKDelivery truck.
    TRUCKTruck.
  • 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.

VehicleDatasheet

The fields are listed with the operation: Find vehicles (GET) · v1.1, Find vehicles (POST) · v1.1.

Response samples#

JSON Sample:

javascript
{
    "vehicles": [
        {
            "key": "8724c12d-1ec8-426f-af2a-84ac1a030001",
            "brandId": "609a4642c9cb5b0b1846c129",
            "brandName": "Fiat",
            "name": "500e",
            "year": "2020",
            "variant": "Action, Action plus",
            "motorType": "EV",
            "batteryName": "24",
            "connectorTypes": [
                32,
                38,
                48
            ],
            "chargerPowerAcSinglePhase": 7.0,
            "chargerPowerAcThreePhases": 11.0,
            "chargerPowerDC": 50.0
        },
        {
            "key": "b8527b78-6240-4a32-8d23-66ccbdd10def",
            "brandId": "609a4642c9cb5b0b1846c129",
            "brandName": "Fiat",
            "name": "500e",
            "year": "2020",
            "variant": "Icône, Icône plus, La prima",
            "motorType": "EV",
            "batteryName": "42",
            "connectorTypes": [
                32,
                38,
                48
            ],
            "chargerPowerAcSinglePhase": 7.0,
            "chargerPowerAcThreePhases": 11.0,
            "chargerPowerDC": 85.0
        },
        {
            "key": "444720e1-4591-42e2-bec2-b6f5d3351909",
            "brandId": "609a4642c9cb5b0b1846c129",
            "brandName": "Fiat",
            "name": "500e US",
            "year": "2013",
            "motorType": "EV",
            "batteryName": "24",
            "connectorTypes": [
                31
            ],
            "chargerPowerAcSinglePhase": 6.6
        },
        {
            "key": "4d7be666-6f01-4fe8-bb92-e478beb0e5f3",
            "brandId": "609a4642c9cb5b0b1846c129",
            "brandName": "Fiat",
            "name": "e-Ducato",
            "motorType": "EV",
            "batteryName": "47",
            "connectorTypes": [
                32,
                38,
                48
            ],
            "chargerPowerAcSinglePhase": 7.0,
            "chargerPowerDC": 50.0
        }
    ]
}