v1
latestOpenAPI 3.0.02026-07-237913196.9 KBReturns a page of holdings recognised by the system
There are multiple possible parameters to this call, but only some of them may be used at any time.
When no parameters are specified, every holding in the system is returned.
Searchterm and keyword behave independently, matches to either will cause a holding to be returned.
If Searchterm is not specified then searchproperty will be ignored.
If the keyword parameter is exactly the string "{searchterm}" then the searchterm is used to find
matching keywords and matches to the keyword will be returned also
and the FIRST matching keyword is used to identify holdings.
Additionally, not more than one of the geographic options (gridid, region or the pair of regionclass and classitem) may be defined.
If GridId is specified then region and regionclass/classitem will be ignored.
If region is specified then regionclass/classitem willl be ignored
If regionclass is specified, then the classitem must be specified also.
Note that, as of this release, regionclass and classitem do not have any effect on the result set.
Query parameters
The page number of the results to return
The number of results to show on each page
The word(s) that needs to appear in the holding for it to be included in the set of results.
The keyword(s) that needs to appear in one of the holdings properties in order for that holding to be included in the set of results. Multiple keywords can be entered separated by whitespace
The Grid Cell which holdings must be in to be returned
A WKT representation of the area that a search should be conducted within.
The type of region that should be searched for.
The object within the region class that search should be conducted on
If Specified, the property on which a search should be performed, if not specified, then all properties are searched
If specified, filter the results based on the status of the holding
Optionally limit the search results to holdings below the specified parent
Optionally limit the search results to a specific date range based on the specific field
If the date field is set, limit to records on or after this date.
If the date field is set, limit to records on or before this date.
If specified, filter the results based on the holding type. Multiple types can be entered separated by whitespace
If true, search on a list of expansions or replacements for the search terms based on matches in the thesaurus
Response
Ok