X4 Produktdokumentation

Bing Maps (deprecated)

The adapter accesses Bing Maps via its web service interface in version 1 and retrieves the geographic information for an address. In addition, a route including waypoints can be calculated and a URL to a Bing Maps map section can be generated. The adapter returns its results as an XML or JSON document.

To use the Bing Maps API, a Bing Maps API key is required.

Properties

Operation

Describes which operation the adapter performs.

Possible values:

  • Geocode: Determine all geoinformation for an address (address, district/country, nation, coordinates, etc.)

  • ReverseGeocode: Determin all geoinformation for a decimal coordinate (address, district/country, nation, coordinates, etc.)

  • GetDirections: Determine the route between a start and finish point with any number of waypoints

  • CreateBingURL: URL to a Bing Maps web service

Parameters

Adapter

Main class of the adapter (do not change!)

Possible values: de.softproject.integration.adapter.geo.microsoft.BingMapsAdapter : Main class (default)

BingMapsKey

Key to use the Bing Maps API

OutputFormat

Define the output format for requests

Possible values:

  • xml: Outputs an XML document

  • json: Outputs an JSON document

timeout

Time limit for establishing a connection in milliseconds

Possible values:

  • Any integer

  • 0: No time limit

  • 20000: Cancel the connection establishmen after 20 seconds

pxHost

IP address or host name of the IMAP server

Possible values: Any valid string (e.g. 192.168.1.1)

pxPort

Port number of the proxy server

Possible values: Any integer

pxLogin

User name for the proxy server

Possible values: Any string

pxPwd

Password for the proxy server

Possible values: Any string

Status values

1 (successful)

The request was successful and a result was returned (corresponds to HTTP status code 200)

0 (empty)

The request was successful, but no result was returned

-1 (failed)

The request failed due to a technical error.

HTTP status code

The request was executed, but ended with a status code other than 200. Error interpretation according to the HTTP status code.