Diff on /dev/docs/restful_api

History

View

Open Library RESTful API → Diff

Added

Modified

Removed

Not changed

Revision 7 by Karen Coyle August 13, 2009

Revision 8 by George December 4, 2009

body

0	<style type="text/css">	0	<style type="text/css">
...		...
123		123
124	Optional `limit` and `offset` parameters can be passed to limit the number of requests and offset in the results respectively.	124	- Optional `limit` and `offset` parameters can be passed to limit the number of requests and offset in the results respectively.
125	Unless any limit is specified, the responses is limited to 20 entries. Maximum allowed value of `limit` is 1000 due to performance reasons.	125	- Unless any limit is specified, the responses is limited to 20 entries. Maximum allowed value of `limit` is 1000 due to performance reasons.
126		126
...		...
136		136
137	Queries can also be specified by passing the query as JSON dictionary.	137	Queries can also be specified by passing the query as JSON dictionary. The above mentioned approach is just a syntactic-sugar for this.
138	The above mentioned approach is just a syntactic-sugar for this.
139		139
...		...
152		152
153	Please note that this API should not be used for bulk downloads.	152	Please note that this API should not be used for bulk downloads. Dumps of the entire data are provided at regular intervals and they can be used for bulk access.
154	Dumps of the entire data are provided at regular intervals and they can be used for bulk access.
155		155
...		...
179		179
180	The entries are sorted in the descending order of created time.	178
181	The number of entries are limited to 20 by default and a different limit can be specified by passing `limit` parameters.	179	- The entries are sorted in the descending order of created time.
182	Optional `offset` parameter can also be specified to get results starting from an offset.	180	- The number of entries are limited to 20 by default and a different limit can be specified by passing `limit` parameters.
183	Maximum allowed value of `limit` is 1000 due to performance reasons.	181	- Optional `offset` parameter can also be specified to get results starting from an offset.
		182	- Maximum allowed value of `limit` is 1000 due to performance reasons.
184		184
...		...
221		221
222	Parameters, `type`, `key` and `author` can be specified to limit the results to modifications to objects of specified type, specified key and by an author respectively.	221	Parameters, `type`, `key` and `author` can be specified to limit the results to modifications to objects of specified type, specified key and by an author respectively. Also `limit` and `offset` can be specified to limit number of results and offset.
223	Also `limit` and `offset` can be specified to limit number of results and offset.
224		224
...		...
244		244
245	Modifying objects can be done by sending a PUT request to the resource url with appropriate `Content-Type` header.	243	Modifying objects can be done by sending a PUT request to the resource url with appropriate `Content-Type` header. The currently supported format is only JSON.
246	The currently supported format is only JSON.
247		247
...		...
277	Debug information about the error may be provided in the response to help trouble-shooting the issue.	277	Debug information about the error may be provided in the response to help trouble-shooting the issue.