v1

latestOpenAPI 3.0.02026-07-232635107.7 KB
SearchRecords

Executes search of records

get/search/v1/records

Query parameters

sps.recordSeriesstring[]

Catalogue Series (collection) filter

sps.referencesstring[]

References of a record. <para>Includes Former references and Citable references</para>

sps.recordCollectionsstring[]

Record collection filter. <para>Filter search results by source collection</para>

sps.dateFromstring date-time

Record covering date - start date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>

sps.dateTostring date-time

Records covering date - end date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>

sps.timePeriodsstring[]

Covering period filter. <para>A list of predefined time periods</para>

sps.recordRepositoriesstring[]

Archives/repositories filter. <para>Repository Archon references</para>

sps.departmentsstring[]

TNA records department filter. <para>Department codes of records held by TNA</para>

sps.taxonomySubjectsstring[]

Taxonomy subjects. <para>Taxonomy subjects' codes</para>

sps.catalogueLevelsstring[]

Catalogue level filter.

sps.closureStatusesstring[]

Closure status filter. <para>Record closure status codes</para>

sps.corporateNamesstring

Corporate name/body query (Custom search)

sps.heldByCode'ALL' | 'TNA' | 'OTH'

Held by code filter

sps.documentTypestring

Document type (Custom search)

sps.titleNamestring

Person title name query (Custom search)

sps.firstNamestring

Person First name query (Custom search)

sps.lastNamestring

Person Last name query (Custom search)

sps.dateOfBirthFromstring date-time

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>

sps.dateOfBirthTostring date-time

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>

sps.numberstring

Combined parameter for Regiment, Squadron, Discharge and Register number (Custom search)

sps.occupationstring

Person occupation (Custom search)

sps.recordPlacestring

Place query, i.e. place of birth (Custom search)

sps.oldCountyNamestring

Manorial record Old county value

sps.townNamestring

Town name (also Manorial record parish name)

sps.recordOpeningFromDatestring date-time

Record opening range start date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>

sps.recordOpeningToDatestring date-time

Record opening range end date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>

sps.referenceFirstLetterstring

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>

sps.referenceQuerystring

Used to allow for boosted search results where the reference matches

sps.searchRestrictionFieldsstring[]

Search restriction fields. <para>A list of fields to which the search query should be restricted</para>

sps.searchQuerystring required

Search query. <para>May contain boolean expressions, i.e. AND, OR, NOT, quotations marks, brackets and/or wild card (*).</para>

sps.returnHighlightedboolean

Highlight search terms in search results. <para>If highlight is enabled only a snippet containing highlighted text is returned</para>

sps.sortByOption'RELEVANCE' | 'REFERENCE_ASCENDING' | 'DATE_ASCENDING' | 'DATE_DESCENDING' | 'TITLE_ASCENDING' | 'TITLE_DESCENDING'

Search results sort option

sps.pageinteger

Page number. <para><b>Range [0, 100]</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>

sps.resultsPageSizeinteger

Search results page size. <para><b>Range [0, 1000], default 15</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>

sps.titleFirstLetterstring

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>

sps.batchStartMarkstring

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>

sps.preferenceQueryStringParameterstring

Query string parameter for user preferences. <para>Used to pass user-specific preferences as part of the search request.</para>

Response

OK

Countinteger

Gets or sets the total count of search results.

NextBatchMarkstring

Gets or sets the marker for the next batch of results.