Bookshare Web Service (Revised)

compared with
Current by Rom Srinivasan
on Jul 18, 2011 17:24.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (18)

View Page History
h1. Bookshare Web Service

*\*The most recent documentation of the web service API calls is now available* *[here|http://developer.bookshare.org/docs/read/api_overview/Request_and_Result_Formats]*
*\*The most recent documentation of the web service API calls is now available at* *[Mashery|http://developer.bookshare.org/docs/read/api_overview/Request_and_Result_Formats]**.*

{toc}



|| URI || Details || Response ||
| service.bookshare.org/book/isbn/[#Text] | [#ISBN Lookup] | [#Book Metadata Response] |



|| URI || Details || Response ||
| service.bookshare.org/periodical/id/[#Number] | [#Periodical Edition Search] | [#Periodical List Response] |



|| URI || Details || Response ||
| service.bookshare.org/download/for/[#Text]/content/[#Number]/version/[#Number] | [#Download Request] | [#Binary Download] |



|| URI || Details || Response ||
| service.bookshare.org/user/for/[#Text]/preferences/list | [#User Preference Search] | [#User Preference List Response] |



|| Id || Field Description || Occurrence || Editable || Additional Notes ||
| 01 | Adult Content Filtering | 1 | Yes | Always available in the results |



|| Field || Type || Description || Occurrence ||
| content-id | [#Number] | Id that can be used in [#Download Request] | 1 |



|| Field || Type || Description || Occurrence ||
| isbn-10 | [#Text] | The 10 digit ISBN, if known | 0/1 |



|| Field || Type || Description || Occurrence ||
| edition | [#Date] | The edition date | 1 |



|| Field || Type || Description || Occurrence ||
| page | [#Number] | Which page of results this represents | 1 |



|| Field || Type || Description || Occurrence ||
| id | [#Number] | Book id, to be used in [#Book Id Lookup] | 1 |



|| Field || Type || Description || Occurrence ||
| name | [#Text] | Category name | 1 |



|| Field || Type || Description || Occurrence ||
| id | [#Number] | Periodical id, to be used in [#Periodical Edition Lookup] | 1 |



|| Field || Type || Description || Occurrence ||
| downloads-remaining | [#Number] | Indicates the number of downloads remaining for this User | 1 |



|| Field || Type || Description || Occurrence ||
| id | [#Number] | Preference id, to be used in [#User Preference Modification] | 1 |



|| Field || Type || Description || Occurrence ||
| downloads-remaining | [#Number] | Indicates the number of downloads remaining for this User | 1 |



|| Field || Type || Description || Occurence ||
| member-id | [#Text] | Obfuscated User ID | 1 |