Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
dev:web_api:v2:fulltext_content [2013/11/05 17:55] – dstillmandev:web_api:v2:fulltext_content [2017/11/27 04:19] (current) – Remove Zotero 5 warning bwiernik
Line 1: Line 1:
-====== Full-text Content Requests ======+====== 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 Server API]]. See the [[Read Requests]] page for basic information on accessing the API, including possible HTTP status codes not listed here.
Line 6: Line 6:
  
   GET <userOrGroupPrefix>/fulltext?newer=<version>   GET <userOrGroupPrefix>/fulltext?newer=<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
Line 28: Line 26:
   GET <userOrGroupPrefix>/items/<itemKey>/fulltext   GET <userOrGroupPrefix>/items/<itemKey>/fulltext
  
-<itemKey> should correspond to an existing attachment item.+''<itemKey>'' should correspond to an existing attachment item.
  
   Content-Type: application/json   Content-Type: application/json
Line 39: Line 37:
 }</code> }</code>
  
-'indexedChars' and 'totalChars' may be provided instead of 'indexedPages' and 'totalPages'.+''indexedChars'' and ''totalChars'' may be provided instead of ''indexedPages'' and ''totalPages''.
  
 ^ Common responses ^^ ^ Common responses ^^
Line 56: Line 54:
 }</code> }</code>
  
-<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'.+''indexedPages'' and ''totalPages'' can be provided instead of ''indexedChars'' and ''totalChars''.
  
 ^ Common responses ^^ ^ Common responses ^^
Line 64: Line 62:
 | ''400 Bad Request'' | Invalid JSON was provided. | | ''400 Bad Request'' | Invalid JSON was provided. |
 | ''404 Not Found'' | The item wasn't found or was not an attachment. | | ''404 Not Found'' | The item wasn't found or was not an attachment. |
 +
 +==== Searching for items by full-text content ====
 +
 +See the ''q'' and ''qmode'' [[read_requests#search_parameters|search parameters]].
dev/web_api/v2/fulltext_content.1383692116.txt.gz · Last modified: 2013/11/05 17:55 by dstillman