GET search/fileauthorities

Request Information

URI Parameters

Name	Type	Additional information
FileAuthorityEntityTypes	Collection of FileAuthorityType	None.
FileAuthorityCategories	Collection of string	None.
FileAuthoritySubCategories	Collection of string	None.
FileAuthorityGender	Collection of FileAuthorityGender	None.
FileAuthourityCountries	Collection of string	None.
FileAuthorityRegions	Collection of string	None.
FileAuthorityCounties	Collection of string	None.
DateFrom	date	None.
DateTo	date	None.
OldCountyName	string	None.
TimePeriods	Collection of string	None.
TownName	string	None.
SearchRestrictionFields	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

FileAuthoritySearchResultsViewModel

Name	Type	Additional information
FileAuthorityAssets	Collection of FileAuthoritySearchResultViewModel	None.
NACategories	Collection of FacetItemViewModel	None.
NASubCategories	Collection of FacetItemViewModel	None.
Gender	Collection of FacetItemViewModel	None.
EntityTypes	Collection of FacetItemViewModel	None.
Countries	Collection of FacetItemViewModel	None.
Regions	Collection of FacetItemViewModel	None.
Counties	Collection of FacetItemViewModel	None.
Towns	Collection of FacetItemViewModel	None.
Places	Collection of FacetItemViewModel	None.
TimePeriods	Collection of FacetItemViewModel	None.
TitleFirstLetters	Collection of FacetItemViewModel	None.
Count	integer	None.
NextBatchMark	string	None.

Response Formats

application/json

Sample:

{
  "FileAuthorityAssets": [
    {
      "AltName": "sample string 1",
      "SubjectType": "sample string 2",
      "RepositoriesCount": 3,
      "CollectionCount": 4,
      "Places": [
        "sample string 1",
        "sample string 2"
      ],
      "Collections": [
        {
          "RepositoryId": "sample string 1",
          "RepositoryName": "sample string 2"
        },
        {
          "RepositoryId": "sample string 1",
          "RepositoryName": "sample string 2"
        }
      ],
      "CoveringDates": "sample string 5",
      "Description": "sample string 6",
      "EndDate": "sample string 7",
      "NumEndDate": 8,
      "NumStartDate": 9,
      "StartDate": "sample string 10",
      "Id": "sample string 11",
      "Reference": "sample string 12",
      "Score": 13.1,
      "Source": "sample string 14",
      "Title": "sample string 15"
    },
    {
      "AltName": "sample string 1",
      "SubjectType": "sample string 2",
      "RepositoriesCount": 3,
      "CollectionCount": 4,
      "Places": [
        "sample string 1",
        "sample string 2"
      ],
      "Collections": [
        {
          "RepositoryId": "sample string 1",
          "RepositoryName": "sample string 2"
        },
        {
          "RepositoryId": "sample string 1",
          "RepositoryName": "sample string 2"
        }
      ],
      "CoveringDates": "sample string 5",
      "Description": "sample string 6",
      "EndDate": "sample string 7",
      "NumEndDate": 8,
      "NumStartDate": 9,
      "StartDate": "sample string 10",
      "Id": "sample string 11",
      "Reference": "sample string 12",
      "Score": 13.1,
      "Source": "sample string 14",
      "Title": "sample string 15"
    }
  ],
  "NACategories": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "NASubCategories": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "Gender": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "EntityTypes": [
    {
      "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
    }
  ],
  "Towns": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "Places": [
    {
      "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
    }
  ],
  "TitleFirstLetters": [
    {
      "Code": "sample string 1",
      "Count": 2
    },
    {
      "Code": "sample string 1",
      "Count": 2
    }
  ],
  "Count": 1,
  "NextBatchMark": "sample string 2"
}

application/xml

Sample:

<FileAuthoritySearchResultsViewModel 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>
  <EntityTypes>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </EntityTypes>
  <FileAuthorityAssets>
    <FileAuthoritySearchResultViewModel>
      <Id>sample string 11</Id>
      <Reference>sample string 12</Reference>
      <Score>13.1</Score>
      <Source>sample string 14</Source>
      <Title>sample string 15</Title>
      <CoveringDates>sample string 5</CoveringDates>
      <Description>sample string 6</Description>
      <EndDate>sample string 7</EndDate>
      <NumEndDate>8</NumEndDate>
      <NumStartDate>9</NumStartDate>
      <StartDate>sample string 10</StartDate>
      <AltName>sample string 1</AltName>
      <CollectionCount>4</CollectionCount>
      <Collections>
        <NRARepositoryViewModel>
          <RepositoryId>sample string 1</RepositoryId>
          <RepositoryName>sample string 2</RepositoryName>
        </NRARepositoryViewModel>
        <NRARepositoryViewModel>
          <RepositoryId>sample string 1</RepositoryId>
          <RepositoryName>sample string 2</RepositoryName>
        </NRARepositoryViewModel>
      </Collections>
      <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>
      <RepositoriesCount>3</RepositoriesCount>
      <SubjectType>sample string 2</SubjectType>
    </FileAuthoritySearchResultViewModel>
    <FileAuthoritySearchResultViewModel>
      <Id>sample string 11</Id>
      <Reference>sample string 12</Reference>
      <Score>13.1</Score>
      <Source>sample string 14</Source>
      <Title>sample string 15</Title>
      <CoveringDates>sample string 5</CoveringDates>
      <Description>sample string 6</Description>
      <EndDate>sample string 7</EndDate>
      <NumEndDate>8</NumEndDate>
      <NumStartDate>9</NumStartDate>
      <StartDate>sample string 10</StartDate>
      <AltName>sample string 1</AltName>
      <CollectionCount>4</CollectionCount>
      <Collections>
        <NRARepositoryViewModel>
          <RepositoryId>sample string 1</RepositoryId>
          <RepositoryName>sample string 2</RepositoryName>
        </NRARepositoryViewModel>
        <NRARepositoryViewModel>
          <RepositoryId>sample string 1</RepositoryId>
          <RepositoryName>sample string 2</RepositoryName>
        </NRARepositoryViewModel>
      </Collections>
      <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>
      <RepositoriesCount>3</RepositoriesCount>
      <SubjectType>sample string 2</SubjectType>
    </FileAuthoritySearchResultViewModel>
  </FileAuthorityAssets>
  <Gender>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </Gender>
  <NACategories>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </NACategories>
  <NASubCategories>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </NASubCategories>
  <Places>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </Places>
  <Regions>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </Regions>
  <TimePeriods>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </TimePeriods>
  <Towns>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
    <FacetItemViewModel>
      <Code>sample string 1</Code>
      <Count>2</Count>
    </FacetItemViewModel>
  </Towns>
</FileAuthoritySearchResultsViewModel>