You create your own Atlas URI by starting with the base URI for Atlas (the base address). You can then use parameters to define the location, zoom level, map view, searches, directions, and more.
Building an Atlas URI
Start with the base address
http://atlas.freshlogicstudios.com/
Add a question mark (?).
http://atlas.freshlogicstudios.com/?
Add the first parameter you want to use, and set the value of the parameter by using an equal sign (=).
http://atlas.freshlogicstudios.com/?style=a
Add the other parameters that you want to use, separating each parameter with an ampersand (&).
http://atlas.freshlogicstudios.com/default.aspx?style=a&lvl=10
The following tables list the parameters currently supported by the Atlas URI application programming interface (API).
General map parameters
| Parameter |
Definition |
Data type |
Details |
| cp |
Center point |
Double~Double |
Defines the center point of the map. Use the following format for the cp parameter: Latitude~Longitude. Both values must be expressed in decimal degrees and use the WGS84 datum. |
| lvl |
Level |
Integer |
Defines the zoom level (map scale). Valid values are 1–19. This parameter is ignored if you omit the cp parameter. |
| style |
Map view |
String |
Defines the map view. Valid values for this parameter are a (for the aerial photo map view), r (for the road map view), h (for the aerial map view with labels), and o for bird's eye (oblique) images. Note: if you set the view to o, you must also provide the scene parameter. |
General examples
This example opens Atlas with the map centered on a specific location with a zoom level of 12, and sets the map view to the road map view:
http://atlas.freshlogicstudios.com/?cp=43.901683~-69.522416&lvl=12&style=r
This example opens Atlas with the map centered on a specific location, uses the bird's eye (oblique) image map view, and specifies the zoom level and scene to use:
http://atlas.freshlogicstudios.com/?cp=47.644209~-122.140437&style=o
Search parameters
| Parameter |
Definition |
Data type |
Details |
| ss |
Search string |
String |
Defines the searches that you want to display in one or more search results panels. Separate multiple search strings with a tilde (~). If you use a tilde in a search string, the tilde is automatically converted to a space. You can include a maximum of three search strings, each containing up to 100 characters. |
| where1 |
Location string |
String |
Defines the location on which to center the map. This parameter represents the text that a user types in the where field of the search form in Atlas. The string can represent an address or a place name. This parameter takes precedence over the cp parameter. |
Search Examples
This example opens Atlas to a specific address:
http://atlas.freshlogicstudios.com/?where1=One%20Microsoft%20Way,%20Redmond,%20WA%2098052
This example opens Atlas with three search panels:
http://atlas.freshlogicstudios.com/?ss=Pizza~Beer~Bowling
This example opens Atlas with three search panels and centers the map on a landmark:
http://atlas.freshlogicstudios.com/?ss=Pizza~Beer~Bowling%20Alley&where1=Space%20Needle
Driving directions parameters
| Parameter |
Definition |
Data type |
Details |
| rtp |
Route |
String |
Defines the waypoints of a route to draw on the map. The route is defined as a series of waypoints, each separated by a tilde (~). Each waypoint is defined by either a pos (position) or adr (address) identifier, described in the next table. A complete route contains at least two waypoints. For example, a route with two waypoints is defined by the following pattern:
rtp=”A”~”B”.
You can also specify an incomplete route. For example, you can define only the start of a route:
rtp=”A”~
or the end of a route:
rtp=~”B”
If you provide only one waypoint, the driving directions panel is displayed with the provided waypoint, but no route is drawn.
|
| Identifier |
Definition |
Details |
| pos (used with the rtp parameter) |
Position |
Defines a waypoint as a specific position on the map. Use the following format:
rtp=pos.latitude_longitude_name
|
| adr (used with the rtp parameter) |
Address |
Defines a waypoint as an address. Use the following format:
rtp=adr.address
|
Driving directions examples
The following example displays a route on the map from a specific address to a specific point:
http://atlas.freshlogicstudios.com/?rtp=adr.One%20Microsoft Way,%20Redmond,%20WA%2098052~pos.45.23423_-122.1232_MyPlace
The following example opens the driving directions panel with a start address only:
http://atlas.freshlogicstudios.com/?rtp=adr.Seattle, WA