API

We will carry out extensive changes to the API in the next version (1.5). Unfortunately we will not be able to provide full backward compatibility with previous API syntax and data return structure (JSON data). The RDF/XML and JSON-LD format will not be changed for now.

The new version of the API is scheduled for release in late summer/early autumn.

KulturNav API

This document briefly describes the KulturNav web service API.

HTTP methods

The API currently supports HTTP GET requests to read data.

Authentication

API calls are currently not authenticated or authorized. This means only published content and being readable for ANY user is returned.

API methods

Get single entity
http://kulturnav.org/api/<uuid>  

OR

http://kulturnav.org/<uuid>  
with HTTP header Accept: application/json  

Response: JSON object entity representation

List dataset or list content
http://kulturnav.org/api/list/<uuid>[/<offset>[/<max>]]  

Response: JSON array of entity representation. Without offset and max, the method returns the entire dataset or list content. With offset, the method returns the system default number of entities in the dataset or list content, starting from position offset. With offset and max, the method
returns max entities in the dataset or list content, starting from position offset.

Search dataset or content
http://kulturnav.org/api/search/<search-phrase>[/<offset>[/<max>]]  

Response: JSON array of entity representation. Without offset and max, the method returns the entire result. With offset, the method returns the system default number of entities in the dataset or list content, starting from position offset. With offset and max, the method returns max entities in the dataset or list content, starting from position offset.

Basic examples of search-phrases
 http://kulturnav.org/api/search/list.type_r:4534ee60-c6a0-11e2-8b8b-0800200c9a61  

Will return the entities with the property list.type_r = 4534..., i.e. subscription folders

 http://kulturnav.org/api/search/entityType:Place,place.type_r:d9e8fb3d-1ad9-4565-99bd-37b8376f0702  

Will return the entities with entity type Place and with the property place.type = Inhabited place

Schema

Overview of schema.