Differences

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

Link to this comparison view

Next revision
Previous revision
Next revisionBoth sides next revision
dev:web_api:v3:types_and_fields [2014/06/12 14:55] – created dstillmandev:web_api:v3:types_and_fields [2019/06/17 19:36] dstillman
Line 5: Line 5:
 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 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''). //[Non-English locales 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'').
  
 ==== Getting All Item Types ==== ==== Getting All Item Types ====
Line 42: Line 42:
 ==== Getting All Valid Fields for an Item Type ==== ==== Getting All Valid Fields for an Item Type ====
  
-Note: API consumers intending to write to the server should generally use [[#get_template_for_a_new_item|/items/new]] combined with [[#get_all_item_types|/itemTypes]] instead of this request.+Note: API consumers intending to write to the server should generally use [[#getting_a_template_for_a_new_item|/items/new]] combined with [[#getting_all_item_types|/itemTypes]] instead of this request.
  
   GET /itemTypeFields?itemType=book   GET /itemTypeFields?itemType=book
dev/web_api/v3/types_and_fields.txt · Last modified: 2019/12/07 18:46 by tomas_fiers