Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
dev:web_api:v3:basics [2019/08/25 05:45] – [Sorting and Pagination] Correct 'type' to 'itemType' dstillman | dev:web_api:v3:basics [2020/04/30 05:47] – [Searching] Add includeTrashed param dstillman |
---|
| |
^ Parameter ^ Values ^ Default ^ Description ^ | ^ Parameter ^ Values ^ Default ^ Description ^ |
| | ''includeTrashed'' | ''0'', ''1'' | ''0'' (except in ''/trash'') | Include items in the trash | |
| ''qmode'' | ''titleCreatorYear'', ''everything'' | ''titleCreatorYear'' | Quick search mode. To include full-text content, use ''everything''. Searching of other fields will be possible in the future. | | | ''qmode'' | ''titleCreatorYear'', ''everything'' | ''titleCreatorYear'' | Quick search mode. To include full-text content, use ''everything''. Searching of other fields will be possible in the future. | |
| |
| ''sort'' | ''dateAdded'', ''dateModified'', ''title'', ''creator'', ''itemType'', ''date'', ''publisher'', ''publicationTitle'', ''journalAbbreviation'', ''language'', ''accessDate'', ''libraryCatalog'', ''callNumber'', ''rights'', ''addedBy'', ''numItems'' (tags) | ''dateModified'' (''dateAdded'' for Atom) | The name of the field by which entries are sorted | | | ''sort'' | ''dateAdded'', ''dateModified'', ''title'', ''creator'', ''itemType'', ''date'', ''publisher'', ''publicationTitle'', ''journalAbbreviation'', ''language'', ''accessDate'', ''libraryCatalog'', ''callNumber'', ''rights'', ''addedBy'', ''numItems'' (tags) | ''dateModified'' (''dateAdded'' for Atom) | The name of the field by which entries are sorted | |
| ''direction'' | ''asc'', ''desc'' | varies by ''sort'' | The sorting direction of the field specified in the ''sort'' parameter | | | ''direction'' | ''asc'', ''desc'' | varies by ''sort'' | The sorting direction of the field specified in the ''sort'' parameter | |
| ''limit'' | integer 1-100* | ''50'' | The maximum number of results to return with a single request. Required for export formats. | | | ''limit'' | integer 1-100* | ''25'' | The maximum number of results to return with a single request. Required for export formats. | |
| ''start'' | integer | ''0'' | The index of the first result. Combine with the limit parameter to select a slice of the available results. | | | ''start'' | integer | ''0'' | The index of the first result. Combine with the limit parameter to select a slice of the available results. | |
| |