getRecord

1. Home
2. Adding a new media provider
3. eHUB Provider API Reference
4. getRecord

Fetches record metadata.

Request

GET /v1/records/<record id>

Response

    {
    "id": "<record id>",
    "formats": [
        {
        "id": "<format id>"
        },
        {
        "id": "<format id>"
        }
    ]
    }

The response lists the available format ids for a single record. The format ids are provider dependent and defined during the media provider configuration ex. eAudio. The returned list of formats could depend on the user_id parameter send in the Authorization header (see eHUB Provider API Security), so the user is presented with not all the formats ids, but only those he can actually borrow at the time of request (this feature is not mandatory). If the user already holds a loan on a media in a specific format it is preferred that this format id appears in the response. The details of the availability algorithm are media provider specific.

Example request:

GET /v1/records/recordId_0

Example response:

{
  "id": "recordId_0",
  "formats": [
    {
      "id": "ebook"
    },
    {
      "id": "audio-stream"
    },
    {
      "id": "audio-downloadable"
    }
  ]
}