GET /fileauthorities/v1/collection/{type}

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

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

Retrieve a collection of file authority records. 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

batchStartRecordId (string, query, optional)

Value of a record's ID field from which the next page will start

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, default: 30)

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

Constraints: {'minimum': 1, 'maximum': 500}

type (string, path, required)

File authority record type

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

No probe data for this endpoint yet.