REST API Documentation

The Server connection details will be provided with your username and password, once approved. 

The API can return data in JSON or XML format. Please send the appropriate Accept header:

Accept: application/json, application/xml, text/json, text/xml 

Basic API usage

  1. GetUserToken() - retrieve your unique API token.
  2. GetSites() - retrieve a list of available sites. The data may contain collections for multiple museums, separated into Sites.
  3. GetCategories() - retrieve a list of available Categories for a specific Site.
  4. GetContent() - retrieve paged list of objects for the specified Site/Category/Keyword.
  5. GetThemes() - retrieve a list of available Themes for a specific Site
  6. GetTheme() - retrieve a paged list of objects for the specified Site/Theme/Keyword

GetUserToken

Returns the user token to be used to make requests to the web service.

Url /Content/GetUserToken
Arguments  
username Required
password Required

Example: http://servername:Port/Content/GetUserToken?username=YourUserName?Password=YourPassword

GetSites

Returns the list of available sites with Ids for use with the service.

Url /Content/Sites
Arguments  
userToken Required: The value returned by GetUserToken

Example: http://servername:Port/Content/Sites?userToken=YourUserToken

GetCategories

Returns the list of available categories with Ids for a given site for use with the service.

Url /Content/Categories
Arguments  
userToken Required: The value returned by GetUserToken
siteId Optional: The site id (as returned by GetSites) If omitted then the default site will be used)

Example: http://servername:Port/Content/Categories?userToken=YourUserToken&siteId=

GetContent

Returns the list of objects.

Url /Content/
Arguments  
userToken Required: The value returned by GetUserToken
siteId Optional: The site id of the site to use
categoryId Optional: The category to filter
pageSize Optional: The number of items per page
pageNumber Optional: The page number for the list of records
keyword Optional: The search term

Example: http://servername:Port/Content?userToken=YourUserToken&siteId=categoryId=pageSize=10pageNumber=1keyword=frog

http://servername:Port/Content?userToken=YourUserToken&siteId=categoryId=keyword=frog

GetThemes

Returns the list of available Themes with Ids for a given site for use with the service.

Url: /Content/Themes
Arguments:  
userToken Required: The value returned by GetUserToken
siteId Optional: The site id of the site to use
keyword Optional: The search term

Example:
http://servername:Port/Content/Themes?userToken=YourUserToken&siteId=
http://servername:Port/Content/Themes?userToken=YourUserToken&siteId=& keyword=frog

GetTheme

Returns the list of objects.

Url: /Content/Theme
Arguments:  
userToken Required: The value returned by GetUserToken
siteId Optional: The site id of the site to use
themeId Required: The theme to filter
pageSize Optional: The number of items per page
pageNumber Optional: The page number for the list of records
keyword Optional: The search term

Example:
http://servername:Port/Content/Theme?userToken=YourUserToken&siteId=&themeId=005924c6-2b39-42b5-ba71-93a157d34ce4&pageSize=10&pageNumber=1&keyword=frog

http://servername:Port/Content/Theme?userToken=YourUserToken&siteId=&themeId=005924c6-2b39-42b5-ba71-93a157d34ce4&keyword=frog

If you have any difficulties using our service please contact 01392 265311.