GET search/records
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
RecordSeries | Collection of string |
None. |
|
References | Collection of string |
None. |
|
RecordCollections | Collection of RecordsSearchCollection |
None. |
|
DateFrom | date |
None. |
|
DateTo | date |
None. |
|
TimePeriods | Collection of string |
None. |
|
RecordRepositories | Collection of string |
None. |
|
Departments | Collection of string |
None. |
|
TaxonomySubjects | Collection of string |
None. |
|
CatalogueLevels | Collection of RecordCatalogueLevel |
None. |
|
ClosureStatuses | Collection of SearchClosureStatusCode |
None. |
|
CorporateNames | string |
None. |
|
HeldByCode | HeldByCode |
None. |
|
DocumentType | string |
None. |
|
TitleName | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
DateOfBirthFrom | date |
None. |
|
DateOfBirthTo | date |
None. |
|
Number | string |
None. |
|
Occupation | string |
None. |
|
RecordPlace | string |
None. |
|
OldCountyName | string |
None. |
|
TownName | string |
None. |
|
RecordOpeningFromDate | date |
None. |
|
RecordOpeningToDate | date |
None. |
|
ReferenceFirstLetter | string |
None. |
|
ReferenceQuery | string |
None. |
|
SearchRestrictionFields | Collection of string |
None. |
|
RecordSubjects | Collection of string |
None. |
|
SearchQuery | string |
Required |
|
ReturnHighlighted | boolean |
None. |
|
SortByOption | SortResultsOptions |
None. |
|
Page | integer |
Range: inclusive between 0 and 100 |
|
ResultsPageSize | integer |
Range: inclusive between 0 and 1000 |
|
TitleFirstLetter | string |
None. |
|
BatchStartMark | string |
None. |
Body Parameters
None.
Response Information
Resource Description
RecordSearchResultsViewModelName | Description | Type | Additional information |
---|---|---|---|
Records | Collection of RecordSearchResultViewModels |
None. |
|
TaxonomySubjects | Collection of FacetItemViewModel |
None. |
|
TimePeriods | Collection of FacetItemViewModel |
None. |
|
Departments | Collection of FacetItemViewModel |
None. |
|
CatalogueLevels | Collection of FacetItemViewModel |
None. |
|
ClosureStatuses | Collection of FacetItemViewModel |
None. |
|
Sources | Collection of FacetItemViewModel |
None. |
|
Repositories | Collection of FacetItemViewModel |
None. |
|
HeldByReps | Collection of FacetItemViewModel |
None. |
|
ReferenceFirstLetters | Collection of FacetItemViewModel |
None. |
|
TitleFirstLetters | Collection of FacetItemViewModel |
None. |
|
Count | integer |
None. |
|
NextBatchMark | string |
None. |
Response Formats
application/json
Sample:
{ "Records": [ { "AltName": "sample string 1", "Places": [ "sample string 1", "sample string 2" ], "CorpBodies": [ "sample string 1", "sample string 2" ], "Taxonomies": [ "sample string 1", "sample string 2" ], "FormerReferenceDep": "sample string 2", "FormerReferencePro": "sample string 3", "HeldBy": [ "sample string 1", "sample string 2" ], "Context": "sample string 4", "Content": "sample string 5", "URLParameters": "sample string 6", "Department": "sample string 7", "Note": "sample string 8", "AdminHistory": "sample string 9", "Arrangement": "sample string 10", "MapDesignation": "sample string 11", "MapScale": "sample string 12", "PhysicalCondition": "sample string 13", "CatalogueLevel": 14, "OpeningDate": "sample string 15", "ClosureStatus": "sample string 16", "ClosureType": "sample string 17", "ClosureCode": "sample string 18", "DocumentType": "sample string 19", "CoveringDates": "sample string 20", "Description": "sample string 21", "EndDate": "sample string 22", "NumEndDate": 23, "NumStartDate": 24, "StartDate": "sample string 25", "Id": "sample string 26", "Reference": "sample string 27", "Score": 28.1, "Source": "sample string 29", "Title": "sample string 30" }, { "AltName": "sample string 1", "Places": [ "sample string 1", "sample string 2" ], "CorpBodies": [ "sample string 1", "sample string 2" ], "Taxonomies": [ "sample string 1", "sample string 2" ], "FormerReferenceDep": "sample string 2", "FormerReferencePro": "sample string 3", "HeldBy": [ "sample string 1", "sample string 2" ], "Context": "sample string 4", "Content": "sample string 5", "URLParameters": "sample string 6", "Department": "sample string 7", "Note": "sample string 8", "AdminHistory": "sample string 9", "Arrangement": "sample string 10", "MapDesignation": "sample string 11", "MapScale": "sample string 12", "PhysicalCondition": "sample string 13", "CatalogueLevel": 14, "OpeningDate": "sample string 15", "ClosureStatus": "sample string 16", "ClosureType": "sample string 17", "ClosureCode": "sample string 18", "DocumentType": "sample string 19", "CoveringDates": "sample string 20", "Description": "sample string 21", "EndDate": "sample string 22", "NumEndDate": 23, "NumStartDate": 24, "StartDate": "sample string 25", "Id": "sample string 26", "Reference": "sample string 27", "Score": 28.1, "Source": "sample string 29", "Title": "sample string 30" } ], "TaxonomySubjects": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "TimePeriods": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "Departments": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "CatalogueLevels": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "ClosureStatuses": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "Sources": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "Repositories": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "HeldByReps": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "ReferenceFirstLetters": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "TitleFirstLetters": [ { "Code": "sample string 1", "Count": 2 }, { "Code": "sample string 1", "Count": 2 } ], "Count": 1, "NextBatchMark": "sample string 2" }
application/xml
Sample:
<RecordSearchResultsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NationalArchives.DiscoveryAPI.Models.SearchResultsViewModels"> <Count>1</Count> <NextBatchMark>sample string 2</NextBatchMark> <TitleFirstLetters> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </TitleFirstLetters> <CatalogueLevels> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </CatalogueLevels> <ClosureStatuses> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </ClosureStatuses> <Departments> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </Departments> <HeldByReps> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </HeldByReps> <Records> <RecordSearchResultViewModels> <Id>sample string 26</Id> <Reference>sample string 27</Reference> <Score>28.1</Score> <Source>sample string 29</Source> <Title>sample string 30</Title> <CoveringDates>sample string 20</CoveringDates> <Description>sample string 21</Description> <EndDate>sample string 22</EndDate> <NumEndDate>23</NumEndDate> <NumStartDate>24</NumStartDate> <StartDate>sample string 25</StartDate> <AdminHistory>sample string 9</AdminHistory> <AltName>sample string 1</AltName> <Arrangement>sample string 10</Arrangement> <CatalogueLevel>14</CatalogueLevel> <ClosureCode>sample string 18</ClosureCode> <ClosureStatus>sample string 16</ClosureStatus> <ClosureType>sample string 17</ClosureType> <Content>sample string 5</Content> <Context>sample string 4</Context> <CorpBodies xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </CorpBodies> <Department>sample string 7</Department> <DocumentType>sample string 19</DocumentType> <FormerReferenceDep>sample string 2</FormerReferenceDep> <FormerReferencePro>sample string 3</FormerReferencePro> <HeldBy xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </HeldBy> <MapDesignation>sample string 11</MapDesignation> <MapScale>sample string 12</MapScale> <Note>sample string 8</Note> <OpeningDate>sample string 15</OpeningDate> <PhysicalCondition>sample string 13</PhysicalCondition> <Places xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Places> <Taxonomies xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Taxonomies> <URLParameters>sample string 6</URLParameters> </RecordSearchResultViewModels> <RecordSearchResultViewModels> <Id>sample string 26</Id> <Reference>sample string 27</Reference> <Score>28.1</Score> <Source>sample string 29</Source> <Title>sample string 30</Title> <CoveringDates>sample string 20</CoveringDates> <Description>sample string 21</Description> <EndDate>sample string 22</EndDate> <NumEndDate>23</NumEndDate> <NumStartDate>24</NumStartDate> <StartDate>sample string 25</StartDate> <AdminHistory>sample string 9</AdminHistory> <AltName>sample string 1</AltName> <Arrangement>sample string 10</Arrangement> <CatalogueLevel>14</CatalogueLevel> <ClosureCode>sample string 18</ClosureCode> <ClosureStatus>sample string 16</ClosureStatus> <ClosureType>sample string 17</ClosureType> <Content>sample string 5</Content> <Context>sample string 4</Context> <CorpBodies xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </CorpBodies> <Department>sample string 7</Department> <DocumentType>sample string 19</DocumentType> <FormerReferenceDep>sample string 2</FormerReferenceDep> <FormerReferencePro>sample string 3</FormerReferencePro> <HeldBy xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </HeldBy> <MapDesignation>sample string 11</MapDesignation> <MapScale>sample string 12</MapScale> <Note>sample string 8</Note> <OpeningDate>sample string 15</OpeningDate> <PhysicalCondition>sample string 13</PhysicalCondition> <Places xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Places> <Taxonomies xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Taxonomies> <URLParameters>sample string 6</URLParameters> </RecordSearchResultViewModels> </Records> <ReferenceFirstLetters> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </ReferenceFirstLetters> <Repositories> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </Repositories> <Sources> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </Sources> <TaxonomySubjects> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </TaxonomySubjects> <TimePeriods> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> <FacetItemViewModel> <Code>sample string 1</Code> <Count>2</Count> </FacetItemViewModel> </TimePeriods> </RecordSearchResultsViewModel>