Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note

This page is deprecated

Please see Data Service API Endpoints for links to updated documentation.


The “Retrieve Issues of a Journal” endpoint allows a client to retrieve the metadata for issues published for a given journal in the Third Iron metadata database.


Note

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 journal whose issues you are trying to retrieve, and your application will get a response representing that journal's issues. Responses contain some metadata about each issue, such as a display name for the issue. Responses also contain links to API endpoints through which metadata resources related to each issue, such as a list of the issue's articles, may be retrieved.  

Retrieve Issues of a Journal Request:

Supported Methods


Code Block
GET


Endpoint Location


Code Block
languagetext
/public/v1/libraries/:library_id/journals/:journal_id/issues


Endpoint Parameters


:library_idReplace 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 issues you wish to retrieve


Retrieve Issues of a Journal Response:

The Retrieve Issues of a Journal endpoint responds with a blob of JSON data that contains an array of issue resource objects that represent the issues of the journal with the specified id.

Response Object:
PropertyTypeDescription
dataArray of Object

An array of issue resource objects is returned here which represents the issues in the Third Iron metadata database of the journal which has the specified id.


Journal Resource:

An issue resource object represents an issue in the Third Iron metadata database.

...

PropertyTypeDescriptionOptional
idnumber

The issue's unique id in the Browzine system

No
typestring

has the value “issues”

No
titlestring

The issue’s title for display (typically “Vol. # Issue #”)

No
datestring

The publication date of the issue expressed in ISO date format (YYYY-MM-DD)

No
relationshipsObject

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 issues of journal 35087 for library 222:
Code Block
languagetext
GET https://public-api.thirdiron.com/public/v1/libraries/222/journals/35087/issues

Example Response:
Code Block
languagejs
{
    "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"
                    }
                }
            }
        },
        {
            "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"
                    }
                }
            }
        },
        {
            "id": 8457802,
            "title": "Vol. 62",
            "date": "2017-01-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/8457802/articles"
                    }
                }
            }
        },
        {
            "id": 7707389,
            "title": "Vol. 61",
            "date": "2016-01-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/7707389/articles"
                    }
                }
            }
        },
        {
            "id": 7786133,
            "title": "Vol. 60",
            "date": "2015-01-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/7786133/articles"
                    }
                }
            }
        },
        {
            "id": 7070591,
            "title": "Vol. 59",
            "date": "2014-01-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/7070591/articles"
                    }
                }
            }
        },
        {
            "id": 6542551,
            "title": "Vol. 57 Issue 4",
            "date": "2012-12-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542551/articles"
                    }
                }
            }
        },
        {
            "id": 6542548,
            "title": "Vol. 57 Issue 3",
            "date": "2012-09-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542548/articles"
                    }
                }
            }
        },
        {
            "id": 6542547,
            "title": "Vol. 57 Issue 2",
            "date": "2012-06-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542547/articles"
                    }
                }
            }
        },
        {
            "id": 6542546,
            "title": "Vol. 57 Issue 1",
            "date": "2012-03-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542546/articles"
                    }
                }
            }
        },
        {
            "id": 6542545,
            "title": "Vol. 56 Issue 4",
            "date": "2011-12-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542545/articles"
                    }
                }
            }
        },
        {
            "id": 6542543,
            "title": "Vol. 56 Issue 3",
            "date": "2011-09-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542543/articles"
                    }
                }
            }
        },
        {
            "id": 6542534,
            "title": "Vol. 56 Issue 2",
            "date": "2011-06-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542534/articles"
                    }
                }
            }
        },
        {
            "id": 6542542,
            "title": "Vol. 56 Issue 1",
            "date": "2011-03-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542542/articles"
                    }
                }
            }
        },
        {
            "id": 6542541,
            "title": "Vol. 55 Issue 4",
            "date": "2010-12-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542541/articles"
                    }
                }
            }
        },
        {
            "id": 6542535,
            "title": "Vol. 55 Issue 3",
            "date": "2010-09-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542535/articles"
                    }
                }
            }
        },
        {
            "id": 6542533,
            "title": "Vol. 55 Issue 2",
            "date": "2010-06-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542533/articles"
                    }
                }
            }
        },
        {
            "id": 6542532,
            "title": "Vol. 55 Issue 1",
            "date": "2010-03-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542532/articles"
                    }
                }
            }
        },
        {
            "id": 6542531,
            "title": "Vol. 54 Issue 4",
            "date": "2009-12-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542531/articles"
                    }
                }
            }
        },
        {
            "id": 6542530,
            "title": "Vol. 54 Issue 3",
            "date": "2009-09-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542530/articles"
                    }
                }
            }
        },
        {
            "id": 6542529,
            "title": "Vol. 54 Issue 2",
            "date": "2009-06-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542529/articles"
                    }
                }
            }
        },
        {
            "id": 6542536,
            "title": "Vol. 54 Issue 1",
            "date": "2009-03-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542536/articles"
                    }
                }
            }
        },
        {
            "id": 6542540,
            "title": "Vol. 53 Issue 4",
            "date": "2008-12-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542540/articles"
                    }
                }
            }
        },
        {
            "id": 6542539,
            "title": "Vol. 53 Issue 3",
            "date": "2008-09-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542539/articles"
                    }
                }
            }
        },
        {
            "id": 6542538,
            "title": "Vol. 53 Issue 2",
            "date": "2008-06-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542538/articles"
                    }
                }
            }
        },
        {
            "id": 6542537,
            "title": "Vol. 53 Issue 1",
            "date": "2008-01-01",
            "type": "issues",
            "relationships": {
                "journal": {
                    "links": {
                        "related": "/public/v1/libraries/222/journals/35087"
                    }
                },
                "articles": {
                    "links": {
                        "related": "/public/v1/libraries/222/issues/6542537/articles"
                    }
                }
            }
        }
    ]
}

...