...
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 journal whose current issue you are trying to retrieve, and your application will get a response representing that journal's current issue. Responses contain some metadata for the issue, such as a display name. Responses also contain links to API endpoints through which metadata resources related to the issue, such as a list of its articles, may be retrieved.
Retrieve Current Issue of a Journal Request
...
Supported Methods |
|---|
|
Endpoint Location |
|---|
| |
Endpoint Parameters | |
:library_id | Replace the :library_id portion of the endpoint path with the id # of your library |
:journal_id | Replace the journal_id portion of the path with the id number for the journal whose current issue you wish to retrieve |
Retrieve Current Issue of a Journal Response
...
The Retrieve Current Issue of a Journal endpoint responds with a blob of JSON data that contains an issue resource object that represents the current issue of the journal with the specified id.
Response Object
...
Property | Type | Description |
|---|---|---|
data | Object | An issue resource object is returned here which represents the current issue in the Third Iron metadata database of the journal 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 |
Examples
Example Request, retrieving current issue of journal 35087 for library 222
...
| Code Block | ||
|---|---|---|
| ||
GET https://public-api.thirdiron.com/public/v1/libraries/222/journals/35087/issues/current |
Example Response
...
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"id": 217042388,
"title": "Vol. 64",
"date": "2019-01-01",
"type": "issues",
"relationships": {
"journal": {
"links": {
"related": "/public/v1/libraries/222/journals/35087"
}
},
"articles": {
"links": {
"related": "/public/v1/libraries/222/issues/217042388/articles"
}
}
}
}
} |
...