GET fileauthorities/v1/details/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

None.

Response Information

Resource Description

FileAuthorityViewModel

Name	Type	Additional information
AuthorityName	string	None.
BiographyHistory	string	None.
BiographyHistoryLinks	Collection of XReferenceViewModel	None.
Categories	Collection of CategoryViewModel	None.
Collections	Collection of CollectionViewModel	None.
CorpBodyIsPlaceOfDeposit	boolean	None.
CorpBodyJurisdictionText	string	None.
CorpBodyNationalPlaceOfDepositCode	string	None.
CorpBodyRemitAndFunction	string	None.
CorporateNumber	string	None.
Epithet	string	None.
Forenames	string	None.
FunctionsOccupationsOrActivities	string	None.
Gender	string	None.
Genealogy	string	None.
HistoricalContext	string	None.
History	string	None.
IsAuthorityRecord	boolean	None.
IsPublic	boolean	None.
LegalStatus	string	None.
Name	string	None.
NameForm	string	None.
Places	Collection of PlaceViewModel	None.
PreTitle	string	None.
RelatedResources	Collection of XReferenceViewModel	None.
Relationships	Collection of RelationshipViewModel	None.
SortName	string	None.
Sources	string	None.
SourcesOfAuthority	string	None.
SubjectType	string	None.
Title	string	None.
ValidationText	string	None.
VariantText	string	None.

Response Formats

application/json

Sample:

