GET search/records
gov.uk:uk-national-archives-discovery-api
Operation ID: SearchRecords_GetRecords_2
Auth: unknown
Parameters (36)
(string, query, optional)
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>
(array, query, optional)
Catalogue level filter.
(array, query, optional)
Closure status filter. <para>Record closure status codes</para>
(string, query, optional)
Corporate name/body query (Custom search)
(string, query, optional)
Record covering date - start date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
(string, query, optional)
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>
(string, query, optional)
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>
(string, query, optional)
Records covering date - end date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
(array, query, optional)
TNA records department filter. <para>Department codes of records held by TNA</para>
(string, query, optional)
Document type (Custom search)
(string, query, optional)
Person First name query (Custom search)
(string, query, optional)
Held by code filter
Constraints: {'enum': ['ALL', 'TNA', 'OTH']}
(string, query, optional)
Person Last name query (Custom search)
(string, query, optional)
Combined parameter for Regiment, Squadron, Discharge and Register number (Custom search)
(string, query, optional)
Person occupation (Custom search)
(string, query, optional)
Manorial record Old county value
(integer, query, optional)
Page number. <para><b>Range [0, 100]</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
(array, query, optional)
Record collection filter. <para>Filter search results by source collection</para>
(string, query, optional)
Record opening range start date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
(string, query, optional)
Record opening range end date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
(string, query, optional)
Place query, i.e. place of birth (Custom search)
(array, query, optional)
Archives/repositories filter. <para>Repository Archon references</para>
(array, query, optional)
Catalogue Series (collection) filter
(string, query, optional)
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>
(string, query, optional)
Used to allow for boosted search results where the reference matches
(array, query, optional)
References of a record. <para>Includes Former references and Citable references</para>
(integer, query, optional)
Search results page size. <para><b>Range [0, 1000], default 15</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
(boolean, query, optional)
Highlight search terms in search results. <para>If highlight is enabled only a snippet containing highlighted text is returned</para>
(string, query, required)
Search query. <para>May contain boolean expressions, i.e. AND, OR, NOT, quotations marks, brackets and/or wild card (*).</para>
(array, query, optional)
Search restriction fields. <para>A list of fields to which the search query should be restricted</para>
(string, query, optional)
Search results sort option
Constraints: {'enum': ['RELEVANCE', 'REFERENCE_ASCENDING', 'DATE_ASCENDING', 'DATE_DESCENDING', 'TITLE_ASCENDING', 'TITLE_DESCENDING']}
(array, query, optional)
Taxonomy subjects. <para>Taxonomy subjects' codes</para>
(array, query, optional)
Covering period filter. <para>A list of predefined time periods</para>
(string, query, optional)
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>
(string, query, optional)
Person title name query (Custom search)
(string, query, optional)
Town name (also Manorial record parish name)
No probe data for this endpoint yet.