Digital Bodleian IIIF API Specification (2.0.0)
Download OpenAPI specification:Download
This is the IIIF API Specification for Digital Bodleian. We provide our manifests in both Presentation API v2 (default) and v3 (available via Content Negotiation).
Most URIs are dereferenceable, and are returned with their appropriate JSON-LD @context when de-referenced. The only exception
to this are Ranges; this will be addressed in a future update.
The 406 Not Acceptable status code will be returned for requests that apply to a specific IIIF version. For example, Sequences have been removed in v3, so requesting a Sequence ID as a IIIFv3 response will return a 406 Status Code.
You are welcome to harvest our manifests for the purposes of indexing or making our content available in aggregator services. However, if are expecting to harvest a significant number of manifests, we would ask that you get in touch with us and let us know. You can do this by contacting our digital support team, or by adding your e-mail address to the User-Agent string.
We would prefer that you do not download and re-host our images.
We welcome bug reports. If you are having a problem retrieving or parsing our manifests, or if you find an invalid manifest, please contact us and provide the link to the manifest that does not work.
Retrieve a IIIF Manifest
Returns a IIIF Manifest. Clients will receive a Presentation v2.1 manifest by default. Version 3.0 manifests
can be returned by sending an Accept header with a value of application/ld+json;profile=http://iiif.io/api/presentation/3/context.json.
Presentation API 3.0 manifests are returned with a partOf key that contains a link to all Collections this
manifest is a member of.
path Parameters
| manifest_id required | string <uuid> Example: b73ca01f-aac8-4916-a7c6-3c8e67939a66 The ID of the Manifest to Retrieve |
Responses
Response samples
- 200
{- "@type": "sc:Manifest"
}Retrieve a dereferenced Canvas Object
Dereferenced Canvases are returned with the within key (v2) or a partOf key (v3)
pointing to their parent manifest.
path Parameters
| canvas_id required | string <uuid> Example: f37dd11c-a243-4b66-9a65-b8d498a114d6 The ID of the Canvas to retrieve |
Responses
Response samples
- 200
{- "@id": "string",
- "@type": "sc:Canvas"
}Retrieve a dereferenced Sequence object (Presentation v2 Only)
A dereferenced Sequence Object. Note that sequences are only available in v2 manifests, so this will return a 406 status code if it is requested for a v3 manifest. For all manifests we publish there will be only one sequence, the default.
path Parameters
| sequence_id required | string Example: faeff7fb-f8a7-44b5-95ed-cff9a9ffd198_default The ID of the sequence |
Responses
Response samples
- 200
{ }Retrieve an dereferenced Annotation Object
A dereferenced Annotation Object.
path Parameters
| annotation_id required | string <uuid> Example: f37dd11c-a243-4b66-9a65-b8d498a114d6 The Annotation ID |
Responses
Response samples
- 200
{ }Retrieve a dereferenced AnnotationPage Object (Presentation v3 Only)
A dereferenced AnnotationPage Object. Note that annotation pages are only available in v3 manifests, so this will return a 406 status code if it is requested for a v2 manifest.
path Parameters
| annotation_page_id required | string Example: f37dd11c-a243-4b66-9a65-b8d498a114d6 The annotation page ID |
Responses
Response samples
- 200
{ }Retrieve a dereferenced AnnotationList Object (Presentation v2 Only)
A dereferenced AnnotationList Object. Note that annotation pages are only available in v2 manifests, so this will return a 406 status code if it is requested for a v3 manifest.
path Parameters
| annotation_list_id required | string Example: f37dd11c-a243-4b66-9a65-b8d498a114d6 The annotation list ID |
Responses
Response samples
- 200
{ }Retrieve the info.json for an image resource
A IIIF Image API Info Response. Clients will receive a Image API v2.1 response by default. Version 3.0 responses
can be returned by sending an Accept header with a value of application/ld+json;profile=http://iiif.io/api/image/3/context.json.
If a request omits the /info.json, the response will be a 307 redirect to /info.json.
path Parameters
| image_id required | string <uuid> Example: 082d5ad2-ea08-463c-ad50-6d1a0cb01246 The ID of the Image to retrieve |
Responses
Response samples
- 200
{- "@id": "string",
- "@type": "sc:Image"
}