Differences

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

--- dev:web_api:v3:basics [2018/12/13 02:45] – [Authentication] dstillman
+++ dev:web_api:v3:basics [2019/08/10 07:03] – [Searching] dstillman
@@ Line 46: / Line 46: @@
 ==== User and Group Library URLs ====
-Requests for data in a specific library begin with ''/users/<userID>'' or ''/groups/<groupID>''. User IDs are different from usernames and can be found on the [[/settings/keys|API Keys]] page and in OAuth responses.
+Requests for data in a specific library begin with ''/users/<userID>'' or ''/groups/<groupID>'', referred to below as ''<userOrGroupPrefix>''. User IDs are different from usernames and can be found on the [[/settings/keys|API Keys]] page and in OAuth responses.
 ^ URI ^ Description ^
@@ Line 98: / Line 98: @@
 ^ Parameter ^ Values ^ Default ^ Description ^
 | ''style'' | string | ''chicago-note-bibliography'' | Citation style to use for formatted references. Can be either the file name (without the .csl extension) of one of the styles in the [[https://www.zotero.org/styles/|Zotero Style Repository]] (e.g., ''apa'') or the URL of a remote CSL file. |
+| ''locale'' | string | ''en-US'' | Bibliography locale. See the [[https://github.com/citation-style-language/locales|available CSL locales]]. Note that some styles use a fixed locale and cannot be localized. |
@@ Line 130: / Line 131: @@
 | ''itemType'' | [[#search_syntax|search syntax]] | null | Item type search |
 | ''q'' | string | null | Quick search. Searches titles and individual creator fields by default. Use the ''qmode'' parameter to change the mode. Currently supports phrase searching only. |
-| ''qmode'' | ''titleCreatorYear'', ''everything'' | ''titleCreatorYear'' | Quick search mode. To include full-text content in the search, use ''everything''. Searching of other fields will be possible in the future. |
 | ''since'' | integer | ''0'' | Return only objects modified after the specified library verson. |
 | ''tag'' | [[#search_syntax|search syntax]] | null | Tag search |
+==== Search Parameters (Items Endpoints) ====
+^ Parameter ^ Values ^ Default ^ Description ^
+| ''qmode'' | ''titleCreatorYear'', ''everything'' | ''titleCreatorYear'' | Quick search mode. To include full-text content, use ''everything''. Searching of other fields will be possible in the future. |
+==== Search Parameters (Tags Endpoints) ====
+^ Parameter ^ Values ^ Default ^ Description ^
+| ''qmode'' | ''contains'', ''startsWith'' | ''contains'' | Quick search mode. To perform a left-bound search, use ''startsWith''. |
+==== Search Parameters (Tags-Within-Items Endpoints) ====
+These parameters can be used to search against items when returning tags within items. In such cases, the main parameters (''q'', ''qmode'', ''tag'') apply to the tags themselves, as the primary objects of the request.
+^ Parameter ^ Values ^ Default ^ Description ^
+| ''itemQ'' | string | null | Same as ''q'' in an ''items'' request |
+| ''itemQMode'' | ''contains'', ''startsWith'' | ''contains'' | Same as ''qmode'' in an ''items'' request |
+| ''itemTag'' | [[#search_syntax|search syntax]] | null | Same as ''tag'' in an ''items'' request |
 ==== Search Syntax ====