The lookup issue by id endpoint allows a client to retrieve the metadata for a specific issue provided they know the id number assigned to the issue within the Third Iron metadata database.
Contact BrowZine Support to Request your API Key
Email us at support@thirdiron.com to request your API Key. The BrowZine API can only be used by institutions subscribing to the BrowZine Service.
Submit a GET request against this endpoint, filling in the appropriate path segments with the id number of your library and with the id number of the issue that you are trying to retrieve and your application will get a response representing the issue. Responses contain some metadata about the issue, such as a display name for the issue, and links to API endpoints through which metadata resources related to the issue, such as the articles of the issue, may be retrieved.
Issue Lookup by Id Request:
| Supported Methods | GET |
|---|---|
| Endpoint Location | /public/v1/libraries/:library_id/issues/:issue_id |
Endpoint Parameters | |
| :library_id | Replace the :library_id portion of the endpoint path with the id # of your library |
| :issue_id | Replace the issue_id portion of the path with the id number for the issue |
Issue Lookup by Id Response:
The Lookup Issue by Id endpoint responds with a blob of JSON data that contains a Issue resource object that represents the issue with the specified id.
Response Object:
| Property | Type | Description |
|---|---|---|
| data | Object | An Issue resource object is returned here which represents the issue in the Third Iron metadata database which has the specified id. |
Issue Resource:
An Issue resource object represents an issue in the Third Iron metadata database.
The full list of properties that may appear on an issue resource object are described in detail in the table below:
| Property | Type | Description | Optional |
|---|---|---|---|
| id | number | The issue's unique id in the Browzine system | No |
| type | string | has the value “issues” | No |
| title | string | The issue’s title for display (typically “Vol. # Issue #”) | No |
| date | string | The publication date of the issue expressed in ISO date format (YYYY-MM-DD) | No |
| relationships | Object | An object representing relationships between the issue resource object and resource objects that represent other records in the Third Iron metadata database | Yes |
relationships.journal | Object | An object representing the relationship between the issue resource object and the resource object that represents the issue's journal in the Third Iron Metadata database | Yes |
relationships.journal.links | Object | An object holding links for the journal relationship | Yes |
relationships.journal.links.related | URL | A URL path to the API endpoint that retrieves the resource object that represents the journal of the issue represented by the issue resource object. | Yes |
relationships.articles | Object | An object representing the relationship between the issue resource object and the resource objects that represent the articles of the issue | Yes |
relationships.articles.links | Object | An object holdings links for the articles relationship | Yes |
relationships.articles.links.related | URL | A URL path to the API endpoint that retrieves the resource objects that represent the articles of the issue represented by the issue resource object | Yes |
Example Request, retrieving issue 121212145 for library 222:
GET https://public-api.thirdiron.com/public/v1/libraries/222/issues/121212145
Example Response:
{
"data": {
"id": 121212145,
"title": "Vol. 63",
"date": "2018-01-01",
"type": "issues",
"relationships": {
"journal": {
"links": {
"related": "/public/v1/libraries/222/journals/35087"
}
},
"articles": {
"links": {
"related": "/public/v1/libraries/222/issues/121212145/articles"
}
}
}
}
}