API V1.0 User History

User History

URIDetailsResponse
api.bookshare.org/user/history/for/Text User History User History List Response

Retrieve the list of books that a user has requested for download, over a period of time. Since certain types of books, such as those containing images, require additional time to prepare for a user, the history also includes a status for each request to indicate whether it is ready to be downloaded or is still in the process of being prepared.

User History

Response Details

User History List Response

Container: book/history

Fields

FieldTypeDescriptionOccurence
start-date Date The starting date of the history, default to one month previous 1
end-date Date The ending date of the history, default to today 1

Container: book/history/list/result

FieldTypeDescriptionOccurence
id Number Id that can be used in download request 1
title Text The title of the book 1
author Text The, or one of the, author(s) of the book 1/N
brief-synopsis Text Brief synopsis about this book 0/1
isbn-13 Number The 13-digit ISBN, if known 0/1
publisher Text The publisher of the book, if known 0/1
download-format Text

The format in which the book was requested.  One of the following:

  • BRF
  • DAISY
  • DAISY_SEGMENTED: DAISY with multiple DTBooks
  • DAISY_WITH_IMAGES *
  • EPUB 3 *
  • PDF *+

Notes:

  • * Format that requires asynchronous packaging need to check packaging status before downloading
  • + Format that is being used for some titiles in RNIB's private library 
 1
download-date Date The date that the download was performed 1
packaging-status Text

The current status of the download. One of the following:

  • SCHEDULED_FOR_PACKAGING: It is in the process of being prepared for download
  • READY_FOR_DOWNLOAD: It is packaged for this user, but has not been downloaded yet.
  • DOWNLOADED: It has been packaged and downloaded already.
  • PACKAGING_FAILED: There was an error during the packaging and is not currently available.
 1

XML Example

<bookshare>
  <version>4.0.2</version>
    <messages>
      <string>Results 1-2 of 2</string> 
    </messages>
    <book>
        <history>
            <start-date>10022012</start-date>
            <end-date>10252012</end-date>
            <list>
                <page>1</page>
                <limit>2</limit>
                <num-pages>1</num-pages>
                <result>
                    <id>286066</id>
                    <title>The Art of Fiction: Notes on Craft for Young Writers</title>
                    <author>John Gardner</author>
                    <brief-synopsis>The Art of Fiction will fascinate anyone interested in how fiction gets put together.</brief-synopsis>
                    <isbn13>9781609800482</isbn13>
                    <publisher>Seven Stories Press</publisher>
                    <download-format>DAISY_WITH_IMAGES</download-format>
                    <download-date>10242012</download-date>
                    <packaging-status>SCHEDULED_FOR_PACKAGING</packaging-status>
                </result>
                <result>
                    <id>286069</id>
                    <title>Little Women</title>
                    <author>Louisa May Alcott</author>
                    <brief-synopsis>Little Women is one of the  best loved books of all time.</brief-synopsis>
                    <isbn13>9781583229958</isbn13>
                    <publisher>Ten Speed Press</publisher>  
                    <download-format>DAISY</download-format>
                    <download-date>10242012</download-date>
                    <packaging-status>READY_FOR_DOWNLOAD</packaging-status>
                </result>
            </list>
        </history>
    </book>
</bookshare>