v1
latestOpenAPI 3.0.02026-07-232635107.7 KBExecutes search of File AUthorities (Record creators)
Query parameters
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>
Categories filter. <para>List of category codes</para>
Subcategories filter. <para>List of sub-category codes</para>
Gender filter. <para>Gender filter for FileAuthorityEntityTypes Person</para>
Countries filter
Regions filter
Counties filter
Start date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
End date. <para>See <a href="http://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 standard</a></para>
Old county name
Covering period filter. <para>A list of predefined time periods</para>
Town name (also Manorial record parish name)
Search restriction fields. <para>A list of fields to which the search query should be restricted</para>
Search query. <para>May contain boolean expressions, i.e. AND, OR, NOT, quotations marks, brackets and/or wild card (*).</para>
Highlight search terms in search results. <para>If highlight is enabled only a snippet containing highlighted text is returned</para>
Search results sort option
Page number. <para><b>Range [0, 100]</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
Search results page size. <para><b>Range [0, 1000], default 15</b>. In addition, sps.page * sps.resultsPerPage must not exceed 10,000.</para>
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>
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>
Query string parameter for user preferences. <para>Used to pass user-specific preferences as part of the search request.</para>
Response
OK