Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
dev:web_api:v3:types_and_fields [2019/06/17 19:36]
dstillman
dev:web_api:v3:types_and_fields [2019/12/07 18:46] (current)
tomas_fiers Mention /schema
Line 3: Line 3:
 For a [[start|Zotero Web API]] client to present an editing UI to its users, it must know what combinations of Zotero item types, fields, and creator types are valid. Clients can request this data from the Zotero API. For a [[start|Zotero Web API]] client to present an editing UI to its users, it must know what combinations of Zotero item types, fields, and creator types are valid. Clients can request this data from the Zotero API.
  
-As schema changes are currently rare, clients should cache type/field data for a period of time (e.g., one hour) without making further requests. Subsequent requests for new data should then include ''​If-Modified-Since''​ headers containing the contents of the ''​Last-Modified''​ header from the original response. If no changes have occurred, the server will return a ''​304 Not Modified''​ and clients should continue to use cached data for the same period of time. //​[Conditional requests are not yet implemented.]//​+As schema changes are currently rare, clients should cache type/field data for a period of time (e.g., one hour) without making further requests. Subsequent requests for new data should then include ''​If-Modified-Since''​ headers containing the contents of the ''​Last-Modified''​ header from the original response. If no changes have occurred, the server will return a ''​304 Not Modified''​ and clients should continue to use cached data for the same period of time. //​[Conditional requests ​-- i.e. ''​If-Modified-Since''​ -- are not yet implemented.]//​
  
 User-friendly type/field names will be returned in English by default. Clients can request names in other languages by passing a ''​locale''​ parameter (e.g., ''​GET /​itemTypes?​locale=fr-FR''​). User-friendly type/field names will be returned in English by default. Clients can request names in other languages by passing a ''​locale''​ parameter (e.g., ''​GET /​itemTypes?​locale=fr-FR''​).
 +
 +Note: the entire schema, including translations for all locales, can also be downloaded as a single file at https://​api.zotero.org/​schema. See the [[https://​github.com/​zotero/​zotero-schema|GitHub repository of the schema]] for caching instructions.
  
 ==== Getting All Item Types ==== ==== Getting All Item Types ====
dev/web_api/v3/types_and_fields.1560814580.txt.gz ยท Last modified: 2019/06/17 19:36 by dstillman