Get Books

Overview

You can use this call to get books in the database. You can do a search for all books or use parameters and filters to looks for books that match specific criteria.

URI

\http://|api_url|/api/fab/v3/book/?format=json

Parameters

You can use these parameters in your request for books. The examples sections shows how you can combine different parameters to refine your search.

Parameter Type Description
ISBN String International Standard Book Number
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
booktype String Type of book, e.g. Fiction
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
lexile_code String Lexile Code, e.g. GN (graphic novel)
lexile_code_spanish String Lexile Code for Spanish Lexile measure if available
word_count Integer Number of words contained in the book
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
keyword String List of keywords
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
serial Integer Serial Number this Resource was last modified on You can use the following filters with this parameter:
  • gt (greater than)
id Integer Identifier
max_age Integer Max age of book
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
call_number String Call Number
copyright String Copyright year
author String Book Author(s)
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
lexile Integer Lexile Measure
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
categories_display String List of categories
timestamp Datetime Date and time the book record was last modified You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
min_age Integer Minimum age of book
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
pages Integer Number of pages contained in the book
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
categories Related List of URIs or individually nested resource data
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
publisher String Book publisher
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
language String Book's written language
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
ISBN13 String 13-digit ISBN
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
lexile_spanish Integer Spanish Lexile Measure
word_count_spanish Integer Number of words in Spanish version of book
summary String Summary of the book
title String Book Title
You can use the following filters with this parameter:
  • gt (greater than)
  • gte (greater than or equal to)
  • lt (less than)
  • lte (less than or equal to)
  • contains (contains the value)
resource_uri String The resource url for accessing this resource directly

Response

The response can return any of the parameters defined in the request table. It will also return the following metadata. 
{"meta":{"limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1}
Parameter Description
limit By default only 20 objects are sent back in each response. You can increase or decrease this limit by supplying a limit filter on your query.
next The url for you to fetch the next set of results in your query. This url will not be a fully qualified url but instead relative to the base url we discussed earlier. If the value is none there is not another set of results and you have reached the last "page".
offset The number of records you are offsetting this result by. For example if you had a limit of 20 and there were 100 total records. If you had an offset of 60 that would mean you are looking at records 61-80.
previous Same as next but refers to the previous set of results. If this is null there are no previous sets available.
total_count The total number of results in the query. For example if you had a query that generated 100 results this number would be 100.
resource_uri

There is a resource_uri for the category and the book. This is the url you will use to obtain information about that particular object. Like the next and previous urls, this is not fully qualified and is relative to the base url discussed earlier.

Examples

The following are some example queries to get you started.

Find a book by its ISBN:

\http://|api_url|/api/fab/v3/book/?format=json&ISBN=0743906608

Find Books with a lexile measure between 600L and 800L:

\http://|api_url|/api/fab/v3/book/?lexile__lte=800&lexile__gte=600&format=json
Find Books with an author where the name contains John:
\http://|api_url|/api/fab/v3/book/?author__contains=John&format=json

Find Spanish language books with number of pages less than or equal to 30:

\https://|api_url|/api/fab/v3/book/?language=Spanish&pages__lte=30&format=json

Retrieve all the books:

\http://|api_url|/api/fab/v3/book/?format=json

Retrieve all the books last updated on or after May 5th, 2013:

\http://|api_url|/api/fab/v3/book/?timestamp__gte=2013-04-05&format=json