-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Blue Mountain Springs is a project sponsored by the Center for Digital Humanities at Princeton University. Its aim is to develop a suite of web services that can be used to to access the assets in Blue Mountain.
The base URI of the API is the following:
http://bluemountain.princeton.edu/springs/
TK. Will reprise information in the Blue Mountain specifications.
Blue Mountain Springs 1.0 provides a simple model of Blue Mountain’s resources:
- Blue Mountain contains a collection of magazines.
- Magazines contain issues.
- Issues contain constituents attributed (via bylines) to contributors. Not all bylines have been associated with authorized names. API users should be sure they understand the distinction between bylines and contributors.
Get representations of the magazines in Blue Mountain. If no <bmtnid> is given, the service returns a representation of all the magazines. If a <bmtnid> is supplied, it returns a representation of the corresponding magazine.
| Method | Accept Header | URL |
|---|---|---|
| GET | text/csv | magazines/<bmtnid>? |
| application/json | ||
| application/tei+xml | ||
| application/rdf+xml |
Conforms with RFC 4180 where the record fields are the following:
| field | type |
|---|---|
| bmtnid | xs:string; see above for bmtnid format |
| primaryTitle | xs:string |
| primaryLanguage | a delimited string of ISO 639-2 codes |
| startDate | w3cdtf |
| endDate | w3cdtf |
| isssus | xs:anyuri |
A JSON object with the following properties:
| property | type |
|---|---|
| bmtnid | xs:string; see above for bmtnid format |
| primaryTitle | xs:string |
| primaryLanguage | a delimited string of ISO 639-2 codes |
| startDate | w3cdtf |
| endDate | w3cdtf |
| isssus | xs:anyuri |
[To be further specified; a TEI document conforming with [a] Blue Mountain schema, containing a teiHeader with metadata and a body with a list of links to issues.
An RDF document
- Content-Type
- Access-Control-Allow-Origin
- 200 OK
Get representations of magazine issues in Blue Mountain.
If no bmtnid is provided, the service returns a representation of all the magazine issue resources in Blue Mountain. If a <bmtnid> of a magazine title is supplied, it returns a representation of all the magazine’s issues; if a <bmtnid> of an issue is supplied, the service returns a representation of the corresponding issue.
| Method | Accept Header | URL |
|---|---|---|
| GET | text/csv | issues/<bmtnid>? |
| text/plain | ||
| application/json | ||
| application/tei+xml | ||
| application/rdf+xml |
Conforms with RFC 4180 where the record fields are the following:
- bmtnid
- title
- volume
- number
- pubDate
- pubPlace
- editors
- contributors
- contributions
- advertisements
One or more JSON objects with the following properties:
- bmtnid
- title
- volume
- number
- pubDate
- pubPlace
- editors
- contributors
- contributions
- advertisements
A utf-8-encoded text dump from the TEI transcription or the ALTO OCR.
The complete TEI transcription of the resource. If the resource is a magazine title, the document returned is a teiCorpus. The facsimile section is not returned.
TBD.
Get representations of contributors to magazines in Blue Mountain.
If no bmtnid is supplied, the service returns a representation of all the bylines in Blue Mountain. Otherwise, it returns all the bylines in the resource specified by the <bmtnid>.
| Method | Accept Header | URL |
|---|---|---|
| GET | text/csv | bylines/<bmtnid>* |
| application/json | ||
| application/tei+xml | ||
| application/rdf+xml |
Conforms with RFC 4180 where the record fields are the following:
- bmtnid
- byline
- name (if available)
- title of contribution
- id of contribution
Get representations of contributors to magazines in Blue Mountain.
If no bmtnid is supplied, the service returns a representation of all the known contributors in Blue Mountain. Otherwise, it returns all the known contributors in the resource specified by the <bmtnid>.
| Method | Accept Header | URL |
|---|---|---|
| GET | text/csv | contributors/<bmtnid>* |
| application/json | ||
| application/tei+xml | ||
| application/rdf+xml |
Get representations of constituents of magazines in Blue Mountain.
- If no bmtnid is supplied, the service returns a representation of all constituents in Blue Mountain.
- If a bmtnid is supplied, the service returns representations of
all the constituents of the resource identified by that bmtnid:
- If the bmtnid is the id of an issue, the service returns all the constituents in that issue.
- If the bmtnid is the id of a title, the service returns all the constituents in that title.
| Method | Accept Header | URL |
|---|---|---|
| GET | text/csv | constituents/<bmtnid>?/<constid>? |
| application/json | ||
| application/tei+xml | ||
| application/rdf+xml |
This API implements the web service specified by the IIIF Presentation API (http://iiif.io/api/presentation/2.0/)
By implementing the IIIF Presentation API, Blue Mountain Springs also exposes Blue Mountain’s resources according to the Shared Canvas data model.
The base URI of the IIIF API is the following:
http://bluemountain.princeton.edu/springs/iiif/
IIIF collections are used to list the manifests available for viewing, and to describe the structures, hierarchies or collections that the physical objects are part of (see IIIF Presentation API 2.0).
The top-level collection/ resource is Blue Mountain’s collection proper, represented as a IIIF collection object containing embedded collection objects for each magazine title.
| Method | Accept Header | URL |
|---|---|---|
| GET | application/json | collection/{bmtnid} |
| application/ld+json |
The IIIF manifest is an object that contains sufficient information for a rendering client to initialize itself and begin to display something quickly to the user. The manifest resource represents a single object and any intellectual work or works embodied within that object. In particular it includes the descriptive, rights and linking information for the object. It then embeds the sequence(s) of canvases that should be rendered to the user.
| Method | Accept Header | URL |
|---|---|---|
| GET | application/json | {bmtnid}/manifest |
| application/ld+json | ||
| GET | application/xml | {bmtnid}/manifest.xml |
A manifest.