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
Last revision Both sides next revision
dev:web_api:v3:basics [2019/08/25 05:45]
dstillman [Sorting and Pagination] Correct 'type' to 'itemType'
dev:web_api:v3:basics [2020/04/30 05:47]
dstillman [Searching] Add includeTrashed param
Line 163: Line 163:
  
 ^ 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. |
  
Line 209: Line 210:
 | ''​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. |
  
dev/web_api/v3/basics.txt · Last modified: 2020/06/01 15:37 by dstillman