Platsr API Documentation

Introduction

The Platsr API gives you as a developer access to tons of local history data all witch is available under open licenses. Platsr.se and its services is provided by the Swedish National Heritage Board, this documentation and tool is developed and maintained by volunteers and should not be associated with the Swedish National Heritage Board.

The Platsr API implements a GET based REST-like interface with JSON responses.

The following documentation provides documentation for all methods available. It do not and do not aim to cover the JSON response format, for exploring it an API sandbox is provided.

Archive Object

archiveObject allows you to return a archive item based on it's URI. This method also allows a response based on an user ID that returns archive objects linked within Platsr by that specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified|created(default)
• sort supported values: decs|asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/platsr/api/v1/archiveObject/51000000016280
• http://www.platsr.se/platsr/api/v1/archiveObject?userId=Albin+Larsson

Bookmark

bookmark allows you to return an user created bookmark. This method also allows a response based on an user ID that returns bookmarks by that specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified|created(default)
• sort supported values: decs|asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/api/v1/bookmark/51000000002060
• http://www.platsr.se/platsr/api/v1/bookmark?userId=Admin

Collection

collection allows you to return an user created collection. This method also allows a response based on an user ID that returns collections by that specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified|created(default)
• sort supported values: decs|asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/api/v1/collection/51000000058701
• http://www.platsr.se/platsr/api/v1/collection?userId=Albin+Larsson

Comment

comment allows you to return a comment. This method also allows a response based on an user ID that can return multiply comments by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified|created(default)
• sort supported values: decs|asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/api/v1/comment/51000000061380
• http://www.platsr.se/api/v1/comment?userId=Albin+Larsson

Copyright

copyright allows you to copyright description by its ID.

Examples

• http://www.platsr.se/api/v1/copyright/511000

Image

image allows you to return information about an image. This method also allows a response based on an user ID that can return multiply images uploaded or linked by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified | created(default)
• sort supported values: decs | asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/api/v1/image/51000000060560
• http://www.platsr.se/api/v1/image?userId=Albin+Larsson

Place

place allows you to retrieve a single place or a list of places. The place method has six incompatible parameters for returning lists and each parameter has multiply optional or required parameters.

• bbox requires SWEREF 99 TM coordinates in a comma separated list: {left},{bottom},{right},{top}
  • extracted optional parameter for including all data about a place within the list.
• point used to return all places within a specific range from a location(format: {x},{y}).
  • radius optional parameter(int), specifies the radius around the specified point(in meters).
  • extracted optional parameter
• userId return a list of places created by an specific user.
  • orderBy supported values: modified | created(default)
  • sort optional, supported values: decs | asc(default)
  • limit optional, any positive integer
  • extracted optional, optional parameter
• archiveObjectUrl used to retrieve a list of places witch has a specific SOCH archive linked. SOCH URI:s is the only valid value, not Platsr:s archive objects IDs.
  • orderBy supported values: modified | created(default)
  • sort optional, supported values: decs | asc(default)
  • limit optional, any positive integer
  • extracted optional, optional parameter
• text used to retrieve a list of places witch contains a specific string.
  • extracted optional, optional parameter

Examples

• http://www.platsr.se/platsr/api/v1/place?bbox=619243%2C6518456%2C612326%2C6510471
• http://www.platsr.se/platsr/api/v1/place?point=616194%2C6514159&radius=10000
• http://www.platsr.se/platsr/api/v1/place?userId=Albin+Larsson
• http://www.platsr.se/platsr/api/v1/place?archiveObjectUrl=raa/fmi/10090500420002&sortBy=desc
• http://www.platsr.se/platsr/api/v1/place?text=Katrineholm&extracted=true

Recommendation

recomendation allows you to return a recommendation. This method also allows a response based on an user ID that can return multiply recommendations made by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified | created(default)
• sort supported values: decs | asc(default)
• limit any positive integer

NOTE: recomendation is the valid parameter name not recommendation.

Examples

• http://www.platsr.se/platsr/api/v1/recomendation/51000000077244
• http://www.platsr.se/api/v1/recomendation?userId=Albin+Larsson

Sound

sound allows you to return information about an uploaded or linked sound. This method also allows a response based on an user ID that can return multiply sounds uploaded or linked by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified | created(default)
• sort supported values: decs | asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/platsr/api/v1/sound/51000000064221
• http://www.platsr.se/api/v1/sound?userId=Albin+Larsson

Story

story allows you to return a story. This method also allows a response based on an user ID that can return multiply stories made by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified | created(default)
• sort supported values: decs | asc(default)
• limit any positive integer

NOTE: recomendation is the valid parameter name not recommendation.

Examples

• http://www.platsr.se/api/v1/story/51000000058826
• http://www.platsr.se/api/v1/story?userId=Albin+Larsson

Tag

tag allows you to return a tag. This method also allows a response based on an user ID that can return multiply tags used by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified | created(default)
• sort supported values: decs | asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/api/v1/tag/51000000058820
• http://www.platsr.se/api/v1/tag?userId=Albin+Larsson

User

user allows you retrieve information about an specific user.

NOTE: The user ID is not a integer as for other Platsr items.

Examples

• http://www.platsr.se/api/v1/user/Albin+Larsson

Video

video allows you to return information about an uploaded or linked video. This method also allows a response based on an user ID that can return multiply sounds uploaded or linked by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified | created(default)
• sort supported values: decs | asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/platsr/api/v1/video/51000000017040
• http://www.platsr.se/api/v1/video?userId=Albin+Larsson

Web Address

webAddress allows you to return information about an linked web address. This method also allows a response based on an user ID that can return information about multiply web addresses by an specific user. The userId parameter has three optional parameters:

• orderBy supported values: modified | created(default)
• sort supported values: decs | asc(default)
• limit any positive integer

Examples

• http://www.platsr.se/api/v1/webAdress/51000000016301
• http://www.platsr.se/api/v1/webAddress?userId=Albin+Larsson