v1
latestOpenAPI 3.0.02026-07-232635107.7 KBExecutes search of records
Query parameters
Catalogue Series (collection) filter
References of a record. <para>Includes Former references and Citable references</para>
Record collection filter. <para>Filter search results by source collection</para>
Record covering date - start date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
Records covering date - end date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
Covering period filter. <para>A list of predefined time periods</para>
Archives/repositories filter. <para>Repository Archon references</para>
TNA records department filter. <para>Department codes of records held by TNA</para>
Taxonomy subjects. <para>Taxonomy subjects' codes</para>
Catalogue level filter.
Closure status filter. <para>Record closure status codes</para>
Corporate name/body query (Custom search)
Held by code filter
Document type (Custom search)
Person title name query (Custom search)
Person First name query (Custom search)
Person Last name query (Custom search)
Person Date of Birth range start (Custom search). <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
Person Date of Birth range end (Custom search). <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
Combined parameter for Regiment, Squadron, Discharge and Register number (Custom search)
Person occupation (Custom search)
Place query, i.e. place of birth (Custom search)
Manorial record Old county value
Town name (also Manorial record parish name)
Record opening range start date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
Record opening range end date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
Catalogue Reference first letter filter. <para>Enabled when only when sorting by Reference in {SortByOption} and number of results is less then 10,000</para>
Used to allow for boosted search results where the reference matches
Search restriction fields. <para>A list of fields to which the search query should be restricted</para>
Search query. <para>May contain boolean expressions, i.e. AND, OR, NOT, quotations marks, brackets and/or wild card (*).</para>
Highlight search terms in search results. <para>If highlight is enabled only a snippet containing highlighted text is returned</para>
Search results sort option
Page number. <para><b>Range [0, 100]</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
Search results page size. <para><b>Range [0, 1000], default 15</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
Filter by the first letter of the record title. <para>Enabled when sorting by Title in {SortByOption} and number of results is less then 10,000</para>
Cursor Mark value. <para>Search result batch start mark used for deep paging.</para><para>To invoke deep paging use wild card (*). For subsequent requests use the value of "NextBatchMark" field.</para>
Query string parameter for user preferences. <para>Used to pass user-specific preferences as part of the search request.</para>
Response
OK