CenterForDigitalHumanities / CenterForDigitalHumanities/TPEN-services

GET /line?parameters

Open
#450 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

This endpoint could provide alternate returns for certain parameters:

- ?text=blob a simple blob of textContent
- ?image=full the URL of the default resolution of a full page (found on the Canvas)
- ?image=line an image fragment of this single annotation
- ?lookup=project (page, manifest, layer, metadata[], group) find the related document or Array of documents and return that instead, the version allowed without authentication
- ?view=json is the default, no querystring request and is redundant
- ?view=xml is a chance to get the document as an XML file
- ?view=html is a readonly viewer HTML Document presenting the annotation
- ?embed=true instructs methods that would have returned a URI to expand that and dereference the full document in its place

These parameters are all mutually exclusive except embed and passing multiple or a nonsense combo ("?view=html&embed=true") is an error.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.