| Next revision | Previous revision |
| dev:web_api:v3:fulltext_content [2014/06/10 03:23] – external edit 127.0.0.1 | dev:web_api:v3:fulltext_content [2022/06/23 15:53] (current) – [Zotero Web API: Full-Text Content Requests] dstillman |
|---|
| ====== Full-Text Content Requests ====== | ====== Zotero Web API Full-Text Content Requests ====== |
| |
| This page documents the methods to access full-text content of Zotero items via the [[start|Zotero Server API]]. See the [[Read Requests]] page for basic information on accessing the API, including possible HTTP status codes not listed here. | This page documents the methods to access full-text content of Zotero items via the [[start|Zotero Web API]]. See the [[Basics]] page for basic information on accessing the API, including possible HTTP status codes not listed here. |
| |
| ==== Getting new full-text content ==== | ==== Getting new full-text content ==== |
| |
| GET <userOrGroupPrefix>/fulltext?newer=<version> | GET <userOrGroupPrefix>/fulltext?since=<version> |
| | |
| ''<itemKey>'' should correspond to an existing attachment item. ''<version>'' should be the ''Last-Modified-Version'' returned from the previous check, or 0 if none. | |
| |
| Content-Type: application/json | Content-Type: application/json |
| ^ Common responses ^^ | ^ Common responses ^^ |
| | ''200 OK'' | Full-text content was successfully retrieved. | | | ''200 OK'' | Full-text content was successfully retrieved. | |
| | ''400 Bad Request'' | The 'newer' parameter was not provided. | | | ''400 Bad Request'' | The 'since' parameter was not provided. | |
| |
| ==== Getting an item's full-text content ==== | ==== Getting an item's full-text content ==== |
| }</code> | }</code> |
| |
| ''indexedChars'' and ''totalChars'' may be provided instead of ''indexedPages'' and ''totalPages''. | ''indexedChars'' and ''totalChars'' are used for text documents, while ''indexedPages'' and ''totalPages'' are used for PDFs. |
| |
| ^ Common responses ^^ | ^ Common responses ^^ |
| ''<itemKey>'' should correspond to an existing attachment item. | ''<itemKey>'' should correspond to an existing attachment item. |
| |
| ''indexedPages'' and ''totalPages'' can be provided instead of ''indexedChars'' and ''totalChars''. | For text documents, include ''indexedChars'' and ''totalChars''. For PDFs, include ''indexedPages'' and ''totalPages''. |
| |
| ^ Common responses ^^ | ^ Common responses ^^ |
| ==== Searching for items by full-text content ==== | ==== Searching for items by full-text content ==== |
| |
| See the ''q'' and ''qmode'' [[read_requests#search_parameters|search parameters]]. | See the ''q'' and ''qmode'' [[basics#search_parameters|search parameters]]. |
Upgrade Storage