The outdooractive Data API gives you acces to the content of your outdooractive API Project.

Data format

The outdooractive Data API responses are UTF-8 XML documents by default or UTF-8 JSON documents alternatively. Most of the outdooractive Data API interfaces support JSONP.

Future releases of the outdooractive Data API will put a focus on UTF-8 JSON encoding. (Maybe XML support will be dropped at some point of time.)

The following http header has to be sent to get responses as JSON representation:

Accept: application/json

Project key, API key and project settings

A request to the outdooractive Data API is only valid if an outdooractive API key and an outdooractive project key are used. The following test keys are used in all examples and the reference. You are welcome to use these keys for temporary testing purposes.

Test Project Key

api-dev-oa

Test API Key

yourtest-outdoora-ctiveapi

The settings of an outdooractive project:

http://www.outdooractive.com/api/project/api-dev-oa/settings?key=yourtest-outdoora-ctiveapi

Category

Every outdooractive API project has its own category tree which is a two level hierarchy of project categories which are organized in category groups.

The complete category tree of an outdooractive API project:

http://www.outdooractive.com/api/project/api-dev-oa/category/tree?key=yourtest-outdoora-ctiveapi 

The project category tree reduced to categories of the core content types tour or poi:

http://www.outdooractive.com/api/project/api-dev-oa/category/tree/tour?key=yourtest-outdoora-ctiveapi 

http://www.outdooractive.com/api/project/api-dev-oa/category/tree/poi?key=yourtest-outdoora-ctiveapi 

The project category tree filtered to categories which currently have published content objects:

http://www.outdooractive.com/api/project/api-dev-oa/category/tree/tour/pruned?key=yourtest-outdoora-ctiveapi

http://www.outdooractive.com/api/project/api-dev-oa/category/tree/poi/pruned?key=yourtest-outdoora-ctiveapi

Region

The outdooractive platform stores information about the relations of continents, countries, provinces, districts and communes as a global hierarchical tree. Tourism areas, moutain areas and protected areas are part of this region tree.

A sub tree is chosen for each outdooractive API project and is available through the data api:

http://www.outdooractive.com/api/project/api-dev-oa/region/tree?key=yourtest-outdoora-ctiveapi 

Region types:

  • political: commune (Gemeinde), district (Landkreis), province (Bundesland), country (Staat), continent (Kontinent)
  • tourism: tourismarea (Tourismus Region), customarea (kundenspezifische Region)
  • nature: mountainarea (Bergregion), protectedarea (Schutzgebiet)

Top Tipps

Tours and POIs may be selected as “top tipps” of an Outdooractive API project. A “top tipp” is a relation between a content object, a project and a top tipp tag.

List all top tipp tags of a project:

http://www.outdooractive.com/api/project/api-dev-oa/toptipps?key=yourtest-outdoora-ctiveapi

List all top tipp tags and the related content objects:

http://www.outdooractive.com/api/project/api-dev-oa/toptipps?display=verbose&key=yourtest-outdoora-ctiveapi

OOI

Get the tours and POIs of a project as id lists:

http://www.outdooractive.com/api/project/api-dev-oa/tours/?key=yourtest-outdoora-ctiveapi
http://www.outdooractive.com/api/project/api-dev-oa/pois/?key=yourtest-outdoora-ctiveapi 

Get the full information of two content objects:

http://www.outdooractive.com/api/project/api-dev-oa/oois/1373438,1397449?key=yourtest-outdoora-ctiveapi

The same request reduced to a minimal set of attributes:

http://www.outdooractive.com/api/project/api-dev-oa/oois/1373438,1397449?key=yourtest-outdoora-ctiveapi&display=minimal

The same request reduced to a set of attributes which allows to render a content object snippet or list entry:

http://www.outdooractive.com/api/project/api-dev-oa/oois/1373438,1397449?key=yourtest-outdoora-ctiveapi&display=list

Look up the external id of a content object:

http://www.outdooractive.com/api/lookup/1373438?key=yourtest-outdoora-ctiveapi  

Full text search (POIs and tours) and get an id list:

http://www.outdooractive.com/api/search/?q=church&key=yourtest-outdoora-ctiveapi&project=api-dev-oa

Filter

Filter tours of a project and get an id list:

http://www.outdooractive.com/api/project/api-dev-oa/filter/tour?len_e=10000&key=yourtest-outdoora-ctiveapi

