Publications#

Note

The endpoints documented in this page don’t need authentication as they are published data.

Collection Publications#

Get the information about a publication#

GET /publications/collections/{publication_id}/info

Get the general information about the publication.

URL parameters#

  • publication_id: The ID of the publication.

Response#

An object with the following properties:

  • id: The ID of the publication.

  • collection_id: The ID of the collection of the publication.

  • active: Whether the publication is active.

  • created_at: The datetime when the publication is created.

  • updated_at: The datetime when the publication is updated.

Get the data of a publication#

GET /publications/collections/{publication_id}/json

Get a published collection data by its publication ID.

URL parameters#

  • publication_id: The ID of the publication.

Response#

The collection object of the published collection. The object contains all published image set objects from the collection with their published annotation set objects.

Get the IIIF manifest of a publication#

GET /publications/collections/{publication_id}/manifest

Get the IIIF manifest of a published collection by its publication ID.

URL parameters#

  • publication_id: The ID of the publication.

Response#

The IIIF manifest of the published collection.

Image Set Publications#

Get the information about a publication#

GET /publications/image-sets/{publication_id}/info

Get the general information about the publication.

URL parameters#

  • publication_id: The ID of the publication.

Response#

An object with the following properties:

  • id: The ID of the publication.

  • image_set_id: The ID of the image set of the publication.

  • active: Whether the publication is active.

  • created_at: The datetime when the publication is created.

  • updated_at: The datetime when the publication is updated.

Get the data of a publication#

GET /publications/image-sets/{publication_id}/json

Get a published image set data by its publication ID.

URL parameters#

  • publication_id: The ID of the publication.

Response#

The image set object of the published image set.

Additionally, the following properties are included in the image set object:

  • images: An array of image objects which are the images included in the image set.

  • annotation_sets: An array of annotation set objects which are published annotation sets of the image set. Each annotation set object also has the property annotations which is an array of annotation objects which are the annotations of the annotation set.

Get the IIIF manifest of a publication#

GET /publications/image-sets/{publication_id}/manifest

Get the IIIF manifest of a published image set by its publication ID.

URL parameters#

  • publication_id: The ID of the publication.

Response#

The IIIF manifest of the published image set.

Annotation Set Publications#

Get the data of a publication#

GET /publications/annotation-sets/{publication_id}/json

Get a published annotation set data by its publication ID.

URL parameters#

  • publication_id: The ID of the publication.

Response#

The annotation set object containing all annotation objects from the annotation set.

Get the IIIF manifest of a publication#

GET /publications/annotation-sets/{publication_id}

Get the IIIF manifest of a published annotation set by its publication ID.

URL parameters#

  • publication_id: The ID of the publication.