{
  "AuthorityName": "sample string 1",
  "BiographyHistory": "sample string 2",
  "BiographyHistoryLinks": [
    {
      "XReferenceId": "sample string 1",
      "XReferenceCode": "sample string 2",
      "XReferenceName": "sample string 3",
      "XReferenceType": "sample string 4",
      "XReferenceURL": "sample string 5",
      "XReferenceDescription": "sample string 6",
      "XReferenceSortWord": "sample string 7"
    },
    {
      "XReferenceId": "sample string 1",
      "XReferenceCode": "sample string 2",
      "XReferenceName": "sample string 3",
      "XReferenceType": "sample string 4",
      "XReferenceURL": "sample string 5",
      "XReferenceDescription": "sample string 6",
      "XReferenceSortWord": "sample string 7"
    }
  ],
  "Categories": [
    {
      "CategoryDescription": "sample string 1",
      "CategoryID": 2,
      "SubCategoryDescription": "sample string 3",
      "SubCategoryID": 4
    },
    {
      "CategoryDescription": "sample string 1",
      "CategoryID": 2,
      "SubCategoryDescription": "sample string 3",
      "SubCategoryID": 4
    }
  ],
  "Collections": [
    {
      "CatalogueURL": "sample string 1",
      "CoverindDates": "sample string 2",
      "OtherReferences": "sample string 3",
      "RecordDescription": "sample string 4",
      "RegistryRecordId": 5,
      "RegistryRecordReference": "sample string 6",
      "RegistryRecordSortWord": "sample string 7",
      "RegistryRecordTitle": "sample string 8",
      "RelatedIARecord": "sample string 9",
      "RepositoryID": "sample string 10",
      "RepositoryName": "sample string 11",
      "ScannedLists": [
        {
          "Description": "sample string 1",
          "EndDate": 2,
          "FirstName": "sample string 3",
          "PreTitle": "sample string 4",
          "StartDate": 5,
          "Surname": "sample string 6",
          "Title": "sample string 7",
          "XReferenceId": "sample string 8",
          "XReferenceCode": "sample string 9",
          "XReferenceName": "sample string 10",
          "XReferenceType": "sample string 11",
          "XReferenceURL": "sample string 12",
          "XReferenceDescription": "sample string 13",
          "XReferenceSortWord": "sample string 14"
        },
        {
          "Description": "sample string 1",
          "EndDate": 2,
          "FirstName": "sample string 3",
          "PreTitle": "sample string 4",
          "StartDate": 5,
          "Surname": "sample string 6",
          "Title": "sample string 7",
          "XReferenceId": "sample string 8",
          "XReferenceCode": "sample string 9",
          "XReferenceName": "sample string 10",
          "XReferenceType": "sample string 11",
          "XReferenceURL": "sample string 12",
          "XReferenceDescription": "sample string 13",
          "XReferenceSortWord": "sample string 14"
        }
      ],
      "SortKey": "sample string 12",
      "Source": "sample string 13"
    },
    {
      "CatalogueURL": "sample string 1",
      "CoverindDates": "sample string 2",
      "OtherReferences": "sample string 3",
      "RecordDescription": "sample string 4",
      "RegistryRecordId": 5,
      "RegistryRecordReference": "sample string 6",
      "RegistryRecordSortWord": "sample string 7",
      "RegistryRecordTitle": "sample string 8",
      "RelatedIARecord": "sample string 9",
      "RepositoryID": "sample string 10",
      "RepositoryName": "sample string 11",
      "ScannedLists": [
        {
          "Description": "sample string 1",
          "EndDate": 2,
          "FirstName": "sample string 3",
          "PreTitle": "sample string 4",
          "StartDate": 5,
          "Surname": "sample string 6",
          "Title": "sample string 7",
          "XReferenceId": "sample string 8",
          "XReferenceCode": "sample string 9",
          "XReferenceName": "sample string 10",
          "XReferenceType": "sample string 11",
          "XReferenceURL": "sample string 12",
          "XReferenceDescription": "sample string 13",
          "XReferenceSortWord": "sample string 14"
        },
        {
          "Description": "sample string 1",
          "EndDate": 2,
          "FirstName": "sample string 3",
          "PreTitle": "sample string 4",
          "StartDate": 5,
          "Surname": "sample string 6",
          "Title": "sample string 7",
          "XReferenceId": "sample string 8",
          "XReferenceCode": "sample string 9",
          "XReferenceName": "sample string 10",
          "XReferenceType": "sample string 11",
          "XReferenceURL": "sample string 12",
          "XReferenceDescription": "sample string 13",
          "XReferenceSortWord": "sample string 14"
        }
      ],
      "SortKey": "sample string 12",
      "Source": "sample string 13"
    }
  ],
  "CorpBodyIsPlaceOfDeposit": true,
  "CorpBodyJurisdictionText": "sample string 4",
  "CorpBodyNationalPlaceOfDepositCode": "sample string 5",
  "CorpBodyRemitAndFunction": "sample string 6",
  "CorporateNumber": "sample string 7",
  "Epithet": "sample string 8",
  "Forenames": "sample string 9",
  "FunctionsOccupationsOrActivities": "sample string 10",
  "Gender": "sample string 11",
  "Genealogy": "sample string 12",
  "HistoricalContext": "sample string 13",
  "History": "sample string 14",
  "IsAuthorityRecord": true,
  "IsPublic": true,
  "LegalStatus": "sample string 17",
  "Name": "sample string 18",
  "NameForm": "sample string 19",
  "Places": [
    {
      "Country": "sample string 1",
      "CountryID": 2,
      "County": "sample string 3",
      "CountyID": 4,
      "Description": "sample string 5",
      "DisplayName": "sample string 6",
      "EndDate": 7,
      "Grid": "sample string 8",
      "LocationType": "sample string 9",
      "NewCounty": "sample string 10",
      "NewCountyID": 11,
      "OldCounty": "sample string 12",
      "OldCountyID": 13,
      "Parish": "sample string 14",
      "PlaceName": "sample string 15",
      "Region": "sample string 16",
      "RegionID": 17,
      "StartDate": 18,
      "Town": "sample string 19",
      "TownID": 20,
      "Validation": "sample string 21"
    },
    {
      "Country": "sample string 1",
      "CountryID": 2,
      "County": "sample string 3",
      "CountyID": 4,
      "Description": "sample string 5",
      "DisplayName": "sample string 6",
      "EndDate": 7,
      "Grid": "sample string 8",
      "LocationType": "sample string 9",
      "NewCounty": "sample string 10",
      "NewCountyID": 11,
      "OldCounty": "sample string 12",
      "OldCountyID": 13,
      "Parish": "sample string 14",
      "PlaceName": "sample string 15",
      "Region": "sample string 16",
      "RegionID": 17,
      "StartDate": 18,
      "Town": "sample string 19",
      "TownID": 20,
      "Validation": "sample string 21"
    }
  ],
  "PreTitle": "sample string 20",
  "RelatedResources": [
    {
      "XReferenceId": "sample string 1",
      "XReferenceCode": "sample string 2",
      "XReferenceName": "sample string 3",
      "XReferenceType": "sample string 4",
      "XReferenceURL": "sample string 5",
      "XReferenceDescription": "sample string 6",
      "XReferenceSortWord": "sample string 7"
    },
    {
      "XReferenceId": "sample string 1",
      "XReferenceCode": "sample string 2",
      "XReferenceName": "sample string 3",
      "XReferenceType": "sample string 4",
      "XReferenceURL": "sample string 5",
      "XReferenceDescription": "sample string 6",
      "XReferenceSortWord": "sample string 7"
    }
  ],
  "Relationships": [
    {
      "AuthorityName": "sample string 1",
      "FAID": "sample string 2",
      "RelationshipCategory": "sample string 3",
      "RelationshipDates": "sample string 4",
      "RelationshipDescription": "sample string 5"
    },
    {
      "AuthorityName": "sample string 1",
      "FAID": "sample string 2",
      "RelationshipCategory": "sample string 3",
      "RelationshipDates": "sample string 4",
      "RelationshipDescription": "sample string 5"
    }
  ],
  "SortName": "sample string 21",
  "Sources": "sample string 22",
  "SourcesOfAuthority": "sample string 23",
  "SubjectType": "sample string 24",
  "Title": "sample string 25",
  "ValidationText": "sample string 26",
  "VariantText": "sample string 27"
}

