GET api/books/{ageLevel}/{count}
V2 - Retrieves a list of books.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ageLevel |
the ID for the age level |
integer |
Required |
count |
het (maximaal) aantal boeken |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
IEnumerable collection YindoBooks
Collection of YindoBookName | Description | Type | Additional information |
---|---|---|---|
bookID |
The ID for this book |
integer |
None. |
ean |
A 13 digit EAN. This starts with 978- for 'real' books and with 888- for Yindo Custom Books |
string |
None. |
altean |
A 13 digit EAN. This starts with 978- for 'real' books and with 888- for Yindo Custom Books |
string |
None. |
title |
The title for this book. |
string |
None. |
firstAuthorName |
The name for the first author of this book. |
string |
None. |
firstAuthorID |
The ID for the first author of this book. |
integer |
None. |
authorName |
The list of authors for this book, in a single comma separated string. |
string |
None. |
authorNames |
The list of authors for this book. |
Collection of YindoSimpleAuthor |
None. |
credits |
The number of credits required to read this book for one month (of this option is available, otherwise the amount is for permanent purchase). |
decimal number |
None. |
description |
A description of the book. |
string |
None. |
isBookOnShelf |
Boolean value indicating if this book is cuurently on a users bookshelf. |
boolean |
None. |
offSet |
The size of the prework. |
integer |
None. |
numPages |
The total number of physical pages in this book. |
integer |
None. |
publisherID |
The ID for the publisher. |
integer |
None. |
publisherName |
The name of the publisher. |
string |
None. |
serieID |
The ID for the series this book is part of, if any. |
integer |
None. |
serieName |
The name of the series this book is part of, if any. |
string |
None. |
numBookPrices |
The number of available buying options. |
integer |
None. |
languageID |
The languageID identifies the language in which the book was written.
|
integer |
None. |
isInSubscription |
Boolean value indicating if this book is part of one or more subscriptions. |
boolean |
None. |
priceInEuro |
The price for this book in eurocents. |
string |
None. |
availablePageRange |
A list of pagenumbers that can be read. For preview purposes this list will contain the free pages. When a user has full reading rights to a book (due to a subscription or purchase) the list will contain all pages. |
Collection of integer |
None. |
freePageRange |
A list of pagenumbers that can be read. For preview purposes this list will contain the free pages. When a user has full reading rights to a book (due to a subscription or purchase) the list will contain all pages. |
Collection of integer |
None. |
orientation |
Page orientarion. Possible values are:
|
string |
None. |
width |
Width of the png-page in pixels |
integer |
None. |
height |
Height of the png-page in pixels. |
integer |
None. |
isFavorite |
Boolean value indicating if this book is a favorite for the currently logged in user. |
boolean |
None. |
lastPageRead |
The last page read by the currently logged in user. The value will be -1 if this book hasn't been read yet, of if the book is not on the conventional Yindo bookshelf. |
integer |
None. |
isAvailable |
Boolean value indicating i the book is available. |
boolean |
None. |
modifiedOn |
The last modification date for this books data. |
date |
Data type: DateTime |
hasToc |
Boolean value indicating if this book has a Table of Contents. |
boolean |
None. |
ageIndicator |
deprecated The ageIndicator was used by Boekenwolk, nut will be removed in a future release. |
string |
None. |
aviLevels |
A list of aviLevels this book is linked to. |
Collection of AviLevelDetails |
None. |
ageLevels |
A list of ageLevels this book is linked to. |
Collection of AgeLevelDetails |
None. |
categories |
A list of categories into which this book falls. |
Collection of CategoryDetails |
None. |
averageRating |
The average of all user ratings for this book. |
integer |
None. |
IPreading |
Are we in IP reading mode? |
boolean |
None. |
sessionKey |
The key for this user-session |
string |
None. |
sessionIndex |
The current session index out of all available sessions |
integer |
None. |
sessionsAvailable |
The number of available sessions for this book/IP |
integer |
None. |
sessionQueueIndex |
The index into the queue |
integer |
None. |
Response Formats
application/json, text/json
[ { "bookID": 1, "ean": "sample string 2", "altean": "sample string 3", "title": "sample string 4", "firstAuthorName": "sample string 5", "firstAuthorID": 6, "authorName": "sample string 7", "authorNames": [ { "authorName": "sample string 1", "authorID": 2 }, { "authorName": "sample string 1", "authorID": 2 } ], "credits": 8.0, "description": "sample string 9", "isBookOnShelf": true, "offSet": 11, "numPages": 12, "publisherID": 13, "publisherName": "sample string 14", "serieID": 15, "serieName": "sample string 16", "numBookPrices": 17, "languageID": 18, "isInSubscription": true, "priceInEuro": "sample string 20", "availablePageRange": [ 1, 2 ], "freePageRange": [ 1, 2 ], "orientation": "sample string 21", "width": 22, "height": 23, "isFavorite": true, "lastPageRead": 25, "isAvailable": true, "modifiedOn": "2024-12-13T19:04:59.3289342+01:00", "hasToc": true, "ageIndicator": "sample string 29", "aviLevels": [ { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" }, { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" } ], "ageLevels": [ { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" }, { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" } ], "categories": [ { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" }, { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" } ], "averageRating": 30, "IPreading": true, "sessionKey": "sample string 32", "sessionIndex": 33, "sessionsAvailable": 34, "sessionQueueIndex": 35 }, { "bookID": 1, "ean": "sample string 2", "altean": "sample string 3", "title": "sample string 4", "firstAuthorName": "sample string 5", "firstAuthorID": 6, "authorName": "sample string 7", "authorNames": [ { "authorName": "sample string 1", "authorID": 2 }, { "authorName": "sample string 1", "authorID": 2 } ], "credits": 8.0, "description": "sample string 9", "isBookOnShelf": true, "offSet": 11, "numPages": 12, "publisherID": 13, "publisherName": "sample string 14", "serieID": 15, "serieName": "sample string 16", "numBookPrices": 17, "languageID": 18, "isInSubscription": true, "priceInEuro": "sample string 20", "availablePageRange": [ 1, 2 ], "freePageRange": [ 1, 2 ], "orientation": "sample string 21", "width": 22, "height": 23, "isFavorite": true, "lastPageRead": 25, "isAvailable": true, "modifiedOn": "2024-12-13T19:04:59.3289342+01:00", "hasToc": true, "ageIndicator": "sample string 29", "aviLevels": [ { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" }, { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" } ], "ageLevels": [ { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" }, { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" } ], "categories": [ { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" }, { "ID": 1, "Name": "sample string 2", "Description": "sample string 3" } ], "averageRating": 30, "IPreading": true, "sessionKey": "sample string 32", "sessionIndex": 33, "sessionsAvailable": 34, "sessionQueueIndex": 35 } ]
text/javascript
[{"bookID":1,"ean":"sample string 2","altean":"sample string 3","title":"sample string 4","firstAuthorName":"sample string 5","firstAuthorID":6,"authorName":"sample string 7","authorNames":[{"authorName":"sample string 1","authorID":2},{"authorName":"sample string 1","authorID":2}],"credits":8.0,"description":"sample string 9","isBookOnShelf":true,"offSet":11,"numPages":12,"publisherID":13,"publisherName":"sample string 14","serieID":15,"serieName":"sample string 16","numBookPrices":17,"languageID":18,"isInSubscription":true,"priceInEuro":"sample string 20","availablePageRange":[1,2],"freePageRange":[1,2],"orientation":"sample string 21","width":22,"height":23,"isFavorite":true,"lastPageRead":25,"isAvailable":true,"modifiedOn":"2024-12-13T19:04:59.3289342+01:00","hasToc":true,"ageIndicator":"sample string 29","aviLevels":[{"ID":1,"Name":"sample string 2","Description":"sample string 3"},{"ID":1,"Name":"sample string 2","Description":"sample string 3"}],"ageLevels":[{"ID":1,"Name":"sample string 2","Description":"sample string 3"},{"ID":1,"Name":"sample string 2","Description":"sample string 3"}],"categories":[{"ID":1,"Name":"sample string 2","Description":"sample string 3"},{"ID":1,"Name":"sample string 2","Description":"sample string 3"}],"averageRating":30,"IPreading":true,"sessionKey":"sample string 32","sessionIndex":33,"sessionsAvailable":34,"sessionQueueIndex":35},{"bookID":1,"ean":"sample string 2","altean":"sample string 3","title":"sample string 4","firstAuthorName":"sample string 5","firstAuthorID":6,"authorName":"sample string 7","authorNames":[{"authorName":"sample string 1","authorID":2},{"authorName":"sample string 1","authorID":2}],"credits":8.0,"description":"sample string 9","isBookOnShelf":true,"offSet":11,"numPages":12,"publisherID":13,"publisherName":"sample string 14","serieID":15,"serieName":"sample string 16","numBookPrices":17,"languageID":18,"isInSubscription":true,"priceInEuro":"sample string 20","availablePageRange":[1,2],"freePageRange":[1,2],"orientation":"sample string 21","width":22,"height":23,"isFavorite":true,"lastPageRead":25,"isAvailable":true,"modifiedOn":"2024-12-13T19:04:59.3289342+01:00","hasToc":true,"ageIndicator":"sample string 29","aviLevels":[{"ID":1,"Name":"sample string 2","Description":"sample string 3"},{"ID":1,"Name":"sample string 2","Description":"sample string 3"}],"ageLevels":[{"ID":1,"Name":"sample string 2","Description":"sample string 3"},{"ID":1,"Name":"sample string 2","Description":"sample string 3"}],"categories":[{"ID":1,"Name":"sample string 2","Description":"sample string 3"},{"ID":1,"Name":"sample string 2","Description":"sample string 3"}],"averageRating":30,"IPreading":true,"sessionKey":"sample string 32","sessionIndex":33,"sessionsAvailable":34,"sessionQueueIndex":35}]
application/xml, text/xml
<ArrayOfYindoBook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Yindo"> <YindoBook> <IPreading>true</IPreading> <ageIndicator>sample string 29</ageIndicator> <ageLevels xmlns:d3p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types"> <d3p1:AgeLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AgeLevelDetails> <d3p1:AgeLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AgeLevelDetails> </ageLevels> <altean>sample string 3</altean> <authorName>sample string 7</authorName> <authorNames> <YindoSimpleAuthor> <authorID>2</authorID> <authorName>sample string 1</authorName> </YindoSimpleAuthor> <YindoSimpleAuthor> <authorID>2</authorID> <authorName>sample string 1</authorName> </YindoSimpleAuthor> </authorNames> <availablePageRange xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </availablePageRange> <averageRating>30</averageRating> <aviLevels xmlns:d3p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types"> <d3p1:AviLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AviLevelDetails> <d3p1:AviLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AviLevelDetails> </aviLevels> <bookID>1</bookID> <categories xmlns:d3p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types"> <d3p1:CategoryDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:CategoryDetails> <d3p1:CategoryDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:CategoryDetails> </categories> <credits>8</credits> <description>sample string 9</description> <ean>sample string 2</ean> <firstAuthorID>6</firstAuthorID> <firstAuthorName>sample string 5</firstAuthorName> <freePageRange xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </freePageRange> <hasToc>true</hasToc> <height>23</height> <isAvailable>true</isAvailable> <isBookOnShelf>true</isBookOnShelf> <isFavorite>true</isFavorite> <isInSubscription>true</isInSubscription> <languageID>18</languageID> <lastPageRead>25</lastPageRead> <modifiedOn>2024-12-13T19:04:59.3289342+01:00</modifiedOn> <numBookPrices>17</numBookPrices> <numPages>12</numPages> <offSet>11</offSet> <orientation>sample string 21</orientation> <priceInEuro>sample string 20</priceInEuro> <publisherID>13</publisherID> <publisherName>sample string 14</publisherName> <serieID>15</serieID> <serieName>sample string 16</serieName> <sessionIndex>33</sessionIndex> <sessionKey>sample string 32</sessionKey> <sessionQueueIndex>35</sessionQueueIndex> <sessionsAvailable>34</sessionsAvailable> <title>sample string 4</title> <width>22</width> </YindoBook> <YindoBook> <IPreading>true</IPreading> <ageIndicator>sample string 29</ageIndicator> <ageLevels xmlns:d3p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types"> <d3p1:AgeLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AgeLevelDetails> <d3p1:AgeLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AgeLevelDetails> </ageLevels> <altean>sample string 3</altean> <authorName>sample string 7</authorName> <authorNames> <YindoSimpleAuthor> <authorID>2</authorID> <authorName>sample string 1</authorName> </YindoSimpleAuthor> <YindoSimpleAuthor> <authorID>2</authorID> <authorName>sample string 1</authorName> </YindoSimpleAuthor> </authorNames> <availablePageRange xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </availablePageRange> <averageRating>30</averageRating> <aviLevels xmlns:d3p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types"> <d3p1:AviLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AviLevelDetails> <d3p1:AviLevelDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:AviLevelDetails> </aviLevels> <bookID>1</bookID> <categories xmlns:d3p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types"> <d3p1:CategoryDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:CategoryDetails> <d3p1:CategoryDetails> <d3p1:Description>sample string 3</d3p1:Description> <d3p1:ID>1</d3p1:ID> <d3p1:Name>sample string 2</d3p1:Name> </d3p1:CategoryDetails> </categories> <credits>8</credits> <description>sample string 9</description> <ean>sample string 2</ean> <firstAuthorID>6</firstAuthorID> <firstAuthorName>sample string 5</firstAuthorName> <freePageRange xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </freePageRange> <hasToc>true</hasToc> <height>23</height> <isAvailable>true</isAvailable> <isBookOnShelf>true</isBookOnShelf> <isFavorite>true</isFavorite> <isInSubscription>true</isInSubscription> <languageID>18</languageID> <lastPageRead>25</lastPageRead> <modifiedOn>2024-12-13T19:04:59.3289342+01:00</modifiedOn> <numBookPrices>17</numBookPrices> <numPages>12</numPages> <offSet>11</offSet> <orientation>sample string 21</orientation> <priceInEuro>sample string 20</priceInEuro> <publisherID>13</publisherID> <publisherName>sample string 14</publisherName> <serieID>15</serieID> <serieName>sample string 16</serieName> <sessionIndex>33</sessionIndex> <sessionKey>sample string 32</sessionKey> <sessionQueueIndex>35</sessionQueueIndex> <sessionsAvailable>34</sessionsAvailable> <title>sample string 4</title> <width>22</width> </YindoBook> </ArrayOfYindoBook>