GET api/book/{ean}/page/{page}/{size}

V2 - This method retrieves a specific page in base64 PNG format for for the given book.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ean

The EAN for which the page is requested

string

Required

page

The requested pagenumber.

integer

Required

size

The requested size in pixels. A page will not be upscaled, and this size will be applied to the largest dimension.

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

A YindoPermission object, which incluides the page in base64 format.

YindoPermission
NameDescriptionTypeAdditional information
isPermitted

Boolean value indicating if the specified page can be read.

boolean

None.

statusCode

This code indicates why a page cannot be read, if that is the case. When this value is zero (0), the page can be read and nothing is wrong. Possible values include:

  • -1 = the user is not allowed to view this page
  • 0 = OK
  • 1 = user is nog logged in
  • 2 = book ins not on Yindo bookshelf
  • 3 = this is not a free page
  • 4 = this page does not exist

integer

None.

pageNumber

The physical pagenumber that can be shown, or -1 if no page can be shown.

integer

None.

pageBox

Contains the string that can be shown in the pageBox.

string

None.

firstPageKey

Status knop Eerste pagina, bepaalt property ‘enabled’ in de reader. Retourneert true indien deze knop ingeschakeld moet zijn, false indien hij uitgeschakeld moet zijn.

boolean

None.

lastPageKey

boolean

None.

prevChapterKey

boolean

None.

nextChapterKey

boolean

None.

prevPageKey

boolean

None.

nextPageKey

boolean

None.

userID

The userID for the current user.

globally unique identifier

None.

ean

Usually this is the EAN for the book that can be read. In the case of custom books, this EAN might differ from the requested EAN.

string

None.

pageBitmapString

The base64 string for the png of the requested page.

string

None.

pageBitmapToken

The token needed to retrieve the actual PNG

string

None.

Response Formats

application/json, text/json

Sample:
{
  "isPermitted": true,
  "statusCode": 2,
  "pageNumber": 3,
  "pageBox": "sample string 4",
  "firstPageKey": true,
  "lastPageKey": true,
  "prevChapterKey": true,
  "nextChapterKey": true,
  "prevPageKey": true,
  "nextPageKey": true,
  "userID": "8a2c1196-651b-4254-bce3-805c674aff9f",
  "ean": "sample string 12",
  "pageBitmapString": "sample string 13",
  "pageBitmapToken": "sample string 14"
}

text/javascript

Sample:
{"isPermitted":true,"statusCode":2,"pageNumber":3,"pageBox":"sample string 4","firstPageKey":true,"lastPageKey":true,"prevChapterKey":true,"nextChapterKey":true,"prevPageKey":true,"nextPageKey":true,"userID":"8a2c1196-651b-4254-bce3-805c674aff9f","ean":"sample string 12","pageBitmapString":"sample string 13","pageBitmapToken":"sample string 14"}

application/xml, text/xml

Sample:
<YindoPermission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Yindo">
  <ean>sample string 12</ean>
  <firstPageKey>true</firstPageKey>
  <isPermitted>true</isPermitted>
  <lastPageKey>true</lastPageKey>
  <nextChapterKey>true</nextChapterKey>
  <nextPageKey>true</nextPageKey>
  <pageBitmapString>sample string 13</pageBitmapString>
  <pageBitmapToken>sample string 14</pageBitmapToken>
  <pageBox>sample string 4</pageBox>
  <pageNumber>3</pageNumber>
  <prevChapterKey>true</prevChapterKey>
  <prevPageKey>true</prevPageKey>
  <statusCode>2</statusCode>
  <userID>8a2c1196-651b-4254-bce3-805c674aff9f</userID>
</YindoPermission>