| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| dev:web_api:v2:read_requests [2014/07/02 14:22] – [Zotero Server Read Requests] dstillman | dev:web_api:v2:read_requests [2017/11/27 04:16] (current) – Remove Zotero 5 warning bwiernik |
|---|
| ===== API Versioning ===== | ===== API Versioning ===== |
| |
| **To use this version of the API, include the HTTP header ''Zotero-API-Version: 2'' with all requests.** The current default version is [[:dev/web_api/v1/|version 1]], which will be discontinued in the near future. | To use this version of the API, include the HTTP header ''Zotero-API-Version: 2'' with all requests. **The current default version is [[:dev/web_api/v3/|version 3]].** |
| |
| At most times, there is only one active API version, and 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 an HTTP header, ''Zotero-API-Version: <version>'', while all other clients 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 new API version being returned even to clients requesting the previous 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, there is only one active API version, and 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 an HTTP header, ''Zotero-API-Version: <version>'', while all other clients 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 new API version being returned even to clients requesting the previous version. Announcements regarding API version transitions will always be made ahead of time on [[https://groups.google.com/group/zotero-dev|zotero-dev]]. |
| | order | "dateAdded", "dateModified", "title", "creator", "type", "date", "publisher", "publicationTitle", "journalAbbreviation", "language", "accessDate", "libraryCatalog", "callNumber", "rights", "addedBy", "numItems" (tags) | dateAdded | The name of the field by which entries are ordered | | | order | "dateAdded", "dateModified", "title", "creator", "type", "date", "publisher", "publicationTitle", "journalAbbreviation", "language", "accessDate", "libraryCatalog", "callNumber", "rights", "addedBy", "numItems" (tags) | dateAdded | The name of the field by which entries are ordered | |
| | sort | "asc", "desc" | varies by "order" | The sorting direction of the field specified in the ''order'' parameter | | | sort | "asc", "desc" | varies by "order" | The sorting direction of the field specified in the ''order'' parameter | |
| | limit | integer 1-99* | 50* | The maximum number of results to return with a single request. Required for export formats. | | | limit | integer 1-100* | 50* | The maximum number of results to return with a single request. Required for export formats. | |
| | start | integer | 0 | The index of the first result. Combine with the limit parameter to select a slice of the available results. | | | start | integer | 0 | The index of the first result. Combine with the limit parameter to select a slice of the available results. | |
| |
Upgrade Storage