GET /search/fileauthorities

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

Summary: Executes search of File AUthorities (Record creators)
Operation ID: SearchForFileAuthorities_GetFileAuthorities_2
Auth: unknown

Parameters (20)

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.dateFrom (string, query, optional)

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

sps.dateTo (string, query, optional)

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

sps.fileAuthorityCategories (array, query, optional)

Categories filter. <para>List of category codes</para>

sps.fileAuthorityCounties (array, query, optional)

Counties filter

sps.fileAuthorityEntityTypes (array, query, optional)

Record creator type filter. <para>List of FA type codes: </para><para><value>Business - B, Diary - D, Family - F, Manor - M, Organisation - O, Person - P</value></para>

sps.fileAuthorityGender (array, query, optional)

Gender filter. <para>Gender filter for {FileAuthorityEntityTypes} Person</para>

sps.fileAuthorityRegions (array, query, optional)

Regions filter

sps.fileAuthoritySubCategories (array, query, optional)

Subcategories filter. <para>List of sub-category codes</para>

sps.fileAuthourityCountries (array, query, optional)

Countries filter

sps.oldCountyName (string, query, optional)

Old county name

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.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.searchRestrictionFields (array, query, optional)

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

sps.sortByOption (string, query, optional)

Search results sort option

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

sps.timePeriods (array, query, optional)

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

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>

sps.townName (string, query, optional)

Town name (also Manorial record parish name)

No probe data for this endpoint yet.