v1

latestOpenAPI 3.0.02026-07-232635107.7 KB
SearchForFileAuthorities

Executes search of File AUthorities (Record creators)

get/search/v1/fileauthorities

Query parameters

sps.fileAuthorityEntityTypesstring[]

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.fileAuthorityCategoriesstring[]

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

sps.fileAuthoritySubCategoriesstring[]

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

sps.fileAuthorityGenderstring[]

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

sps.fileAuthourityCountriesstring[]

Countries filter

sps.fileAuthorityRegionsstring[]

Regions filter

sps.fileAuthorityCountiesstring[]

Counties filter

sps.dateFromstring date-time

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

sps.dateTostring date-time

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

sps.oldCountyNamestring

Old county name

sps.timePeriodsstring[]

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

sps.townNamestring

Town name (also Manorial record parish name)

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.