GET api/booklist/{id}

V1 - Gets the details for the specified booklist

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID for the booklist	integer	Required

Body Parameters

None.

Response Information

Resource Description

BookList

Name	Description	Type	Additional information
ID	The booklistID	integer	None.
Name	The name for this list	string	None.
OpenNetworkAccess	Does this list allow IP based access?	boolean	None.
Books		Collection of YindoBook	None.
Count		integer	None.
Status	YindoApiStatus defines statuscodes.	YindoApiStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "OpenNetworkAccess": true,
  "Books": [
    {
      "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": "2026-02-20T15:50:17.1462509+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
    },
    {
      "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": "2026-02-20T15:50:17.1462509+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
    }
  ],
  "Count": 2,
  "Status": {
    "Code": 0,
    "Text": "sample string 1"
  }
}

text/javascript

Sample:

{"ID":1,"Name":"sample string 2","OpenNetworkAccess":true,"Books":[{"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":"2026-02-20T15:50:17.1462509+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},{"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":"2026-02-20T15:50:17.1462509+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}],"Count":2,"Status":{"Code":0,"Text":"sample string 1"}}

application/xml, text/xml

Sample:

<BookList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Yindo.BLL.API">
  <Status>
    <Code>Success</Code>
    <Text>sample string 1</Text>
  </Status>
  <Books xmlns:d2p1="http://schemas.datacontract.org/2004/07/Yindo">
    <d2p1:YindoBook>
      <d2p1:ageIndicator>sample string 29</d2p1:ageIndicator>
      <d2p1:ageLevels xmlns:d4p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
        <d4p1:AgeLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AgeLevelDetails>
        <d4p1:AgeLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AgeLevelDetails>
      </d2p1:ageLevels>
      <d2p1:altean>sample string 3</d2p1:altean>
      <d2p1:authorName>sample string 7</d2p1:authorName>
      <d2p1:authorNames>
        <d2p1:YindoSimpleAuthor>
          <d2p1:authorID>2</d2p1:authorID>
          <d2p1:authorName>sample string 1</d2p1:authorName>
        </d2p1:YindoSimpleAuthor>
        <d2p1:YindoSimpleAuthor>
          <d2p1:authorID>2</d2p1:authorID>
          <d2p1:authorName>sample string 1</d2p1:authorName>
        </d2p1:YindoSimpleAuthor>
      </d2p1:authorNames>
      <d2p1:availablePageRange xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:availablePageRange>
      <d2p1:averageRating>30</d2p1:averageRating>
      <d2p1:aviLevels xmlns:d4p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
        <d4p1:AviLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AviLevelDetails>
        <d4p1:AviLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AviLevelDetails>
      </d2p1:aviLevels>
      <d2p1:bookID>1</d2p1:bookID>
      <d2p1:categories xmlns:d4p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
        <d4p1:CategoryDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CategoryDetails>
        <d4p1:CategoryDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CategoryDetails>
      </d2p1:categories>
      <d2p1:credits>8</d2p1:credits>
      <d2p1:description>sample string 9</d2p1:description>
      <d2p1:ean>sample string 2</d2p1:ean>
      <d2p1:firstAuthorID>6</d2p1:firstAuthorID>
      <d2p1:firstAuthorName>sample string 5</d2p1:firstAuthorName>
      <d2p1:freePageRange xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:freePageRange>
      <d2p1:hasToc>true</d2p1:hasToc>
      <d2p1:height>23</d2p1:height>
      <d2p1:isAvailable>true</d2p1:isAvailable>
      <d2p1:isBookOnShelf>true</d2p1:isBookOnShelf>
      <d2p1:isFavorite>true</d2p1:isFavorite>
      <d2p1:isInSubscription>true</d2p1:isInSubscription>
      <d2p1:languageID>18</d2p1:languageID>
      <d2p1:lastPageRead>25</d2p1:lastPageRead>
      <d2p1:modifiedOn>2026-02-20T15:50:17.1462509+01:00</d2p1:modifiedOn>
      <d2p1:numBookPrices>17</d2p1:numBookPrices>
      <d2p1:numPages>12</d2p1:numPages>
      <d2p1:offSet>11</d2p1:offSet>
      <d2p1:orientation>sample string 21</d2p1:orientation>
      <d2p1:priceInEuro>sample string 20</d2p1:priceInEuro>
      <d2p1:publisherID>13</d2p1:publisherID>
      <d2p1:publisherName>sample string 14</d2p1:publisherName>
      <d2p1:serieID>15</d2p1:serieID>
      <d2p1:serieName>sample string 16</d2p1:serieName>
      <d2p1:title>sample string 4</d2p1:title>
      <d2p1:width>22</d2p1:width>
    </d2p1:YindoBook>
    <d2p1:YindoBook>
      <d2p1:ageIndicator>sample string 29</d2p1:ageIndicator>
      <d2p1:ageLevels xmlns:d4p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
        <d4p1:AgeLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AgeLevelDetails>
        <d4p1:AgeLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AgeLevelDetails>
      </d2p1:ageLevels>
      <d2p1:altean>sample string 3</d2p1:altean>
      <d2p1:authorName>sample string 7</d2p1:authorName>
      <d2p1:authorNames>
        <d2p1:YindoSimpleAuthor>
          <d2p1:authorID>2</d2p1:authorID>
          <d2p1:authorName>sample string 1</d2p1:authorName>
        </d2p1:YindoSimpleAuthor>
        <d2p1:YindoSimpleAuthor>
          <d2p1:authorID>2</d2p1:authorID>
          <d2p1:authorName>sample string 1</d2p1:authorName>
        </d2p1:YindoSimpleAuthor>
      </d2p1:authorNames>
      <d2p1:availablePageRange xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:availablePageRange>
      <d2p1:averageRating>30</d2p1:averageRating>
      <d2p1:aviLevels xmlns:d4p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
        <d4p1:AviLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AviLevelDetails>
        <d4p1:AviLevelDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:AviLevelDetails>
      </d2p1:aviLevels>
      <d2p1:bookID>1</d2p1:bookID>
      <d2p1:categories xmlns:d4p1="http://schemas.datacontract.org/2004/07/Yindo.DAL.Types">
        <d4p1:CategoryDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CategoryDetails>
        <d4p1:CategoryDetails>
          <d4p1:Description>sample string 3</d4p1:Description>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Name>sample string 2</d4p1:Name>
        </d4p1:CategoryDetails>
      </d2p1:categories>
      <d2p1:credits>8</d2p1:credits>
      <d2p1:description>sample string 9</d2p1:description>
      <d2p1:ean>sample string 2</d2p1:ean>
      <d2p1:firstAuthorID>6</d2p1:firstAuthorID>
      <d2p1:firstAuthorName>sample string 5</d2p1:firstAuthorName>
      <d2p1:freePageRange xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:freePageRange>
      <d2p1:hasToc>true</d2p1:hasToc>
      <d2p1:height>23</d2p1:height>
      <d2p1:isAvailable>true</d2p1:isAvailable>
      <d2p1:isBookOnShelf>true</d2p1:isBookOnShelf>
      <d2p1:isFavorite>true</d2p1:isFavorite>
      <d2p1:isInSubscription>true</d2p1:isInSubscription>
      <d2p1:languageID>18</d2p1:languageID>
      <d2p1:lastPageRead>25</d2p1:lastPageRead>
      <d2p1:modifiedOn>2026-02-20T15:50:17.1462509+01:00</d2p1:modifiedOn>
      <d2p1:numBookPrices>17</d2p1:numBookPrices>
      <d2p1:numPages>12</d2p1:numPages>
      <d2p1:offSet>11</d2p1:offSet>
      <d2p1:orientation>sample string 21</d2p1:orientation>
      <d2p1:priceInEuro>sample string 20</d2p1:priceInEuro>
      <d2p1:publisherID>13</d2p1:publisherID>
      <d2p1:publisherName>sample string 14</d2p1:publisherName>
      <d2p1:serieID>15</d2p1:serieID>
      <d2p1:serieName>sample string 16</d2p1:serieName>
      <d2p1:title>sample string 4</d2p1:title>
      <d2p1:width>22</d2p1:width>
    </d2p1:YindoBook>
  </Books>
  <ID>1</ID>
  <Name>sample string 2</Name>
  <OpenNetworkAccess>true</OpenNetworkAccess>
</BookList>