BeMapAPI
BeMap 4.1.0

Roads extractor Get every road in a zone

BeMap name: Roads extractor

POST/roadsextractor/1.0

Part of Roads extractorBeMap's service page

All the road segments inside a zone you draw, for a type of vehicle, to plan a round that covers the whole zone.

The whole description

In BeMap's words

Extract the roads information process for a specified type of vehicle within a specified polygon.

Extract the roads information process for a specified type of vehicle within a specified polygon.

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

  • coordinatesCoordinate[]required

    List of coordinates of the polygon.

    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.

  • geoserverstring

    Geoserver name.

  • swidxinteger (int32)deprecated

    Switch index.

  • outputLanguagestring

    Define the language that will be used to perform the address lookup. Objects for which defined language code is not available, the default language will be used. A US-ASCII string that defines an ISO 639-1 (2-letter) language code. The special "IC" (or "ic") language code allows you to search for a country depending on its ISO-3166 Alpha-3 or Alpha-2 country code.

  • transportTypeenum

    Transportation mode. CAR by default.

    9 accepted values
    PEDESTRIANPedestrian.
    BICYCLEBicycle.
    MOTORCYCLEMotorcycle.
    CARPassenger car.
    TAXITaxi.
    PUBLIC_BUSPublic bus.
    EMERGENCYEmergency vehicle.
    DELIVERY_TRUCKDelivery truck. Deprecated, use TRUCK instead.
    TRUCKTruck.
  • classIdFiltersstring[]

    List of road network class ID to filter by. A class ID can be a number e.g. 4000 or an enumeration string e.g. ROAD_FOURTH). No filtering by default. List of available class ID.

  • adminPathboolean

    Set this flag to true if you want to retrieve the complete hierarchical path of each ExtractedRoadFront. This option is required to get the postal addresses.

  • filterElementsHouseNumbersboolean

    Set to true to filter road elements with house numbers only.

  • filterClippedElementsboolean

    Set this flag to true if you want to filter out elements which are not fully inside the polygon.

Response

200, schema RoadsExtractorResponse.

Response fields
  • roadsExtractedRoadFront[]

    List of extracted road information.

    ExtractedRoadFront fields
    • coordinateCoordinate

      The coordinate around the middle of the extracted road.

      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.

    • angleinteger (int32)

      Angle associated with the coordinate of the extracted road. This angle defines the direction this point has to be reached should you use these points to perform a route calculation or trip optimization.

    • labelstring

      Label of the road.

    • postalAddressAddress

      Postal address of the extracted road.

      Address fields
      • countryCodestring

        ISO code of country.

      • countrystring

        Country name.

      • statestring

        State name.

      • countystring

        County name.

      • citystring

        City name.

      • districtstring

        District name of city.

      • postalCodestring

        Postal code.

      • roadNumberstring

        Road number.

      • streetstring

        Street name.

      • streetNumberstring

        House number.

      • oppositeStreetNumberstringdeprecated

        Opposite street number.

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