I/O Docs: API Documentation

• Book Requests

  • List Methods
  • Expand Methods

  • GET ISBN Lookup /book/isbn/:isbn/format/:format

    Parameter	Value	Type	Description
    :isbn		string	13 or 10 digit ISBN
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Book Id Lookup /book/id/:id/format/:format

    Parameter	Value	Type	Description
    :id		string	Bookshare Id that is part of the Book List Response
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Full Text Search /book/searchFTS/:text/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :text		string	String to search matching author, title or content in the book.
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Title Search /book/search/title/:text/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :text		string	String to search matching the title
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Author Search /book/search/author/:text/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :text		string	String to search matching the author
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Title/Author Search /book/search/:text/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :text		string	String to search matching the title or author
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Date Published Search /book/search/since/:date/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :date		string	Date in MMDDYYYY format
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Browse Latest /book/latest/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Browse Popular /book/popular/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Category List /reference/category/list/format/:format

    Parameter	Value	Type	Description
    page		number	Which page of results to show (default 1)
    limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Category Search /book/search/category/:category/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :category		string	Valid category value from Category List
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Grade List /reference/grade/list/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Grade Search /book/search/grade/:grade/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :grade		string	Valid grade value from Grade List
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Combining Multiple Search Criteria /book/search/grade/:grade/category/:category/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :grade		string	Valid grade value from Grade List
    :category		string	Valid category value from Category List
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

• Newspaper / Magazine Requests

  • List Methods
  • Expand Methods

  • GET Periodical List Search /periodical/list/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Periodical Edition Search /periodical/id/:id/page/:page/limit/:limit/format/:format

    Parameter	Value	Type	Description
    :id		string	Bookshare Id that is part of the Periodical List Response
    :page		number	Which page of results to show (default 1)
    :limit		number	How many results to show in a List Response (default 100, maximum limit is 250 results; any specified limit over this will be rounded down to 250).
    :format	xml json	enumerated	Response format (defaults to xml)

  • GET Periodical Edition Lookup /periodical/id/:id/edition/:date/revision/:revision

    Parameter	Value	Type	Description
    :id		string	Bookshare Id that is part of the Periodical List Response
    :date		string	Date in MMDDYYYY format
    :revision		number	Revision number