GET fileauthorities/collection/{type}?direction={direction}&includeCursor={includeCursor}&batchStartRecordId={batchStartRecordId}&batchStartMark={batchStartMark}&limit={limit}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
type | FAType |
Required |
|
direction | Direction |
Default value is NEXT |
|
includeCursor | boolean |
Default value is True |
|
batchStartRecordId | string |
Default value is |
|
batchStartMark | string |
Default value is |
|
limit | integer |
Default value is 30 |
Body Parameters
None.
Response Information
Resource Description
AssetCollectionViewModelOfFileAuthorityIdentityViewModelName | Description | Type | Additional information |
---|---|---|---|
Assets | Collection of FileAuthorityIdentityViewModel |
None. |
|
HasMoreAfterLast | boolean |
None. |
|
HasMoreBeforeFirst | boolean |
None. |
Response Formats
application/json
Sample:
{ "Assets": [ { "BrowseChar": "sample string 1", "Id": "sample string 2", "FAType": "sample string 3", "SortKey": "sample string 4", "SubjectTitle": "sample string 5", "PlaceNames": [ "sample string 1", "sample string 2" ] }, { "BrowseChar": "sample string 1", "Id": "sample string 2", "FAType": "sample string 3", "SortKey": "sample string 4", "SubjectTitle": "sample string 5", "PlaceNames": [ "sample string 1", "sample string 2" ] } ], "HasMoreAfterLast": true, "HasMoreBeforeFirst": true }
application/xml
Sample:
<AssetCollectionViewModelOfFileAuthorityIdentityViewModelPX1kkKkE xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NationalArchives.DiscoveryAPI.Models.AssetViewModels"> <Assets> <FileAuthorityIdentityViewModel> <BrowseChar>sample string 1</BrowseChar> <FAType>sample string 3</FAType> <Id>sample string 2</Id> <PlaceNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </PlaceNames> <SortKey>sample string 4</SortKey> <SubjectTitle>sample string 5</SubjectTitle> </FileAuthorityIdentityViewModel> <FileAuthorityIdentityViewModel> <BrowseChar>sample string 1</BrowseChar> <FAType>sample string 3</FAType> <Id>sample string 2</Id> <PlaceNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </PlaceNames> <SortKey>sample string 4</SortKey> <SubjectTitle>sample string 5</SubjectTitle> </FileAuthorityIdentityViewModel> </Assets> <HasMoreAfterLast>true</HasMoreAfterLast> <HasMoreBeforeFirst>true</HasMoreBeforeFirst> </AssetCollectionViewModelOfFileAuthorityIdentityViewModelPX1kkKkE>