GET search/v1/archives

Request Information

URI Parameters

Name	Type	Additional information
RepositoryCountries	Collection of string	None.
RepositoryRegions	Collection of string	None.
RepositoryCounties	Collection of string	None.
RepositoryTypes	Collection of RepositoryType	None.
ArchiveCode	integer	None.
TitleContains	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.
PreferenceQueryStringParameter	string	None.

Body Parameters

None.

Response Information

Resource Description

RepositorySearchResultsViewModel

Name	Type	Additional information
Repositories	Collection of RepositorySearchResultViewModel	None.
RepositoryTypes	Collection of FacetItemViewModel	None.
Countries	Collection of FacetItemViewModel	None.
Regions	Collection of FacetItemViewModel	None.
Counties	Collection of FacetItemViewModel	None.
TitleFirstLetters	Collection of FacetItemViewModel	None.
Count	integer	None.
NextBatchMark	string	None.

Response Formats

application/json

Sample:

{
  "Repositories": [
    {
      "Address": "sample string 1",
      "Id": "sample string 2",
      "Reference": "sample string 3",
      "Score": 4.1,
      "Source": "sample string 5",
      "Title": "sample string 6"
    },
    {
      "Address": "sample string 1",
      "Id": "sample string 2",
      "Reference": "sample string 3",
      "Score": 4.1,
      "Source": "sample string 5",
      "Title": "sample string 6"
    }
  ],
  "RepositoryTypes": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "Countries": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "Regions": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "Counties": [
    {
      "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:

<RepositorySearchResultsViewModel 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>
  <Counties>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </Counties>
  <Countries>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </Countries>
  <Regions>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </Regions>
  <Repositories>
    <RepositorySearchResultViewModel>
      <Id>sample string 2</Id>
      <Reference>sample string 3</Reference>
      <Score>4.1</Score>
      <Source>sample string 5</Source>
      <Title>sample string 6</Title>
      <Address>sample string 1</Address>
    </RepositorySearchResultViewModel>
    <RepositorySearchResultViewModel>
      <Id>sample string 2</Id>
      <Reference>sample string 3</Reference>
      <Score>4.1</Score>
      <Source>sample string 5</Source>
      <Title>sample string 6</Title>
      <Address>sample string 1</Address>
    </RepositorySearchResultViewModel>
  </Repositories>
  <RepositoryTypes>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </RepositoryTypes>
</RepositorySearchResultsViewModel>