Class: ChargingStationSearchRequest

bemap.ChargingStationSearchRequest(optionsopt)

new ChargingStationSearchRequest(optionsopt)

BeNomad BeMap JavaScript API - ChargingStationSearchRequest (v1.5) Strongly-typed request builder for `POST service/chargingstation/search/1.0`. Wire shape cross-checked against the BeMap server contract in `bemap_idea/.../service/v1_0_0/model/chargingStation/ChargingStationSearchRequest.java` and verified live on `bemap-beta.benomad.com`. Required: at least one provider name (`providers`) AND one spatial selector — `coordinate` + `radius`, `corridor` + `radius`, or `boundingBox`. Example — circular search around Paris: var req = new bemap.ChargingStationSearchRequest({ providers: ['ecoMovement'], coordinate: new bemap.Coordinate(2.35, 48.85), radius: 2000, maxPoolResult: 25, options: [bemap.ChargingStationOption.PATH_POOL_MAP] });
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Default Description
mode bemap.ChargingStationMode <optional>
 LOCAL_OR_REMOTE
options Array.<bemap.ChargingStationOption> <optional>
pathAutoMaxPool Number <optional>
 20 When the `PATH_AUTO` option is used, drop to point-level depth as soon as the result count is below this threshold.
providers Array.<String> Provider names (e.g. `'ecoMovement'`). Only names exposed by the current user's ACL are accepted server-side.
coordinate bemap.Coordinate | bemap.CoordinateSat | Object <optional>
 Search centre. Required with `radius` unless `corridor` or `boundingBox` is set.
corridor Array.<bemap.Coordinate> <optional>
 Polyline corridor around which to search. Mutually exclusive with `coordinate` and `boundingBox`.
radius Number <optional>
 Search radius in meters. Required with `coordinate` or `corridor`.
boundingBox bemap.BoundingBox <optional>
 Rectangular search window. Mutually exclusive with `coordinate` and `corridor`.
maxPoolResult Number <optional>
 Max pools in the response.
maxProviderResult Number <optional>
 Max items the server fetches from each provider.
connectorIdFilters Array.<Number> <optional>
 Connector type IDs to keep.
poolIdFilter String <optional>
 Restrict result to a single pool by ID.
stationIdFilter String <optional>
 Restrict result to a single station by ID.
pointIdFilter String <optional>
 Restrict result to a single charging point by ID.
filtersVersion Number <optional>
 1 Filter engine version. Server default is 1.
filters Array.<String> <optional>
 Filter expressions — see BeMap docs.
language String <optional>
 ISO 639-1 language for address fields.
geoserver String <optional>
 Override the Context's geoserver for this call.
Since:
  • 1.5.0
Source:

Methods

toJson() → {Object}

Serialise the request to the JSON shape consumed by the BeMap server. Null / empty fields are dropped so the payload stays minimal.
Source:
Returns:
Type
Object