BeMapAPI
BeMap 4.1.0

EV reachable area Show how far an electric vehicle can go

BeMap name: EV reachable area

POST/evreachablearea/1.0

Part of EV reachable areaBeMap's service page

The area an electric vehicle can reach from its start point with the charge it has, as a shape to draw on a map.

The whole description

Use it to show a driver which destinations are within range before a trip, or which places a fleet can serve without charging.

In BeMap's words

Perform a calculation of reachable area dedicated to electrical vehicle. This service return a geometry of area.

Perform a calculation of reachable area dedicated to electrical vehicle. This service return a geometry of area.

Provisioned per account. This service is enabled per account; without it BeMap answers 400 with Access Denied.

Request body

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

  • vehiclestringrequired

    Vehicle model (UUID key).

  • temperatureinteger (int32)required

    Temperature in Celsius.

  • startLonnumber (double)required

    Departure longitude in decimal degrees (WGS84).

    Also accepted as longitude.

  • startLatnumber (double)required

    Departure latitude in decimal degrees (WGS84).

    Also accepted as latitude.

  • geoserverstring

    Geoserver name.

  • swidxinteger (int32)deprecated

    Switch index.

  • initBatLvlnumber (double)

    Initial battery level in percent. Available value 0 to 100. 100% if not defined.

  • weatherboolean

    Enable the weather information.

  • wpstring

    Enable the weather information.

  • payloadinteger (int32)

    Vehicle's extra load (consumables or passengers weight for example) (in kg). 75kg by default.

  • extraPayloadinteger (int32)deprecated

    Additional load weight in kg (like passengers, luggage or tools). Deprecated and not supported anymore, use the payload field.

    Also accepted as extraPayLoad.

  • criteriasenum[]

    This field is a list of criteria used by the routing calculator, e.g.: "AVOID_MOTORWAYS", "AVOID_TOLLS".

    7 accepted values
    AVOID_FERRIESFind a route with no ferry.
    AVOID_MOTORWAYSFind a route without motorways.
    AVOID_TOLLSFind a route with no toll.
    AVOID_UNPAVEDFind a route with no unpaved roads.
    AVOID_CROSSING_BORDERFind a route without country border crossing (makes sence only when the start and stop points are in the same country).
    LESS_EXPENSIVEFind the less expensive charging stations. Only with algorithm v2. Deprecated.
    TRAFFICUse traffic info for route calculation.
  • stopLonnumber (double)

    Arrival longitude in decimal degrees (WGS84).

  • stopLatnumber (double)

    Arrival latitude in decimal degrees (WGS84).

  • geoboolean

    Set to true to enable the geometry of the reachable area's polygon. By default true.

  • egeoboolean

    Set to true to enable the encoded geometry of the reachable area's polygon. By default false. See Google Encoded Polyline Algorithm Format in glossary.

Response

200, schema EvReachableAreaResponse.

Response fields
  • boundingBoxBoundingBox

    The bounding box of the returned polygon geometry.

    BoundingBox fields
    • minLonnumber (double)

      Minimum longitude, in degrees decimal (WGS84).

    • minLatnumber (double)

      Minimum latitude, in degrees decimal (WGS84).

    • maxLonnumber (double)

      Maximum longitude, in degrees decimal (WGS84).

    • maxLatnumber (double)

      Maximum latitude, in degrees decimal (WGS84).

  • geometryCoordinate[]

    The reachable area's polygon geometry defined as a list of WGGS84 coordinates.

    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.

  • encodedGeometrystring

    The reachable area's polygon geometry encoded with Google Algorithm.

Errors

  • 400 Bad Request, ErrorResponse
  • 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.

Reference pages