Bing Maps
Status: Preview |
Tier: Standard |
Version: 1.0.0 |
Name |
Summary |
Get route |
|
Get location by point |
|
Get location by address |
|
Get static map |
|
Get static map |
Name |
Summary |
Name |
Summary |
|
|
|
Summary: Get route
Description: Calculate a route using waypoints.
Syntax:
BingMaps.GetRoute (string wp.0, string wp.1, [Optional]string avoid, [Optional]string optimize, [Optional]string distanceUnit, [Optional]string travelMode, [Optional]string dateTime, [Optional]string timeType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
wp.0 |
string (Waypoint 1) |
Specified as a point, landmark, or address. (47.610,-122.107 or Seattle, WA) |
True |
|
wp.1 |
string (Waypoint 2) |
Specified as a point, landmark, or address. (47.610,-122.107 or Seattle, WA) |
True |
|
avoid |
string (Avoid) |
A comma-separated list of values from the following list (highways, tolls, minimizeHighways, minimizeTolls). |
False |
|
optimize |
string (Optimize)Values: [distance, time , timeWithTraffic, timeAvoidClosure] |
Specifies what parameters to use to optimize the route. |
False |
|
distanceUnit |
string (Distance unit)Values: [Mile, Kilometer] |
The units to use for distance in the response. Default: Kilometer |
False |
|
travelMode |
string (Travel mode)Values: [Driving, Walking, Transit] |
The mode of travel for the route. Default: Driving |
False |
|
dateTime |
string (Transit Date-Time) |
Required when the travel mode is transit. Identifies the desired transit time, such as arrival time or departure time. |
False |
|
timeType |
string (Transit Date-Time Type)Values: [Arrival, Departure, LastAvailable] |
Required when the travel mode is transit. Specifies how to interpret the transit date-time value. |
False |
Returns:
Type:GetRoute_Response
Summary: Get location by point
Description: Get the location information associated with latitude and longitude coordinates.
Syntax:
BingMaps.GetLocationByPoint (number latitude, number longitude, [Optional]string includeEntityTypes, [Optional]boolean includeNeighborhood, [Optional]boolean include)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
latitude |
number(double) (Point Latitude) |
The latitude coordinate you want to reverse geocode. Example: 47.64054 |
True |
|
longitude |
number(double) (Point Longitude) |
The longitude coordinate you want to reverse geocode. Example: -122.12934 |
True |
|
includeEntityTypes |
string (Include Entity Types) |
The entity types that you want to return in the response. |
False |
|
includeNeighborhood |
boolean (Include Neighborhood) |
A value determining whether or not to include the neighborhood in the response when it is available. 0 or 1 |
False |
|
include |
boolean (Include Country Code) |
A value determining whether or not to include the two-letter ISO country code. ciso2 |
False |
Returns:
Type:GetLocation_Response
Summary: Get location by address
Description: Get the location information associated with an address. If no location is found, an empty result will be returned.
Syntax:
BingMaps.GetLocationByAddress ([Optional]string addressLine, [Optional]string locality, [Optional]string adminDistrict, [Optional]string postalCode, [Optional]string countryRegion)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
addressLine |
string (Address line) |
A string specifying the street line of an address (not including city, country region, etc). |
False |
|
locality |
string (Locality (City)) |
A string that contains the locality, such as a US city. |
False |
|
adminDistrict |
string (Admin district (State)) |
A string that contains a subdivision, such as the abbreviation of a US state. |
False |
|
postalCode |
string (Postal code) |
A string that contains the postal code, such as a US ZIP Code. |
False |
|
countryRegion |
string (Country region) |
A string specifying the ISO country code. |
False |
Returns:
Type:GetLocation_Response
Summary: Get static map
Description: Get static map.
Syntax:
BingMaps.GetMap (string latitude, string longitude, string imagerySet, string zoomLevel, [Optional]string format, [Optional]string mapSize, [Optional]string pushpin)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
latitude |
string (Point latitude) |
The latitude coordinate you want to reverse geocode. Example: 47.64054 |
True |
|
longitude |
string (Point longitude) |
The longitude coordinate you want to reverse geocode. Example: -122.12934 |
True |
|
imagerySet |
string (Imagery set)Values: [Aerial, AerialWithLabels, CanvasDark, CanvasLight, CanvasGray, Road] |
The type of imagery. |
True |
|
zoomLevel |
string (Zoom level) |
The level of zoom to display between 0 and 21. Default 10 |
True |
|
format |
string (Image format)Values: [gif, jpeg, png] |
The image format to use for the static map. |
False |
|
mapSize |
string (Map size) |
The width and height in pixels of the static map output. Example: 1000,600. |
False |
|
pushpin |
string (Pushpin) |
Point value (latitude and longitude) with options to add a label of up to three (3) characters and to specify an icon style. Example: 47.610,-122.107;5;P10 (more information https://aka.ms/u8b8aq). |
False |
Returns:
Type:string(binary)
Summary: Map Image
Summary: Get static map
Description: Get static map.
Syntax:
BingMaps.GetMapV2 (number latitude, number longitude, string imagerySet, string zoomLevel, [Optional]string format, [Optional]string mapSize, [advanced][Optional]number pushpinLatitude, [advanced][Optional]number pushpinLongitude, [advanced][Optional]integer pushpinIconStyle, [advanced][Optional]string pushpinLabel)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
latitude |
number(double) (Point latitude) |
The latitude coordinate you want to reverse geocode. Example: 47.64054 |
True |
|
longitude |
number(double) (Point longitude) |
The longitude coordinate you want to reverse geocode. Example: -122.12934 |
True |
|
imagerySet |
string (Imagery set)Values: [Aerial, AerialWithLabels, CanvasDark, CanvasLight, CanvasGray, Road] |
The type of imagery. |
True |
|
zoomLevel |
string (Zoom level) |
The level of zoom to display between 0 and 21. Default 10 |
True |
|
format |
string (Image format)Values: [gif, jpeg, png] |
The image format to use for the static map. |
False |
|
mapSize |
string (Map size) |
The width and height in pixels of the static map output. Example: 1000,600. |
False |
|
pushpinLatitude |
number(double) (Pushpin latitude) |
Specify pushpin latitude (more information https://aka.ms/u8b8aq). |
False |
|
pushpinLongitude |
number(double) (Pushpin longitude) |
Specify pushpin longitude (more information https://aka.ms/u8b8aq). |
False |
|
pushpinIconStyle |
integer (Pushpin icon style) |
Specify pushpin icon style (more information https://aka.ms/u8b8aq). |
False |
|
pushpinLabel |
string (Pushpin label) |
Specify a label of up to three (3) characters (more information https://aka.ms/u8b8aq). |
False |
Returns:
Type:string(binary)
Summary: Map Image
Summary:
Description:
Properties:
Name |
Type |
Summary |
address |
Address |
address |
confidence |
string Confidence |
The confidence of the match. |
entityType |
string Entity Type |
A type of location. Examples include PopulatedPlace and Monument. |
name |
string Name |
|
point |
Point |
point |
Summary: Address
Description: address
Properties:
Name |
Type |
Summary |
addressLine |
string Line |
The official street line of an address. |
countryRegion |
string Country Region |
Country or region name of an address. |
countryRegionIso2 |
string Country Region ISO 2 |
The two-letter ISO country code. |
formattedAddress |
string Formatted Address |
A string specifying the complete address. |
postalCode |
string Postal Code |
The post code, postal code, or ZIP Code of an address. |
Summary: Point
Description: point
Properties:
Name |
Type |
Summary |
coordinates |
coordinates |
coordinates |
type |
string Type |
type |
Summary: coordinates
Description: coordinates
Properties:
Name |
Type |
Summary |
latitude |
number(float) Latitude |
The latitude point that was used for the location. |
longitude |
number(float) Longitude |
The longitude point that was used for the location. |
combined |
string Combined |
Comma separated latitude and longitude values. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
distanceUnit |
string Distance Unit |
The unit used for distance. |
durationUnit |
string Duration Unit |
The unit used for time of travel. |
routeLegs |
|
|
trafficCongestion |
string Traffic Congestion |
|
trafficDataUsed |
string Traffic Data Used |
|
travelDistance |
number(float) Travel Distance |
The physical distance covered by the entire route. |
travelDuration |
integer(int32) Travel Duration |
The time that it takes, in seconds, to travel a corresponding travel distance. |
travelDurationTraffic |
integer(int32) Travel Duration Traffic |
The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
actualEnd |
Actual End |
|
actualStart |
Actual Start |
|
description |
string Description |
A short description of the route. |
endLocation |
End Location |
|
routeRegion |
string Region |
routeRegion |
startLocation |
Start Location |
|
Summary: Actual End
Description:
Properties:
Name |
Type |
Summary |
coordinates |
Coordinates |
|
type |
string Type |
|
Summary: Coordinates
Description:
Properties:
Name |
Type |
Summary |
latitude |
number(float) Latitude |
The latitude point that was used as the actual ending location for the route leg. |
longitude |
number(float) Longitude |
The longitude point that was used as the actual ending location for the route leg. |
combined |
string Combined |
Comma separated latitude and longitude values. |
Summary: Actual Start
Description:
Properties:
Name |
Type |
Summary |
coordinates |
Coordinates |
|
type |
string Type |
|
Summary: Coordinates
Description:
Properties:
Name |
Type |
Summary |
latitude |
number(float) Latitude |
The latitude that was used as the actual starting location for the route leg. |
longitude |
number(float) Longitude |
The longitude that was used as the actual starting location for the route leg. |
combined |
string Combined |
Comma separated latitude and longitude values. |
Summary: End Location
Description:
Properties:
Name |
Type |
Summary |
address |
Address |
|
confidence |
string Confidence |
The confidence of the match. |
entityType |
string Entity Type |
A type of location. Examples include PopulatedPlace and Monument. |
name |
string Name |
|
Summary: Address
Description:
Properties:
Name |
Type |
Summary |
countryRegion |
string Country Region |
Country or region name of an address. |
formattedAddress |
string Formatted Address |
A string specifying the complete address. |
Summary: Start Location
Description:
Properties:
Name |
Type |
Summary |
address |
Address |
|
confidence |
string Confidence |
The confidence of the match. |
entityType |
string Entity Type |
A type of location. Examples include PopulatedPlace and Monument. |
name |
string Name |
name |
Summary: Address
Description:
Properties:
Name |
Type |
Summary |
countryRegion |
string Country Region |
Country or region name of an address. |
formattedAddress |
string Formatted Address |
A string specifying the complete address. |