Our Linking API

The BlueBadgeParking.com web-API allows you to link directly to any disabled / handicap parking location in our database or any view of the map.

The API can be used to create links for your website – for example to link your visitors to a map of the closest disabled / handicap parking spaces to your business, venue or event – or it can be used within a web app (or smartphone app) to display a map based on GPI coordinates.

Currently there are four top level Linking API commands: place, id, view and coords.

All web-API requests follow the following format and must be appropriately URL encoded:

http://BlueBadgeParking.com/{command}/{request_detail}[/{map_type}]

/place

The /place command links you to any place on the map and gives that place its own marker and Info Window containing all of the usual BlueBadgeParking.com functionality – including StreetView, Directions, Navigation and further sharing.

The /place command is the most complex of the commands in our Linking API but it is also the most flexible.

For a /place request the request_detail contains the coordinates of the place you wish to link to along with the place name and address plus an optional event name or title for the link. The longitude/latitude pair is comma separated, then each of the other value is separated with a pipe symbol (|).

/place also supports the map_type parameter and accepts either road or sat – with sat being the default if this parameter is omitted.

The request_detail is built up as follows:

{comma separated longitude, latitude pair}|{Place Name}|{Place Address}[{Event/marker title}]

So, for ‘The Last Night of the Proms’ at the Royal Albert Hall, the request_detail would be:

51.500909,-0.177366|Royal Albert Hall|Kensington Gore, London SW7 2AP, United Kingdom|Last Night of the Proms

If we build this into a full request for a road map we would have:

http://BlueBadgeParking.com/place/51.500909,-0.177366|Royal Albert Hall|Kensington Gore, London SW7 2AP, United Kingdom|Last Night of the Proms/road

Of course, all special characters need to be URL encoded, so the actual URL would be (click it to give it a try):

http://BlueBadgeParking.com/place/51.500909%2C-0.177366%7CRoyal%20Albert%20Hall%7CKensington%20Gore%2C%20London%20SW7%202AP%2C%20United%20Kingdom%7CLast%20Night%20of%20the%20Proms/road

 

/id

The /id command links you to a maximum zoom of the specified parking location. The locations are identified by their location id which can be seen in every location’s Info-Window on the BlueBadgeParking.com map.

For an /id request the request_detail is simply the marker id number.

request_detail can also include an optional zoom level parameter. The zoom level is added after the id number and separated with a comma (,).

Zoom levels are specified as:

0 = full zoom out
99 = maximum zoom in
-1 = one level out from maximum
-2 = two levels out from maximum
etc.

If you know the exact zoom level you wish to use then that can also be specified as a positive number, however this is discouraged as imagery may not exist at all levels for all map locations.

/id also supports the map_type parameter and accepts either road or sat – with sat being the default if this parameter is omitted.

e.g. To link directly to a road map view of location id 3325 (outside of the Roswell chamber of Commerce):

http://BlueBadgeParking.com/id/3325/road

/view

The /view command links you to a view which includes a rectangle of coordinates defined by a Southwest corner and a Northeast corner.

This can be used to display a particular country, town or any other arbitrary area on the map.

For a /view request the request_detail must contain the four GPS coordinates defining this rectangle in the order SW latitude, SW longitude, NE latitude, NE longitude. Each coordinate must be separated by a comma (,) character. (The comma character URL encodes to %2C)

/view also supports the map_type parameter and accepts either road or sat – with sat being the default if this parameter is omitted.

Note that the actual view displayed will depend on the resolution, size and aspect ratio of the window your user is using to display the map. The whole rectangle will, however, be displayed within the view.

e.g. To link to a satellite view which contains the whole of Iceland:

http://BlueBadgeParking.com/view/63.27911%2C-24.664307%2C66.649494%2C-12.996826/sat

/coords

The /coords command links you to a map centered on the supplied GPS coordinates with the zoom level set to the specified zoom level.

Note that the area of map displayed to your users will depend on the size and resolution of the window in which they open the link.

This can be used to display a specific map location and as well as being useful for web links it can be used in applications such as contacts managers or GPS trackers to display a precise location.

For a /coords request the request_detail must contain the comma separated longitude, latitude pair for the center of the map followed by an optional zoom level.

request_detail can also include an optional zoom level parameter. The zoom level is added after the long/lat coordinates and separated with a comma (,).

Zoom levels are specified as:

0 = full zoom out
99 = maximum zoom in
-1 = one level out from maximum
-2 = two levels out from maximum
etc.

If you know the exact zoom level you wish to use then that can also be specified as a positive number, however this is discouraged as imagery may not exist at all levels for all map locations.

e.g. To link to a road map Copacabana Beach in Rio, Brazil with a zoom level of 3 less than the maximum available:

http://BlueBadgeParking.com/coords/-22.968778%2C-43.178716%2C-3/road

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s