Skip to content

Infocenter service endpoints

General headers

Header Name Type Description
Accept-Timezone string Supply a TimeZone id property acquired from Infocenter /timezones route in order to get data with desired time offset

General query parameters

Parameter Name Type Description
updatedSince DateTime to get changed data only
source string filter by datasource (should be used always in MVP) possible values see List of data sources
continuation string continuation token for paging
top int number of next set of entities
category string identifier of category (members of categories in the tree below are part of the result too)
containedInPlace string identifier of parent place → filter by region (members of regions in the tree below are part of the result too -> Tarasp -> Inn -> Graubünden -> Schweiz)
additionalType string filter by class
select string list of object properties to get in a response
includeCount bool if true - adds count field to response object with total number of entities after applying filters. Warning: usage of this query param will slow down query and is not recommended to use in every query
geo location coming soon

Places

Route Response entity
/places Place
/places/{id} Place
/localbusinesses LocalBusiness
/lodgingbusinesses LodgingBusiness
/foodestablishments FoodEstablishment
/civicstructures CivicStructure
/administrativearea AdministrativeArea
...

Categories

Route Response entity Description
/categories Category Delivered as a flat list
/categories/{id} Category
/categories/{id}/tree CategoryTreeItem Category tree starting from defined category

Categories query parameters

Parameter Name Type Description
RootObjectsOnly bool To get root categories only
ParentCategory string To get children of defined category

Info

In MVP we do not merge categories from different sources but you can use full category tree. So at the moment it is important to use the source when querying the categories.

Regions / AdminitrativeArea

Regions form a tree similar to categories and can be used as a navigation for places as well. Regions are modeled as AdministrativeAreas in schema.org and we do the same.

Route Request parameter Response entity
/administrativearea (General query parameters) AdministrativeArea
/administrativearea/{id} AdministrativeArea
/administrativearea/{id}/tree levels: controls how deep the tree should go. default = 1
adminAreasOnly: if set to false all types of areas are included (see below). default = true
AdministrativeAreaTreeItem
additionalType is admin area
The ones marked true are included in the tree request with adminAreasOnly=true (default). They form useful tree structures. The others lay accross over the others.
schema.org/Country true
schema.org/State true
discover.swiss/CustomArea true
discover.swiss/District true
schema.org/City true
discover.swiss/MountainArea false
discover.swiss/ProtectedArea  false
some regions
TSVM-OUA_1037953 Schweiz Country
TSVM-OUA_1022106 Graubünden State
TSVM-OUA_1039560 Graubünden CustomArea (child of Graubünden State)

Warning

Downloading the full or big trees is currently very slow

Info

There is one region tree over all data sources.

Termversions

There are endpoints to query Termversion but there are no public endpoints to query the full definition of a term.

Route Request parameter Response entity remark
/termversions/{code} code: the version code TermVersion delivers the details af a specific version
/termversions/{termCode}/currentVersion termCode: the code of the term (not the version) TermVersion return the currently active version of the term

Tip

To understand how terms & conditions are organized read the page terms and conditions. To understand how terms & conditions are organized read the page terms and conditions.

Search endpoint to make fast database searches

Route Response entity
/search Search Response

TimeZones

There is a single endpoint to get a list of all supported TimeZones with offsets

Route Response entity
/timezones TimeZone

Last update: September 3, 2020 12:01:07