collections

Download schema

Retrieve Collections

GET

/_/collections/

Retrieve a list of all collections.

Retrieve Collections › Responses

200

Successful Response

No data returned

Drop a collection with all its pages and annotations.

DELETE

/_/collections/{collection_slug}/

Drop a collection and its annotations.

Drop a collection with all its pages and annotations. › path Parameters

collection_slug

string · required

Drop a collection with all its pages and annotations. › Responses

Empty response.

No data returned

Create a Web Annotation Collection.

POST

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

Create a Web Annotation Collection. › Headers

slug

Create a Web Annotation Collection. › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = null

Properties for InputCollection:

Collection as it can be submitted.

InputCollection

Create a Web Annotation Collection. › Responses

The created Annotation Collection.

An Annotation Collection.

Collection

id

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

modified

string · required

created

string · required

@context

string[]

Default: ["http://www.w3.org/ns/anno.jsonld","http://www.w3.org/ns/ldp.jsonld"]

Default: ["AnnotationCollection","BasicContainer"]

total

integer · min: 0

Default: 0

POST/

curl --request POST \
  --url / \
  --header 'Content-Type: application/json' \
  --data '
{
  "@context": "https://www.example.com/path/to/resource",
  "id": "https://www.example.com/path/to/resource",
  "type": "string"
}
'

Example Request Body

{
  "@context": "https://www.example.com/path/to/resource",
  "id": "https://www.example.com/path/to/resource",
  "type": "string"
}

json

Example Responses

{
  "@context": [
    "http://www.w3.org/ns/anno.jsonld",
    "http://www.w3.org/ns/ldp.jsonld"
  ],
  "created": "2024-02-15T10:24:20.872125+00:00",
  "creator": "http://example.com/publisher",
  "first": "http://example.org/page1",
  "id": "http://example.org/collection1",
  "label": "Steampunk Annotations",
  "last": "http://example.org/page42",
  "modified": "2024-02-15T10:24:20.872125+00:00",
  "total": 42023,
  "type": [
    "AnnotationCollection",
    "BasicContainer"
  ]
}

text

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

Options Root

OPTIONS

Options Root › Responses

Empty response.

No data returned

Retrieve an Annotation Collection or Annotation Page.

GET

/{collection_slug}/

Retrieve an Annotation Collection (collection_slug) or an Annotation Page (page).

Retrieve an Annotation Collection or Annotation Page. › path Parameters

collection_slug

string · required

Retrieve an Annotation Collection or Annotation Page. › query Parameters

page

Retrieve an Annotation Collection or Annotation Page. › Headers

prefer

Retrieve an Annotation Collection or Annotation Page. › Responses

The requested Annotation Collection or Annotation Page.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, items, partOf
	type = object · requires: id, modified, created

Properties for Page:

An Annotation Collection’s Page.

Page

id

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

required

Default: AnnotationPage

startIndex

integer · min: 0

Default: 0

Default: http://www.w3.org/ns/anno.jsonld

GET/{collection_slug}/

curl --request GET \
  --url /:collection_slug

Example Responses

{
  "id": "https://www.example.com/path/to/resource",
  "type": "AnnotationPage",
  "items": [
    {
      "type": "Annotation",
      "target": {
        "id": "https://www.example.com/path/to/resource",
        "type": "SpecificResource",
        "source": "https://www.example.com/path/to/resource",
        "purpose": "string",
        "selector": {
          "refinedBy": null,
          "type": "FragmentSelector",
          "value": "value",
          "conformsTo": "string"
        },
        "state": {
          "refinedBy": null,
          "type": "HttpRequestState",
          "value": "value"
        }
      },
      "body": {
        "id": "https://www.example.com/path/to/resource",
        "type": "SpecificResource",
        "source": "https://www.example.com/path/to/resource",
        "purpose": "string",
        "selector": {
          "refinedBy": null,
          "type": "FragmentSelector",
          "value": "value",
          "conformsTo": "string"
        },
        "state": {
          "refinedBy": null,
          "type": "HttpRequestState",
          "value": "value"
        }
      },
      "id": "https://www.example.com/path/to/resource",
      "via": "string",
      "created": "created",
      "modified": "modified"
    }
  ],
  "next": "https://www.example.com/path/to/resource",
  "prev": "https://www.example.com/path/to/resource",
  "startIndex": 0,
  "@context": "http://www.w3.org/ns/anno.jsonld",
  "partOf": {
    "@context": "http://www.w3.org/ns/ldp.jsonld",
    "id": "https://www.example.com/path/to/resource",
    "modified": "modified",
    "created": "created",
    "total": 1,
    "first": "https://www.example.com/path/to/resource",
    "last": "https://www.example.com/path/to/resource"
  }
}

text

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

Delete an Annotation Collection.

DELETE

/{collection_slug}/

Delete an Annotation Collection (collection_id).

Delete an Annotation Collection. › path Parameters

collection_slug

string · required

Delete an Annotation Collection. › Headers

if-match

Delete an Annotation Collection. › Responses

Empty response.

No data returned

Options Collection

OPTIONS

/{collection_slug}/

Options Collection › path Parameters

collection_slug

string · required

Options Collection › Responses

Empty response.

No data returned

Head Collection

HEAD

/{collection_slug}/

Head Collection › path Parameters

collection_slug

string · required

Head Collection › Responses

Empty response.

No data returned

internal extensions

Drop a collection with all its pages and annotations.

DELETE

/_/collections/{collection_slug}/

Drop a collection and its annotations.

Drop a collection with all its pages and annotations. › path Parameters

collection_slug

string · required

Drop a collection with all its pages and annotations. › Responses

Empty response.

No data returned

Create a Web Annotation Collection.

POST

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

Create a Web Annotation Collection. › Headers

slug

Create a Web Annotation Collection. › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = null

Properties for InputCollection:

Collection as it can be submitted.

InputCollection

Create a Web Annotation Collection. › Responses

The created Annotation Collection.

An Annotation Collection.

Collection

id

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

modified

string · required

created

string · required

@context

string[]

Default: ["http://www.w3.org/ns/anno.jsonld","http://www.w3.org/ns/ldp.jsonld"]

Default: ["AnnotationCollection","BasicContainer"]

total

integer · min: 0

Default: 0

Retrieve an Annotation Collection or Annotation Page.

GET

/{collection_slug}/

Retrieve an Annotation Collection (collection_slug) or an Annotation Page (page).

Retrieve an Annotation Collection or Annotation Page. › path Parameters

collection_slug

string · required

Retrieve an Annotation Collection or Annotation Page. › query Parameters

page

Retrieve an Annotation Collection or Annotation Page. › Headers

prefer

Retrieve an Annotation Collection or Annotation Page. › Responses

The requested Annotation Collection or Annotation Page.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, items, partOf
	type = object · requires: id, modified, created

Properties for Page:

An Annotation Collection’s Page.

Page

id

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

required

Default: AnnotationPage

startIndex

integer · min: 0

Default: 0

Default: http://www.w3.org/ns/anno.jsonld

Delete an Annotation Collection.

DELETE

/{collection_slug}/

Delete an Annotation Collection (collection_id).

Delete an Annotation Collection. › path Parameters

collection_slug

string · required

Delete an Annotation Collection. › Headers

if-match

Delete an Annotation Collection. › Responses

Empty response.

No data returned