Differences

This shows you the differences between two versions of the page.

--- dev:web_api:v3:read_requests [2014/06/11 02:09] – dstillman
+++ dev:web_api:v3:read_requests [2014/06/12 05:49] – dstillman
@@ Line 1: / Line 1: @@
 <html><p style="color:red; font-weight:bold">This is draft documentation. APIv3 is not yet available for use.</p></html>
-====== Zotero Web API Read Requests ======
+====== Zotero API Reference ======
 **This is not currently the default [[read_requests#api_versioning|version]] of the API. Include the ''Zotero-API-Version: 3'' HTTP header or the ''v=3'' query parameter to access this version.**
@@ Line 19: / Line 19: @@
 **To use this version of the API, include the ''Zotero-API-Version: 3'' HTTP header or the ''v=3'' query parameter with all requests.** The current default version is [[:dev/web_api/v1/|version 1]], which will be discontinued.
-At most times, API changes are made in a backwards-compatible manner. On rare occasions, however, backwards-incompatible changes may need to be made. When this occurs, the new API version will first be made available via the ''Zotero-API-Version'' HTTP header or ''v'' query parameter, while other clients will continue to receive the old version. After a transition period, the new API version will become the default. At that point, the previous API version may be discontinued, with the oldest available API version being returned to clients requesting the discontinued version. Announcements regarding API version transitions will always be made ahead of time on [[https://groups.google.com/group/zotero-dev|zotero-dev]].
+At most times, API changes are made in a backwards-compatible manner. On rare occasions, however, backwards-incompatible changes may need to be made. When this occurs, the new API version will first be made available via the ''Zotero-API-Version'' HTTP header or ''v'' query parameter, while other clients will continue to receive the old version. After a transition period, the new API version will become the default. If an API version is discontinued, clients requesting the discontinued version will receive the oldest available version. Announcements regarding API version transitions will always be made ahead of time on [[https://groups.google.com/group/zotero-dev|zotero-dev]].
 The API version of a response will be returned in the ''Zotero-API-Version'' response header.
 ===== Authentication =====
@@ Line 35: / Line 36: @@
 Use of the ''Authentication'' header is recommended, as it will allow use of URLs returned from the API (e.g., for pagination) without modification.
-===== GET Requests =====
+===== Resources =====
+==== User and Group Library URLs ====
 Requests for data in a specific library begin with ''/users/<userID>'' or ''/groups/<groupID>''. User IDs are different from usernames and can be found on the [[/settings/keys|API Keys]] page and in OAuth responses.
-==== Requests for "/users/<userID>" or "/groups/<groupID>" ====
 ^ URI ^ Description ^
@@ Line 59: / Line 61: @@
 | <userOrGroupPrefix>/searches/<searchKey> | A specific saved search in the library |
-==== Requests Specific to "/users/<userID>" ====
+==== User-Only URLs ====
 |< 100% 30% >|
@@ Line 66: / Line 68: @@
 | /users/<userID>/keys/<key> | The privileges of the given API key. |
-===== URL Parameters =====
+===== Read Requests =====
-All parameters are optional.
+The following parameters affect the format of data returned from read requests. All parameters are optional.
 ==== General Parameters ====
-The following parameters are valid for all requests:
+The following parameters are valid for all read requests:
 ^ Parameter ^ Values ^ Default ^ Description ^
 | ''format'' | ''atom'', ''bib'', ''json'', ''keys'', ''versions'', [[#export_formats|export format]] | ''json'' | ''atom'' will return an Atom feed suitable for use in feed readers or feed-reading libraries.\\ ''bib'', valid only for item requests, will return a formatted bibliography as XHTML. ''bib'' mode is currently limited to a maximum of 150 items.\\ ''json'' will return a JSON array for multi-object requests and a single JSON object for single-object requests.\\ ''keys'', valid for multi-object requests, will return a newline-separated list of object keys. ''keys'' mode has no default or maximum limit.\\ ''versions'', valid for multi-object collection, item, search, and tag requests, will return a JSON object with Zotero object keys as keys and object versions as values. Like ''keys'', ''versions'' mode has no default or maximum limit. \\ Export formats, valid only for item requests, produce output in the specified format. |
+==== Parameters for "format=json" ====
+^ Parameter ^ Values ^ Default ^ Description ^
+| ''include'' | ''bib'', ''data'', [[#export_formats|export format]]\\ Multiple formats can be specified by using a comma as the delimiter (''include=data,bib''). | ''data'' | Formats to include in the response:\\ ''bib'', valid only for item requests, will return a formatted reference for each item.\\ ''data'' (the default) will include all writeable fields in JSON format, suitable for modifying and sending back to the API.\\ Export formats, valid only for item requests, will return data in the specified format for each item. |
+==== Parameters for "format=atom" ====
+^ Parameter ^ Values ^ Default ^ Description ^
+| ''content'' | ''bib'', ''html'', ''json'', [[#export_formats|export formats]], ''none''\\ Multiple formats can be specified by using a comma as the delimiter (''content=json,bib''). | ''html'' | The format of the Atom response's ''<content>'' node:\\ ''html'' (the default) will return an XHTML representation of each object, useful for display in feed readers and for parsing by XML tools.\\ ''json'', currently valid only for item and collection requests, will return a JSON representation of all the item's fields.\\ ''bib'', valid only for item requests, will return a formatted reference for each item.\\ Export formats, valid only for item requests, will return data in the specified format for each item.\\ If additional data is not required, use ''none'' to decrease the response size.\\ If multiple formats are requested, ''<content>'' will contain multiple ''<zapi:subcontent>'' elements (in the %%http://zotero.org/ns/api%% namespace), each with a ''zapi:type'' attribute matching one of the specified content parameters. |
+==== Parameters for "format=bib" and "content=bib" ====
+^ Parameter ^ Values ^ Default ^ Description ^
+| ''style'' | string | ''chicago-note-bibliography'' | Citation style to use for formatted references. Should be the file name (without the .csl extension) of one of the default styles in the Zotero Style Repository (e.g., ''apa'' for https://www.zotero.org/styles/apa). Support for other styles is forthcoming.|
+Note the difference between ''format=bib'' and ''content=bib''. ''format=bib'' returns a formatted bibliography as XHTML, sorted according to the rules of the selected style. ''content=bib'' (valid only for ''format=atom'', the default format mode) returns an individual formatted reference within the Atom ''<content>'' block for each item, with the Atom feed sorted according to the query parameters. ''format=bib'' processes the entire feed you are requesting without regard for any limit arguments, so it is generally a good idea to use it only with collections or tags.
+==== Export Formats ====
+The following bibliographic data formats can be used as ''format'', ''include'', and ''content'' parameters:
+^ Parameter ^ Description ^
+| ''bibtex'' | BibTeX |
+| ''bookmarks'' | Netscape Bookmark File Format |
+| ''coins'' | COinS |
+| ''csljson'' | [[https://github.com/citation-style-language/schema/blob/master/csl-data.json|Citation Style Language data format]] |
+| ''mods'' | MODS |
+| ''refer'' | Refer/BibIX |
+| ''rdf_bibliontology'' | [[http://bibliontology.com/|Bibliographic Ontology]] RDF |
+| ''rdf_dc'' | Unqualified Dublin Core RDF |
+| ''rdf_zotero'' | Zotero RDF |
+| ''ris'' | RIS |
+| ''tei'' | Text Encoding Initiative (TEI) |
+| ''wikipedia'' | Wikipedia Citation Templates |
+===== Searching =====
 ==== Search Parameters ====
@@ Line 107: / Line 147: @@
-==== Sorting and Pagination ====
+===== Sorting and Pagination =====
-The following parameters are valid only for multi-object requests such as ''/users/123/items'', with the exception of ''format=bib'' requests, which do not support sorting or pagination.
+==== Sorting and Pagination Parameters ====
+The following parameters are valid only for multi-object read requests such as ''<userOrGroupPrefix>/items'', with the exception of ''format=bib'' requests, which do not support sorting or pagination.
 ^ Parameter ^ Values ^ Default ^ Description ^
@@ Line 117: / Line 159: @@
 | ''start'' | integer | ''0'' | The index of the first result. Combine with the limit parameter to select a slice of the available results. |
-==== Parameters for "format=json" ====
+=== Total Results ===
-^ Parameter ^ Values ^ Default ^ Description ^
+Responses for multi-object read requests will include a custom HTTP header, ''Total-Results'', that provides the total number of results matched by the request. The actual number of results provided in a given response will be less than 100.
-| ''include'' | ''bib'', ''data'', [[#export_formats|export format]]\\ Multiple formats can be specified by using a comma as the delimiter (''include=data,bib''). | ''data'' | Formats to include in the response:\\ ''bib'', valid only for item requests, will return a formatted reference for each item.\\ ''data'' (the default) will include all writable fields in JSON format, suitable for modifying and sending back to the API.\\ Export formats, valid only for item requests, will return data in the specified format for each item. |
-==== Parameters for "format=atom" ====
+=== Link Header ===
-^ Parameter ^ Values ^ Default ^ Description ^
+When the total number of results matched by a read request is greater than the current limit, the API will include pagination links in the HTTP ''Link'' header. Possible values are ''rel=first'', ''rel=prev'', ''rel=next'', and ''rel=last''. For some requests, the header may also include a ''rel=alternate'' link for the relevant page on the Zotero website.
-| ''content'' | ''bib'', ''html'', ''json'', [[#export_formats|export formats]], ''none''\\ Multiple formats can be specified by using a comma as the delimiter (''content=json,bib''). | ''html'' | The format of the Atom response's ''<content>'' node:\\ ''html'' (the default) will return an XHTML representation of each object, useful for display in feed readers and for parsing by XML tools.\\ ''json'', currently valid only for item and collection requests, will return a JSON representation of all the item's fields.\\ ''bib'', valid only for item requests, will return a formatted reference for each item.\\ Export formats, valid only for item requests, will return data in the specified format for each item.\\ If additional data is not required, use ''none'' to decrease the response size.\\ If multiple formats are requested, ''<content>'' will contain multiple ''<zapi:subcontent>'' elements (in the %%http://zotero.org/ns/api%% namespace), each with a ''zapi:type'' attribute matching one of the specified content parameters. |
-==== Parameters for "format=bib" and "content=bib" ====
+<code>
+GET https://api.zotero.org/users/12345/items?limit=30
-^ Parameter ^ Values ^ Default ^ Description ^
+</code>
-| ''style'' | string | ''chicago-note-bibliography'' | Citation style to use for formatted references. Should be the file name (without the .csl extension) of one of the default styles in the Zotero Style Repository (e.g., ''apa'' for https://www.zotero.org/styles/apa). Support for other styles is forthcoming.|
+<code>
+Link: <https://api.zotero.org/users/12345/items?limit=30&start=30>; rel="next",
-Note the difference between ''format=bib'' and ''content=bib''. ''format=bib'' returns a formatted bibliography as XHTML, sorted according to the rules of the selected style. ''content=bib'' (valid only for ''format=atom'', the default format mode) returns an individual formatted reference within the Atom ''<content>'' block for each item, with the Atom feed sorted according to the query parameters. ''format=bib'' processes the entire feed you are requesting without regard for any limit arguments, so it is generally a good idea to use it only with collections or tags.
+ <https://api.zotero.org/users/12345/items?limit=30&start=5040>; rel="last",
+ <https://www.zotero.org/users/12345/items>; rel="alternate"
-==== Export Formats ====
+</code>
-The following bibliographic data formats can be used as ''format'', ''include'', and ''content'' parameters:
-^ Parameter ^ Description ^
-| ''bibtex'' | BibTeX |
-| ''bookmarks'' | Netscape Bookmark File Format |
-| ''coins'' | COinS |
-| ''csljson'' | [[https://github.com/citation-style-language/schema/blob/master/csl-data.json|Citation Style Language data format]] |
-| ''mods'' | MODS |
-| ''refer'' | Refer/BibIX |
-| ''rdf_bibliontology'' | [[http://bibliontology.com/|Bibliographic Ontology]] RDF |
-| ''rdf_dc'' | Unqualified Dublin Core RDF |
-| ''rdf_zotero'' | Zotero RDF |
-| ''ris'' | RIS |
-| ''tei'' | Text Encoding Initiative (TEI) |
-| ''wikipedia'' | Wikipedia Citation Templates |
+(Newlines are inserted here for clarity.)
 ===== Caching =====
-For efficient usage of the API, clients should make conditional GET requests whenever possible. If ''If-Modified-Since-Version: <libraryVersion>'' is passed with a multi-object read request (e.g., ''<userOrGroupPrefix>/items'') and data has not changed in the library since the specified version, the API will return ''304 Not Modified''. If ''If-Modified-Since-Version: <objectVersion>'' is passed with a single-object read request (e.g., ''<userOrGroupPrefix>/items/<itemKey>''), a ''304 Not Modified'' will be returned if the individual object has not changed.
+For efficient usage of the API, clients should make conditional GET requests whenever possible. If ''If-Modified-Since-Version: <libraryVersion>'' is passed with a multi-object read request (e.g., ''/users/1/items'') and data has not changed in the library since the specified version, the API will return ''304 Not Modified''. If ''If-Modified-Since-Version: <objectVersion>'' is passed with a single-object read request (e.g., ''/users/1/items/ABCD2345''), a ''304 Not Modified'' will be returned if the individual object has not changed.
-While a conditional GET request that returns a 304 should be fast, some clients may wish to perform additional caching on their own, using stored data for a period of time before making subsequent conditional requests to the Zotero API. This makes particular sense when the underlying Zotero data is known not to change frequently. For example, a web page that displayed a bibliography from a Zotero collection might cache the returned bibliography for an hour, after which time it would make another conditional request to the Zotero API. If the API returned a ''304'', the web page would continue to display the cached bibliography for another hour before retrying.
+While a conditional GET request that returns a ''304'' should be fast, some clients may wish or need to perform additional caching on their own, using stored data for a period of time before making subsequent conditional requests to the Zotero API. This makes particular sense when the underlying Zotero data is known not to change frequently or when the data will be accessed frequently. For example, a website that displayed a bibliography from a Zotero collection might cache the returned bibliography for an hour, after which time it would make another conditional request to the Zotero API. If the API returned a ''304'', the website would continue to display the cached bibliography for another hour before retrying. This would prevent the website from making a request to the Zotero API every time a user loaded a page.
 ===== Rate Limiting =====
+//[Not all rate limits are currently enforced, but clients should be prepared to handle them.]//
 Clients accessing the Zotero API should be prepared to handle two forms of rate limiting: backoff requests and hard limiting.
@@ Line 168: / Line 195: @@
 ''Retry-After'' can also be included with ''503 Service Unavailable'' responses when the server is undergoing maintenance.
-===== Example Requests and Responses =====
-Several examples of read request URLs and their responses:
-^ Atom feed - List of items in collection ^^
-| Request | https://api.zotero.org/users/475425/collections/9KH9TNSJ/items?format=atom |
-| Response | https://gist.github.com/923206 (Not updated for API v2)|
-^ Atom feed - Single item ^^
+===== Example GET Requests and Responses =====
-| Request | https://api.zotero.org/users/475425/items/X42A7DEE?format=atom |
-| Response | https://gist.github.com/mronkko/5077731 |
+TODO
-^ Atom feed - Single item with all possible content^^
-| Request | https://api.zotero.org/users/475425/items/X42A7DEE?format=atom&content=json,bib,html |
-| Response | https://gist.github.com/mronkko/5077751 |
-^ Atom feed - List of collections for a user ^^
-| Request | https://api.zotero.org/users/475425/collections?format=atom |
-| Response | https://gist.github.com/1492705 (Not updated for API v2) |
-^ Formatted bibliography ^^
-| Request | https://api.zotero.org/users/475425/collections/9KH9TNSJ/items?format=bib |
-| Response | https://gist.github.com/mronkko/77bc2413cce4c219f862 |
-These requests can be performed from the command line:
-<code bash>
-curl -H 'Zotero-API-Version: 2' 'https://api.zotero.org/users/475425/collections/9KH9TNSJ/items?format=atom'
-curl -H 'Zotero-API-Version: 2' 'https://api.zotero.org/users/475425/items/X42A7DEE?format=atom'
-curl -H 'Zotero-API-Version: 2' 'https://api.zotero.org/users/475425/items/X42A7DEE?format=atom&content=json,bib,html'
-curl -H 'Zotero-API-Version: 2' 'https://api.zotero.org/users/475425/collections?format=atom'
-curl -H 'Zotero-API-Version: 2' 'https://api.zotero.org/users/475425/collections/9KH9TNSJ/items?format=bib'
-</code>
-===== Write Requests =====
-The API also supports [[write requests]] that allow the creation, modification, and deletion of data in online Zotero libraries.
 ===== HTTP Status Codes =====
@@ Line 220: / Line 214: @@
 ''429 Too Many Requests'' indicates that the client has been [[#rate_limiting|rate-limited]].
+===== Additional Documentation =====
+  * [[Write Requests]]
+  * [[file_upload|File Uploads]]
+  * [[Syncing]]
+  * [[oauth|OAuth Authentication]]
+  * [[changes_from_v2|Changes from API Version 2]]