Available filter parameters:

Filter Parameter

The FilterClusterLayer allows you to filter all tours of your project by the following parameters.

Parameter Example Default Description
dif_d, dif_m, dif_e dif_d : false true show tours which are ‘difficult’ (dif_d=true), ‘intermediate’ (dif_m=true), ‘easy’ (dif_e=true)
asc_s, asc_e asc_s : 500 empty string filter tours by ascending meters: asc_s <= tour.asc <= asc_e
tim_s, tim_e tim_e : 60 empty string filter tours by duration in minutes: tim_s <= tour.time <= tim_e
len_s, len_e len_e : 5000 empty string filter tours by length in meters: len_s <= tour.length <= len_e
q q : ‘Church’ empty string full text search
area area : ‘1027459’ empty string filter by region
category category : ‘1566479’ empty string filter by category

NearBy

http://www.outdooractive.com/api/project/api-dev-oa/nearby/tour?location=10.26706,47.51336&sortby=distance&radius=5000&key=yourtest-outdoora-ctiveapi

Available parameters:

Nearby Parameter

The NearBy API is called with the parameters location and radius. Further parameters are:

Parameter Example Default Description
location 10.26706,47.51336 - longitude/latitude pair of the near by search center
radius 5000 - search radius (unit: meters)
sortby distance name result sorted by distance, name or ascent
limit 10 - limit the result list
callback onNearByResponse - js callback in case of jsonp (add /jsonp to path)

All Filter API parameters may be used as well.

Images

Images are content objects with a title and description. The outdooractive platform uses content relations to link images of content objects like tours and POIs. The images related to a content object are referenced by an outdooractive id in all object representations.

The default Url to an image object’s image file:

http://img.oastatic.com/img/6128163/.jpg

All images are available in several fixed sizes (width/height) from 100x100px up to 1250x625px. The fixed size that comes closest to a request at arbitrary sizes will be served.

The max width is 2048px (if the original image file width is greater than 2048px).

The available sizes are:

square

{ 100, 100 }, { 116, 116 }, { 120, 120 }, {133, 133}, {150, 150}
{ 180, 180 }, { 200, 200 }, { 220, 220 }, { 300, 300 }, { 320, 320 },
{ 350, 350 }, { 400, 400 }, { 420, 420 }, { 800, 800 }, { 1024, 1024 }, { 2048, 2048 }

landscape

{ 70, 40 }, { 98, 48 }, { 120, 68 }, { 220, 124 }, { 220, 130 },
{ 236, 134 }, { 320, 181 }, { 420, 237 }, { 600, 300 }, { 671, 335 },
{ 720, 360 }, { 728, 410 }, { 800, 450 }, { 800, 600 }, { 834, 417 }, { 840, 420 },
{ 900, 450 }, { 1080, 410 }, { 1080, 540 }, {1200, 600}, { 1250, 475 }, { 1250, 625 }

An image with a given size out of the list (width = 671px, height = 335 px):

http://img.oastatic.com/img/671/335/6128163/.jpg

An image with an arbitrary size (width = 650px, height = 300 px):

http://img.oastatic.com/img/650/300/6128163/.jpg

The image size in the response:

{ 800, 600 }

The original image file at full resolution:

http://img.oastatic.com/imgsrc/6128163/.jpg

The image file of the static elevation profile:

http://img.oastatic.com/img/2043031/elevationprofile.png
http://img.oastatic.com/img/232/100/fit/2043031/elevationprofile.png

The image file of the static map:

http://www.outdooractive.com/api/staticmap?i=1550935&size=small&project=api-dev-oa&key=yourtest-outdoora-ctiveapi

Parameter size: small, medium, large.

Download

GPX:

http://www.outdooractive.com/download.tour.gpx?i=1550935&project=api-dev-oa&key=yourtest-outdoora-ctiveapi

KML:

http://www.outdooractive.com/kml_generate?i=1550935&project=api-dev-oa&key=yourtest-outdoora-ctiveapi

Languages

The request language of all text APIs are set by parameters:

  • lang: e.g. “de”, “en”, “fr”, etc. Sets the request language.
  • fallback: possible values are true (default) and false, return the text of the default language if an attribute’s text is not avaible in the requested language

Example Request:

http://www.outdooractive.com/api/project/api-dev-oa/oois/1550935?key=yourtest-outdoora-ctiveapi&lang=it&fallback=false