v1

latestOpenAPI 3.0.02026-07-232635107.7 KB

FileAuthority

Get file authority records collection

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

get/fileauthorities/v1/collection/{type}

Path parameters

type'Business' | 'Family' | 'Manor' | 'Organisation' | 'Person' required

File authority record type

Query parameters

direction'NEXT' | 'PREV'

Paging direction

includeCursorboolean

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

batchStartRecordIdstring

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>

batchStartMarkstring

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>

limitinteger

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

Response

HasMoreAfterLastboolean

Gets or sets a value indicating whether there are more assets after the last item in the collection.

HasMoreBeforeFirstboolean

Gets or sets a value indicating whether there are more assets before the first item in the collection.