application/xml

Sample:

<FileAuthorityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NationalArchives.DiscoveryAPI.Models.AssetViewModels">
  <AuthorityName>sample string 1</AuthorityName>
  <BiographyHistory>sample string 2</BiographyHistory>
  <BiographyHistoryLinks>
    <XReferenceViewModel>
      <XReferenceCode>sample string 2</XReferenceCode>
      <XReferenceDescription>sample string 6</XReferenceDescription>
      <XReferenceId>sample string 1</XReferenceId>
      <XReferenceName>sample string 3</XReferenceName>
      <XReferenceSortWord>sample string 7</XReferenceSortWord>
      <XReferenceType>sample string 4</XReferenceType>
      <XReferenceURL>sample string 5</XReferenceURL>
    </XReferenceViewModel>
    <XReferenceViewModel>
      <XReferenceCode>sample string 2</XReferenceCode>
      <XReferenceDescription>sample string 6</XReferenceDescription>
      <XReferenceId>sample string 1</XReferenceId>
      <XReferenceName>sample string 3</XReferenceName>
      <XReferenceSortWord>sample string 7</XReferenceSortWord>
      <XReferenceType>sample string 4</XReferenceType>
      <XReferenceURL>sample string 5</XReferenceURL>
    </XReferenceViewModel>
  </BiographyHistoryLinks>
  <Categories>
    <CategoryViewModel>
      <CategoryDescription>sample string 1</CategoryDescription>
      <CategoryID>2</CategoryID>
      <SubCategoryDescription>sample string 3</SubCategoryDescription>
      <SubCategoryID>4</SubCategoryID>
    </CategoryViewModel>
    <CategoryViewModel>
      <CategoryDescription>sample string 1</CategoryDescription>
      <CategoryID>2</CategoryID>
      <SubCategoryDescription>sample string 3</SubCategoryDescription>
      <SubCategoryID>4</SubCategoryID>
    </CategoryViewModel>
  </Categories>
  <Collections>
    <CollectionViewModel>
      <CatalogueURL>sample string 1</CatalogueURL>
      <CoverindDates>sample string 2</CoverindDates>
      <OtherReferences>sample string 3</OtherReferences>
      <RecordDescription>sample string 4</RecordDescription>
      <RegistryRecordId>5</RegistryRecordId>
      <RegistryRecordReference>sample string 6</RegistryRecordReference>
      <RegistryRecordSortWord>sample string 7</RegistryRecordSortWord>
      <RegistryRecordTitle>sample string 8</RegistryRecordTitle>
      <RelatedIARecord>sample string 9</RelatedIARecord>
      <RepositoryID>sample string 10</RepositoryID>
      <RepositoryName>sample string 11</RepositoryName>
      <ScannedLists>
        <EntityReferenceViewModel>
          <XReferenceCode>sample string 9</XReferenceCode>
          <XReferenceDescription>sample string 13</XReferenceDescription>
          <XReferenceId>sample string 8</XReferenceId>
          <XReferenceName>sample string 10</XReferenceName>
          <XReferenceSortWord>sample string 14</XReferenceSortWord>
          <XReferenceType>sample string 11</XReferenceType>
          <XReferenceURL>sample string 12</XReferenceURL>
          <Description>sample string 1</Description>
          <EndDate>2</EndDate>
          <FirstName>sample string 3</FirstName>
          <PreTitle>sample string 4</PreTitle>
          <StartDate>5</StartDate>
          <Surname>sample string 6</Surname>
          <Title>sample string 7</Title>
        </EntityReferenceViewModel>
        <EntityReferenceViewModel>
          <XReferenceCode>sample string 9</XReferenceCode>
          <XReferenceDescription>sample string 13</XReferenceDescription>
          <XReferenceId>sample string 8</XReferenceId>
          <XReferenceName>sample string 10</XReferenceName>
          <XReferenceSortWord>sample string 14</XReferenceSortWord>
          <XReferenceType>sample string 11</XReferenceType>
          <XReferenceURL>sample string 12</XReferenceURL>
          <Description>sample string 1</Description>
          <EndDate>2</EndDate>
          <FirstName>sample string 3</FirstName>
          <PreTitle>sample string 4</PreTitle>
          <StartDate>5</StartDate>
          <Surname>sample string 6</Surname>
          <Title>sample string 7</Title>
        </EntityReferenceViewModel>
      </ScannedLists>
      <SortKey>sample string 12</SortKey>
      <Source>sample string 13</Source>
    </CollectionViewModel>
    <CollectionViewModel>
      <CatalogueURL>sample string 1</CatalogueURL>
      <CoverindDates>sample string 2</CoverindDates>
      <OtherReferences>sample string 3</OtherReferences>
      <RecordDescription>sample string 4</RecordDescription>
      <RegistryRecordId>5</RegistryRecordId>
      <RegistryRecordReference>sample string 6</RegistryRecordReference>
      <RegistryRecordSortWord>sample string 7</RegistryRecordSortWord>
      <RegistryRecordTitle>sample string 8</RegistryRecordTitle>
      <RelatedIARecord>sample string 9</RelatedIARecord>
      <RepositoryID>sample string 10</RepositoryID>
      <RepositoryName>sample string 11</RepositoryName>
      <ScannedLists>
        <EntityReferenceViewModel>
          <XReferenceCode>sample string 9</XReferenceCode>
          <XReferenceDescription>sample string 13</XReferenceDescription>
          <XReferenceId>sample string 8</XReferenceId>
          <XReferenceName>sample string 10</XReferenceName>
          <XReferenceSortWord>sample string 14</XReferenceSortWord>
          <XReferenceType>sample string 11</XReferenceType>
          <XReferenceURL>sample string 12</XReferenceURL>
          <Description>sample string 1</Description>
          <EndDate>2</EndDate>
          <FirstName>sample string 3</FirstName>
          <PreTitle>sample string 4</PreTitle>
          <StartDate>5</StartDate>
          <Surname>sample string 6</Surname>
          <Title>sample string 7</Title>
        </EntityReferenceViewModel>
        <EntityReferenceViewModel>
          <XReferenceCode>sample string 9</XReferenceCode>
          <XReferenceDescription>sample string 13</XReferenceDescription>
          <XReferenceId>sample string 8</XReferenceId>
          <XReferenceName>sample string 10</XReferenceName>
          <XReferenceSortWord>sample string 14</XReferenceSortWord>
          <XReferenceType>sample string 11</XReferenceType>
          <XReferenceURL>sample string 12</XReferenceURL>
          <Description>sample string 1</Description>
          <EndDate>2</EndDate>
          <FirstName>sample string 3</FirstName>
          <PreTitle>sample string 4</PreTitle>
          <StartDate>5</StartDate>
          <Surname>sample string 6</Surname>
          <Title>sample string 7</Title>
        </EntityReferenceViewModel>
      </ScannedLists>
      <SortKey>sample string 12</SortKey>
      <Source>sample string 13</Source>
    </CollectionViewModel>
  </Collections>
  <CorpBodyIsPlaceOfDeposit>true</CorpBodyIsPlaceOfDeposit>
  <CorpBodyJurisdictionText>sample string 4</CorpBodyJurisdictionText>
  <CorpBodyNationalPlaceOfDepositCode>sample string 5</CorpBodyNationalPlaceOfDepositCode>
  <CorpBodyRemitAndFunction>sample string 6</CorpBodyRemitAndFunction>
  <CorporateNumber>sample string 7</CorporateNumber>
  <Epithet>sample string 8</Epithet>
  <Forenames>sample string 9</Forenames>
  <FunctionsOccupationsOrActivities>sample string 10</FunctionsOccupationsOrActivities>
  <Gender>sample string 11</Gender>
  <Genealogy>sample string 12</Genealogy>
  <HistoricalContext>sample string 13</HistoricalContext>
  <History>sample string 14</History>
  <IsAuthorityRecord>true</IsAuthorityRecord>
  <IsPublic>true</IsPublic>
  <LegalStatus>sample string 17</LegalStatus>
  <Name>sample string 18</Name>
  <NameForm>sample string 19</NameForm>
  <Places>
    <PlaceViewModel>
      <Country>sample string 1</Country>
      <CountryID>2</CountryID>
      <County>sample string 3</County>
      <CountyID>4</CountyID>
      <Description>sample string 5</Description>
      <DisplayName>sample string 6</DisplayName>
      <EndDate>7</EndDate>
      <Grid>sample string 8</Grid>
      <LocationType>sample string 9</LocationType>
      <NewCounty>sample string 10</NewCounty>
      <NewCountyID>11</NewCountyID>
      <OldCounty>sample string 12</OldCounty>
      <OldCountyID>13</OldCountyID>
      <Parish>sample string 14</Parish>
      <PlaceName>sample string 15</PlaceName>
      <Region>sample string 16</Region>
      <RegionID>17</RegionID>
      <StartDate>18</StartDate>
      <Town>sample string 19</Town>
      <TownID>20</TownID>
      <Validation>sample string 21</Validation>
    </PlaceViewModel>
    <PlaceViewModel>
      <Country>sample string 1</Country>
      <CountryID>2</CountryID>
      <County>sample string 3</County>
      <CountyID>4</CountyID>
      <Description>sample string 5</Description>
      <DisplayName>sample string 6</DisplayName>
      <EndDate>7</EndDate>
      <Grid>sample string 8</Grid>
      <LocationType>sample string 9</LocationType>
      <NewCounty>sample string 10</NewCounty>
      <NewCountyID>11</NewCountyID>
      <OldCounty>sample string 12</OldCounty>
      <OldCountyID>13</OldCountyID>
      <Parish>sample string 14</Parish>
      <PlaceName>sample string 15</PlaceName>
      <Region>sample string 16</Region>
      <RegionID>17</RegionID>
      <StartDate>18</StartDate>
      <Town>sample string 19</Town>
      <TownID>20</TownID>
      <Validation>sample string 21</Validation>
    </PlaceViewModel>
  </Places>
  <PreTitle>sample string 20</PreTitle>
  <RelatedResources>
    <XReferenceViewModel>
      <XReferenceCode>sample string 2</XReferenceCode>
      <XReferenceDescription>sample string 6</XReferenceDescription>
      <XReferenceId>sample string 1</XReferenceId>
      <XReferenceName>sample string 3</XReferenceName>
      <XReferenceSortWord>sample string 7</XReferenceSortWord>
      <XReferenceType>sample string 4</XReferenceType>
      <XReferenceURL>sample string 5</XReferenceURL>
    </XReferenceViewModel>
    <XReferenceViewModel>
      <XReferenceCode>sample string 2</XReferenceCode>
      <XReferenceDescription>sample string 6</XReferenceDescription>
      <XReferenceId>sample string 1</XReferenceId>
      <XReferenceName>sample string 3</XReferenceName>
      <XReferenceSortWord>sample string 7</XReferenceSortWord>
      <XReferenceType>sample string 4</XReferenceType>
      <XReferenceURL>sample string 5</XReferenceURL>
    </XReferenceViewModel>
  </RelatedResources>
  <Relationships>
    <RelationshipViewModel>
      <AuthorityName>sample string 1</AuthorityName>
      <FAID>sample string 2</FAID>
      <RelationshipCategory>sample string 3</RelationshipCategory>
      <RelationshipDates>sample string 4</RelationshipDates>
      <RelationshipDescription>sample string 5</RelationshipDescription>
    </RelationshipViewModel>
    <RelationshipViewModel>
      <AuthorityName>sample string 1</AuthorityName>
      <FAID>sample string 2</FAID>
      <RelationshipCategory>sample string 3</RelationshipCategory>
      <RelationshipDates>sample string 4</RelationshipDates>
      <RelationshipDescription>sample string 5</RelationshipDescription>
    </RelationshipViewModel>
  </Relationships>
  <SortName>sample string 21</SortName>
  <Sources>sample string 22</Sources>
  <SourcesOfAuthority>sample string 23</SourcesOfAuthority>
  <SubjectType>sample string 24</SubjectType>
  <Title>sample string 25</Title>
  <ValidationText>sample string 26</ValidationText>
  <VariantText>sample string 27</VariantText>
</FileAuthorityViewModel>