Page Comparison

...

A simple tag is a short textual description of a resource. This scenario only applies when the language of the tag is not known, otherwise see the scenario described in the next Section.

Examples:	church blue black and white
Requirement:	A maximum of 64 characters is allowed for a simple tag. A tag cannot be a URL.
In the API:	Set the "motivation" to "tagging" and set the tag within the "bodyValue" field.
Availability:	Since version 0.2.1.

Expand

title	Example: tagging a Europeana item with the word "painting".

Code Block
{ "motivation": "tagging", "bodyValue": "painting", "target": "http://data.europeana.eu/item/92062/BibliographicResource_1000126189360" }

...

A simple tag is a short textual description of a resource.

Examples:	church blue black and white
Requirement:	A maximum of 64 characters is allowed for a simple tag. A tag cannot be a URL and the language information must be specified.
In the API:	Set the "motivation" to "tagging" and set the tag within the "body" field as a Textual Body.
Availability:	Since version 0.2.1.

Expand

title	Example: tagging a Europeana item with the English word "painting"

Code Block
{ "motivation": "tagging", "body": { "type": "TextualBody", "value": "painting", "language": "en" }, "target": "http://data.europeana.eu/item/92062/BibliographicResource_1000126189360" }

...

A semantic tag is a tag to a resource from a controlled vocabulary, making it machine-interpretable.

Example:	This object in Europeana is somehow related to France (http://sws.geonames.org/2988507).
Requirement:	Any URI is accepted as semantic resource. In the future, it will be limited to a controlled list of acceptable domains.
In the API:	Set the "motivation" to "tagging" and set as body the URI for the semantic resource taken from a contolled vocabulary.
Availability:	Since version 0.2.1.

Expand

title	Example: tagging a Europeana item with the semantic resource for Paris from Geonames.

Code Block
{ "motivation": "tagging", "body": "http://sws.geonames.org/2988507", "target": "http://data.europeana.eu/item/09102/_UEDIN_214" }

...

An object link is a relationship between two (Europeana) objects. This relationship can be any.

Example:	This object in Europeana is (in some way) similar to this object.
Requirement:	An object link can only be made between two Europeana objects.
In the API:	Set the "motivation" to "linking" and set as target an array containing the URIs of both objects.
Availability:	Since version 0.2.1.

Expand

title	Example: linking two Europeana items together.

Code Block
{ "motivation": "linking", "target": [ "http://data.europeana.eu/item/92062/BibliographicResource_1000126189360", "http://data.europeana.eu/item/92062/BibliographicResource_1000126189361" ] }

...

A geo-tag adds a geographical location to an item.

Example:	This object in Europeana was located at latitude 52.081131 and longitude 4.324053. .
In the API:	Set the "motivation" to "tagging" and include the "type", "lat" and "long" attributes in the body as per the example below.
Availability:	Since version 0.2.2.

Expand

title	Example: tagging a Europeana item with a geographical location.

Code Block

{
  "motivation": "tagging",
  "body": {
    "@context": "http://www.europeana.eu/schemas/context/entity.jsonld",
    "type": "Place",
    "lat": "52.081131",
    "long": "4.324053"
  },
  "target": "http://data.europeana.eu/item/92034/GVNRC_NFA03_kop_6_3"
}

...

Annotating a media resource means that the target of the annotation is not the Europeana item but instead a specific media resource within that item.

In the API:	Set the "target" of the annotation to a JSON object with the "scope" holding the unique identifier of the Europeana item and the "source" field the URL of the actual media resource being annotated.
Availability:	Since version 0.2.8.

Expand

title	Example: tagging a sound track of an Europeana item with the simple tag "Folk Music".

Code Block

{
  "motivation": "tagging",
  "bodyValue": "Folk Music",
  "target": {
    "type": "SpecificResource",
    "scope": "http://data.europeana.eu/item/2059207/data_sounds_T471_5",
    "source": "http://comhaltasarchive.ie/tracks/12535"
  }
}

...

A transcription is typically an annotation expressing a relation between an image and the text that is represented on that image. Besides the text, the annotation can also refer to a page where the text is displayed, like in the example below.

In the API:	Set the "motivation" to "transcribing" and apply the same criteria as for media resources.
Availability:	Since version 0.2.8.

Expand

title	Example: annotating the image of an Europeana item with the transcription page available at Transcribathon.

Example: annotating the image of an Europeana item with the transcription page available at Transcribathon.

Code Block

{
  "motivation": "transcribing",
  "body": {
    "id": "https://transcribathon.com/en/documents/id-20841/item-235882/",
    "language": "de",
    "format": "text/html"
  },
  "target": {
    "scope": "http://data.europeana.eu/item/2020601/contributions_20841",
    "source": 
    "http://www.europeana1914-1918.eu/attachments/2020601/20841.235882.full.jpg"
  }
}

...

While this API is in an Alpha state you will need to use a separate API key (other than for the main Europeana REST API) to start using it. You can use the following keys:

Environment	Details
Test	API key apidemo with user token tester1 (allows to create, update & remove annotations on behalf of a test user in the Annotations API test environment).
Production	API key apidemo (allows to search and retrieve annotations in the Annotations API production (live) environment).

Creating annotations in the production (live) environment is currently limited to only selected partners, this will be opened up as part of the Beta release.

...

Versions Compared

Old Version 1

New Version 2

Key

Example: annotating the image of an Europeana item with the transcription page available at Transcribathon.