Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 14
Next »
The User Set API allows users to create and maintain their own collection of items (sets) that are available in Europeana. Besides creating sets, users can also search for sets that were created by other users and are available for public viewing. This API supports the gallery functionality that is available in the Europeana website for logged-in users.
Retrieves all metadata available for a specific user set. This includes all descriptive metadata but leaves out the contents of the set.
Request
https://api.europeana.eu/set/[IDENTIFIER]
Accept: [ACCEPT]
https://api.europeana.eu/set/[IDENTIFIER].[FORMAT]
Parameter | Location | Description |
---|
IDENTIFIER | path | The local identifier of the user set. |
ACCEPT | header | Indicates the preferred format via which the user set is to be represented if the format is accepted by the service. Only JSON-LD is supported. |
FORMAT | path | Convenience method where the format is indicated as a path parameter instead of via the Accept header. |
Response
On success, the method returns a HTTP 200 with the metadata of the user set.
The response is a JSON-LD structure composed of the following fields:
Field | Datatype | Description |
---|
User Set |
@context | String (URL) | The JSON-LD context |
id | String (URI) | The unique identifier of the user set |
type | String | The type of the user set. By default all user sets are classified as 'Collection'. The 'BookmarkFolder' and 'EntityBestItemsSet' are types that are used to power specific functionality in the Europeana Website. |
label | Object (LangMap) | The title of the Item in multiple languages when available. |
summary | Object (LangObject) | A longer-form prose description of the item in multiple languages when available. |
metadata | Array (Metadata) | A section dedicated to present a portion of the metadata for this Item for display purposes. |
thumbnail | Array (Thumbnail) | The thumbnail for this Item. |
navDate | String (Datetime) | A date that can be used for navigation purposes when presenting the resource to the user in a time-based user interface, such as a calendar or timeline. |
homepage | Array (Homepage) | The URL of this item in the Europeana Website. |
requiredStatement | Object (Attribution Statement) | A text that must be shown when the item is displayed or used, presenting the copyright or ownership statements and an acknowledgement of the owning and/or publishing institution. |
rights | Object (Rights) | One of the rights statements defined for use in Europeana. A rights statement that indicates the copyright, usage and access rights that apply to the content resource. |
provider | Array (Provider) | The information about the provider of this Manifest which is Europeana in this case. |
seeAlso | Array (Dataset) | A list of datasets avaible for this item. |
service | Array (Search Service) | A list of services that are available for this Manifest. Only the search service is available. |
start | Object (Reference) | Refers to the first Canvas to be displayed to the user. |
items | Array (Canvas) | A ordered list of canvases that make up this Manifest. A canvas is a view (or individual page) of an item. It acts as a central point for assembling the different content resources that make up the display of the item. |
Canvas |
id | String (URI) | The unique identifier of the Canvas. |
type | String | The type of the resource. Always set to "Canvas" for Canvases. |
label | Object (Language Map) | A label for the Canvas in multiple languages if available. |
height | Integer | The height of the canvas which corresponds to the height of the content resource. |
width | Integer | The width of the canvas which corresponds to the width of the content resource. |
duration | Number | The duration (measured in seconds) of the canvas which corresponds to the duration of the content resource (only applies to Audio or Video). |
requiredStatement | Object (Attribution Statement) | A text that must be shown when the content resource is displayed or used, presenting the copyright or ownership statements and an acknowledgement of the owning and/or publishing institution. |
Search for an entity
0 Comments