GET fileauthorities/collection/{type}

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

Summary: Get file authority records collection
Operation ID: FileAuthority_GetFileAuthorities_2
Auth: unknown
Description

Values of {batchStartRecordId} and {batchStartMark} are case sensitive

Parameters (6)

batchStartMark (string, query, optional)

Value of a record's SortKey field from which the next page will start. <para>Can be used with {batchStartRecordId} but {batchStartMark} takes precedence</para>

batchStartRecordId (string, query, optional)

Value of a record's ID field from which the next page will start. <para>Can be used with {batchStartMark} but {batchStartMark} takes precedence</para>

direction (string, query, optional)

Paging direction

Constraints: {'enum': ['NEXT', 'PREV']}

includeCursor (boolean, query, optional)

Include or exclude cursor in the list of records returned by the query

limit (integer, query, optional)

Number of records returned by the request. <b>Range [1,500], default 30</b>

type (string, path, required)

File authority record type

Constraints: {'enum': ['Business', 'Family', 'Manor', 'Organisation', 'Person']}

No probe data for this endpoint yet.