| Table of Contents |
|---|
| minLevel | 1 |
|---|
| maxLevel | 2 |
|---|
| outline | false |
|---|
| style | none |
|---|
| type | list |
|---|
| printable | false |
|---|
|
Retrieval
Methods for accessing either the metadata of a user set or the metadata of the items that are part of the user set. Considering that the number of items that are part of the user may be relatively high, it was decided to separate the user set metadata from the item metadata retrieval and to offer a paginated approach to accessing the information about the items that are part of the user set.
Retrieves all metadata available for a specific user set. This includes all descriptive metadata but leaves out the contents of the set.
Request
| Code Block |
|---|
https://api.europeana.eu/set/[IDENTIFIER]
Accept: [ACCEPT] |
| Code Block |
|---|
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.
| Expand |
|---|
| title | 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 support specific functionality in the Europeana Website. | visibility | String | Access visibility of the user set. The possible states are “private”, “public” and “published”. The default value assigned at the creation of the set when omitted is “private”. labelFor “BookmarkFolder” sets, the visibility is immutable and cannot be changed to another value besides “private”. | title | Object (LangMap) | The title of the Item in multiple languages when available. | summaryName given by the user to the set. | description | Object (LangObjectLangMap) | 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. | Canvassummary of the content and topics of the user set. | subject | Array (String (URI)) | Overall topical content of the items in the set. These topics are restricted to URIs of the Europeana Entities. This property is repeatable when several subjects apply to the whole set. | pinned | Integer | The number of pinned items in the “EntityBestItemsSet” (only applicable for this kind of set). This is a temporary field while a more suitable option is found to handle user suggestions for Entities. | creator | Object (User) | Refers to a registered user which is the creator and owner of the set. | contributor | Array (String (URI)) | Refers to the registered users which have requested changes to the set. The API will list the URIs of all users that co-created the set. | provider | Object (Provider) | Holds a reference to an Organisation entity in Europeana or the URL of the project page in Europeana Pro together with the project name. | created | String (Datetime) | The time at which the set was created by the user. The value must be a Literal expressed as xsd:dateTime with the UTC timezone expressed as 'Z'. | modified | String (Datetime) | The time at which the set was modified, after creation. The value must be a Literal expressed as xsd:dateTime with the UTC timezone expressed as 'Z'. | issued | String (Datetime) | The time at which the set was published for a wider audience in the Europeana website. The value must be a Literal expressed as xsd:dateTime with the UTC timezone expressed as 'Z'. | isDefinedBy | String (URL) | Defines a search request to the Search API which selects the items that are part of the Set (only relevant for open sets). | total | Integer | A non-negative integer specifying the total number of items that are contained within this set. | first | String (URL) | Indicates the first preceding page of items in the set. | last | String (URL) | Indicates the furthest proceeding page of the set. | User | id | String (URI) | The unique identifier of the user in Europeana. | type | String | The type of the resource. Always set to "Person". | nickname | String | The username of the user. For privacy reasons, this is the only personal information made publicly available. | Provider | id | String (URI) | Holds a reference to an Organisation entity in Europeana or the URL of the project page in Europeana Pro. | type | String | The type of the resource. Always set to "Organization". | name | String | The name of the project that contributed the set. |
|
Retrieving items within a user set
Retrieves a limit number of items contained within a specific user set. This method is used to traverse through the complete list of items within the user set by requesting each page of items at a time. Use the 'page' and 'pageSize' parameters to navigate or follow the links in the 'next' or 'prev' properties to navigate respectively to the next or previous page.
Request
| Code Block |
|---|
https://api.europeana.eu/set/[IDENTIFIER]?page=[PAGE]
Accept: [ACCEPT] |
Parameter | Location | Description |
|---|
IDENTIFIER | path | The local identifier of the user set. |
page | query | The number of the page (defaults to 1). |
pageSize | query | The number of items to retrieve, maximum is 100, defaults to 10. |
profile | query | A parameter used to define the extent of the response. Two profiles are available “standard“ (default) and “itemDescriptions“. |
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. |
Response
On success, the method returns a HTTP 200 with a subset of items of the user set.
| Expand |
|---|
| title | The response is a JSON-LD structure composed of the following fields: |
|---|
|
Field | Datatype | Description |
|---|
User Set Page | @context | String (URL) | The JSON-LD context | id | String (URI) | The unique identifier of the page of items | type | String | The type of the page of items. Always set to 'CollectionPage'. | partOf | Object (Collection) | The user set to which this page belongs. Only the subset of information for navigating the itens is presented. | startIndex | Integer | A non-negative integer specifying the position in sequence of the first item in the user set page. | total | Integer | A non-negative integer specifying the total number of items in the user set page. | items | Array (String(URI) or Object(Item) ) | The metadata for, or a reference to, the items that are part of the set page. | prev | String (URL) | A reference to the previous page in the sequence of pages that make up the set. | next | String (URL) | A reference to the next page in the sequence of pages that make up the set. | Collection | id | String (URI) | The unique identifier of the user set. | type | String | The type of the resource. Always set to "Collection". | total | Integer | A non-negative integer specifying the total number of items that are contained within this set. | first | String (URL) | Indicates the first preceding page of items in the set. | last | String (URL) | Indicates the furthest proceeding page of the set. | Item | id | String (URI) | The unique identifier of a record in Europeana | … metadata for the item (see Search API documentation for an overview of the metadata) … |
|
Discovery
Methods for searching for items that are part of a user set or to search across all user sets that are available in Europeana.
Search for items within a user set
Search for items contained within a user set based on a given selection criteria. This method is paginated similar to the listing method. Use the 'page' and 'pageSize' parameters to navigate or follow the links in the 'next' or 'prev' properties to navigate, respectively, to the next or previous page.
Fields available for search:
No sort or faceting is available
Request
| Code Block |
|---|
https://api.europeana.eu/set/[IDENTIFIER]/search?query=[QUERY]
Accept: [ACCEPT] |
Parameter | Location | Description |
|---|
IDENTIFIER | path | The local identifier of the user set. |
query | query | The text to be used for searching. Always set to the wildcard value (ie. '*') for content search. |
qf | query | A search query filter. This parameter can be used multiple types if more than one query filter is needed. |
page | query | The number of the page (defaults to 1). |
pageSize | query | The number of items to retrieve, maximum is 100, defaults to 10. |
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. |
Response
On success, the method returns a HTTP 200 with a subset of items that are part of the user set and match the search criteria.
| Expand |
|---|
| title | The response is a JSON-LD structure composed of the following fields: |
|---|
|
Field | Datatype | Description |
|---|
(Search) Result Page | @context | String (URL) | The JSON-LD context | id | String (URI) | The identifier of the search results page. | type | String | The type of the page of items. Always set to 'ResultPage'. | partOf | Object (ResultList) | The complete list of items that match the search query. Only the subset of information for navigating the items in the search results list is presented. | total | Integer | A non-negative integer specifying the total number of items in the search results page. | items | Array (String (URI)) | The reference to the items that are part of the search results page. | prev | String (URL) | A reference to the next page in the sequence of pages that make up the search results. | next | String (URL) | A reference to the previous page in the sequence of pages that make up the search results. | (Search) Result List | id | String (URI) | The |
unique Canvassearch results. | 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 entityResultList". | total | Integer | The total number of items matching the search query. | first | String (URL) | Indicates the first preceding page of items in the result list. | last | String (URL) | Indicates the furthest proceeding page of items in the result list. |
|
Search for user sets
Search for user sets based on a given selection criteria. This method is paginated similar to the listing method. Use the 'page' and 'pageSize' parameters to navigate or follow the links in the 'next' or 'prev' properties to navigate, respectively, to the next or previous page.
Fields available for search:
set_id
creator: using local identifier or URI
contributor: using local identifier or URI
visibility:
type: with value 'Collection' or 'BookmarkFolder', or 'EntityBestItemsSet')
item: with the local identifier of the record contained within the set)
subject: with the URI), lang (with a two-letter code), title.
Fields available for sorting:
No faceting is available
Request
| Code Block |
|---|
https://api.europeana.eu/set/search?query=[QUERY]
Accept: [ACCEPT] |
Parameter | Location | Description |
|---|
IDENTIFIER | path | The local identifier of the user set. |
query | query | The text to be used for searching. |
qf | query | A search query filter, ie. a filter is applied on the result list to remove unwanted results and therefore has no effect on ranking. This parameter can be used multiple types if more than one query filter is needed. |
profile | query | A parameter used to define the extent of the response. Three profiles are available “minimal“ (default), “standard“ and “facets“. minimal: Presents only the identifiers of the items that are part of the page. standard: Presents the metadata of the user sets that are part of the page. facets: Presents the facets.
|
sort | query | A comma separated list of fields used for sorting the results. The field can be suffixed with the order in which the results are sorted, either 'asc' or 'desc' by the following: <field_name>+<sort_order>. The special keyword 'score' can be used to order by the ranking as determined by the search engine (which is the default). |
page | query | The number of the search result page (defaults to 1). |
pageSize | query | The number of user sets to retrieve, maximum is 100, defaults to 10. |
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. |
Response
On success, the method returns a HTTP 200 with a subset of user sets that match the search criteria.
| Expand |
|---|
| title | The response is a JSON-LD structure composed of the following fields: |
|---|
|
Field | Datatype | Description |
|---|
(Search) Result Page | @context | String (URL) | The JSON-LD context | id | String (URI) | The identifier of the search results page. | type | String | The type of the page of items. Always set to 'ResultPage'. | partOf | Object (ResultList) | The complete list of user sets that match the search query. Only the subset of information for navigating the items in the search results list is presented. | total | Integer | A non-negative integer specifying the total number of user sets in the search results page. | items | Array (String (URI) or Object(Set)) | The sets that are part of this search results page. | prev | String (URL) | A reference to the next page in the sequence of pages that make up the search results. | next | String (URL) | A reference to the previous page in the sequence of pages that make up the search results. | (Search) Result List | id | String (URI) | The identifier of the search results. | type | String | The type of the resource. Always set to "ResultList". | total | Integer | The total number of user sets matching the search query. | first | String (URL) | Indicates the first preceding page of user sets in the result list. | last | String (URL) | Indicates the furthest proceeding page of user sets in the result list. |
|
Provision