GET records/v1/collection/{reference}

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

Summary: Get collection of records with the same citable reference
Operation ID: getRecordCollection
Auth: unknown
Description

Retrieve a collection of records sharing the same citable reference. Values of reference, batchStartRecordId and batchStartMark are case sensitive.

Parameters (7)

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}

reference (string, path, required)

Citable reference

source (string, query, optional)

Records source filter. Default TNA

Constraints: {'enum': ['TNA', 'A2A']}

No probe data for this endpoint yet.