annotations

Create a Web Annotation.

POST

/{collection_slug}/

Create a Web Annotation in a Collection (collection_slug) with an optional slug for the Annotation ID and return it.

Create a Web Annotation. › path Parameters

collection_slug

string · required

Create a Web Annotation. › Headers

slug

Create a Web Annotation. › Request Body

Annotation as it can be submitted.

InputAnnotation

required

Default: Annotation

Create a Web Annotation. › Responses

The created Annotation.

An Annotation as it is returned by the API.

Annotation

required

id

string · uri · minLength: 1 · maxLength: 2083 · required

created

string · required

modified

string · required

Default: Annotation

Default: ["http://www.w3.org/ns/anno.jsonld","https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"]

POST/{collection_slug}/

curl --request POST \
  --url /:collection_slug \
  --header 'Content-Type: application/json' \
  --data '
{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"
  ],
  "body": "http://example.org/post1",
  "id": "http://example.org/anno1",
  "target": "http://example.com/page1",
  "type": "Annotation"
}
'

Example Request Body

{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"
  ],
  "body": "http://example.org/post1",
  "id": "http://example.org/anno1",
  "target": "http://example.com/page1",
  "type": "Annotation"
}

json

Example Responses

{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"
  ],
  "body": "http://example.org/post1",
  "created": "2024-02-15T10:24:20.872125+00:00",
  "id": "http://example.org/anno1",
  "modified": "2024-02-15T10:24:20.872125+00:00",
  "target": "http://example.com/page1",
  "type": "Annotation"
}

text

application/ld+json;profile='http://www.w3.org/ns/anno.jsonld'

Retrieve a Web Annotation.

GET

/{collection_slug}/{annotation_slug}/

Retrieve an Annotation (annotation_slug) from a Collection (annotation_slug).

Retrieve a Web Annotation. › path Parameters

collection_slug

string · required

annotation_slug

string · required

Retrieve a Web Annotation. › Responses

The requested Annotation.

An Annotation as it is returned by the API.

Annotation

required

id

string · uri · minLength: 1 · maxLength: 2083 · required

created

string · required

modified

string · required

Default: Annotation

Default: ["http://www.w3.org/ns/anno.jsonld","https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"]

Replace a Web Annotation.

PUT

/{collection_slug}/{annotation_slug}/

Update (replace or insert) an Annotation (annotation_slug) in a Collection (collection_slug).

Replace a Web Annotation. › path Parameters

collection_slug

string · required

annotation_slug

string · required

Replace a Web Annotation. › Headers

if-match

Replace a Web Annotation. › Request Body

Annotation as it can be submitted.

InputAnnotation

required

Default: Annotation

Replace a Web Annotation. › Responses

The up-to-date Annotation.

An Annotation as it is returned by the API.

Annotation

required

id

string · uri · minLength: 1 · maxLength: 2083 · required

created

string · required

modified

string · required

Default: Annotation

Default: ["http://www.w3.org/ns/anno.jsonld","https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"]

PUT/{collection_slug}/{annotation_slug}/

curl --request PUT \
  --url /:collection_slug/:annotation_slug \
  --header 'Content-Type: application/json' \
  --data '
{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"
  ],
  "body": "http://example.org/post1",
  "id": "http://example.org/anno1",
  "target": "http://example.com/page1",
  "type": "Annotation"
}
'

Example Request Body

{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"
  ],
  "body": "http://example.org/post1",
  "id": "http://example.org/anno1",
  "target": "http://example.com/page1",
  "type": "Annotation"
}

json

Example Responses

{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"
  ],
  "body": "http://example.org/post1",
  "created": "2024-02-15T10:24:20.872125+00:00",
  "id": "http://example.org/anno1",
  "modified": "2024-02-15T10:24:20.872125+00:00",
  "target": "http://example.com/page1",
  "type": "Annotation"
}

text

application/ld+json;profile='http://www.w3.org/ns/anno.jsonld'

Delete a Web Annotation.

DELETE

/{collection_slug}/{annotation_slug}/

Delete an Annotation (annotation_slug) in a Collection (collection_slug).

Delete a Web Annotation. › path Parameters

collection_slug

string · required

annotation_slug

string · required

Delete a Web Annotation. › Headers

if-match

Delete a Web Annotation. › Responses

Empty response.

No data returned

Options Annotation

OPTIONS

/{collection_slug}/{annotation_slug}/

Options Annotation › path Parameters

collection_slug

string · required

annotation_slug

string · required

Options Annotation › Responses

Empty response.

No data returned

Head Annotation

HEAD

/{collection_slug}/{annotation_slug}/

Head Annotation › path Parameters

collection_slug

string · required

annotation_slug

string · required

Head Annotation › Responses

Empty response.

No data returned

extensions

Create a Web Annotation.

POST

/{collection_slug}/

Create a Web Annotation in a Collection (collection_slug) with an optional slug for the Annotation ID and return it.

Create a Web Annotation. › path Parameters

collection_slug

string · required

Create a Web Annotation. › Headers

slug

Create a Web Annotation. › Request Body

Annotation as it can be submitted.

InputAnnotation

required

Default: Annotation

Create a Web Annotation. › Responses

The created Annotation.

An Annotation as it is returned by the API.

Annotation

required

id

string · uri · minLength: 1 · maxLength: 2083 · required

created

string · required

modified

string · required

Default: Annotation

Default: ["http://www.w3.org/ns/anno.jsonld","https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"]

Retrieve a Web Annotation.

GET

/{collection_slug}/{annotation_slug}/

Retrieve an Annotation (annotation_slug) from a Collection (annotation_slug).

Retrieve a Web Annotation. › path Parameters

collection_slug

string · required

annotation_slug

string · required

Retrieve a Web Annotation. › Responses

The requested Annotation.

An Annotation as it is returned by the API.

Annotation

required

id

string · uri · minLength: 1 · maxLength: 2083 · required

created

string · required

modified

string · required

Default: Annotation

Default: ["http://www.w3.org/ns/anno.jsonld","https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"]

Replace a Web Annotation.

PUT

/{collection_slug}/{annotation_slug}/

Update (replace or insert) an Annotation (annotation_slug) in a Collection (collection_slug).

Replace a Web Annotation. › path Parameters

collection_slug

string · required

annotation_slug

string · required

Replace a Web Annotation. › Headers

if-match

Replace a Web Annotation. › Request Body

Annotation as it can be submitted.

InputAnnotation

required

Default: Annotation

Replace a Web Annotation. › Responses

The up-to-date Annotation.

An Annotation as it is returned by the API.

Annotation

required

id

string · uri · minLength: 1 · maxLength: 2083 · required

created

string · required

modified

string · required

Default: Annotation

Default: ["http://www.w3.org/ns/anno.jsonld","https://editions.sub.uni-goettingen.de/ns/textapi.jsonld"]

Delete a Web Annotation.

DELETE

/{collection_slug}/{annotation_slug}/

Delete an Annotation (annotation_slug) in a Collection (collection_slug).

Delete a Web Annotation. › path Parameters

collection_slug

string · required

annotation_slug

string · required

Delete a Web Annotation. › Headers

if-match

Delete a Web Annotation. › Responses

Empty response.

No data returned