GET /search/archives

gov.uk:uk-national-archives-discovery-api

Summary: Execute search of archives/repositories
Operation ID: SearchForRepositories_GetArchives_3
Auth: unknown

Parameters (13)

sps.archiveCode (integer, query, optional)

Archon Code

sps.batchStartMark (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>

sps.page (integer, query, optional)

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

sps.repositoryCounties (array, query, optional)

Repository location County filter. <para>County codes</para>

sps.repositoryCountries (array, query, optional)

Repository location Country filter. <para>Country codes</para>

sps.repositoryRegions (array, query, optional)

Repository location Region filter. <para>Region codes</para>

sps.repositoryTypes (array, query, optional)

Repository type filter.

sps.resultsPageSize (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>

sps.returnHighlighted (boolean, query, optional)

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

sps.searchQuery (string, query, required)

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

sps.sortByOption (string, query, optional)

Search results sort option

Constraints: {'enum': ['RELEVANCE', 'REFERENCE_ASCENDING', 'DATE_ASCENDING', 'DATE_DESCENDING', 'TITLE_ASCENDING', 'TITLE_DESCENDING']}

sps.titleContains (string, query, optional)

String which should be contained in the repository title

sps.titleFirstLetter (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>

No probe data for this endpoint yet.