Versions Compared

Key

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

...

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

Lookup Journal by Id Request

...

Supported Methods

GET

Endpoint Location

/public/v1/libraries/:library_id/journals/:journal_id

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

Lookup Journal by Id Response

...

The Lookup Journal by Id endpoint responds with a blob of JSON data that contains a journal resource object that represents the journal with the specified id.

Response Object

...

Property

Type

Description

data

Object

A journal resource object is returned here which represents the journal in the Third Iron metadata database which has the specified id.


Journal Resource

...

A journal resource object represents a journal in the Third Iron metadata database.

...