GET records/v1/context/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of InformationAssetIdentityViewModel
NameDescriptionTypeAdditional information
AccessConditions

string

None.

CatalogueId

integer

None.

CitableReference

string

None.

ClosureCode

string

None.

ClosureStatus

string

None.

ClosureType

string

None.

CoveringDates

string

None.

CoveringFromDate

integer

None.

CoveringToDate

integer

None.

ScopeContent

ScopeContentViewModel

None.

Digitised

boolean

None.

HeldBy

Collection of XReferenceViewModel

None.

Id

string

None.

IsParent

boolean

None.

CatalogueLevel

integer

None.

ParentId

string

None.

RecordOpeningDate

string

None.

ReferencePart

string

None.

ReferenceParentId

string

None.

SortKey

string

None.

Source

string

None.

Title

string

None.

Response Formats

application/json

Sample:
[
  {
    "AccessConditions": "sample string 1",
    "CatalogueId": 2,
    "CitableReference": "sample string 3",
    "ClosureCode": "sample string 4",
    "ClosureStatus": "sample string 5",
    "ClosureType": "sample string 6",
    "CoveringDates": "sample string 7",
    "CoveringFromDate": 8,
    "CoveringToDate": 9,
    "ScopeContent": {
      "PlaceNames": [
        "sample string 1",
        "sample string 2"
      ],
      "Description": "sample string 1",
      "Ephemera": "sample string 2",
      "Schema": "sample string 3"
    },
    "Digitised": true,
    "HeldBy": [
      {
        "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"
      }
    ],
    "Id": "sample string 11",
    "IsParent": true,
    "CatalogueLevel": 13,
    "ParentId": "sample string 14",
    "RecordOpeningDate": "sample string 15",
    "ReferencePart": "sample string 16",
    "ReferenceParentId": "sample string 17",
    "SortKey": "sample string 18",
    "Source": "sample string 19",
    "Title": "sample string 20"
  },
  {
    "AccessConditions": "sample string 1",
    "CatalogueId": 2,
    "CitableReference": "sample string 3",
    "ClosureCode": "sample string 4",
    "ClosureStatus": "sample string 5",
    "ClosureType": "sample string 6",
    "CoveringDates": "sample string 7",
    "CoveringFromDate": 8,
    "CoveringToDate": 9,
    "ScopeContent": {
      "PlaceNames": [
        "sample string 1",
        "sample string 2"
      ],
      "Description": "sample string 1",
      "Ephemera": "sample string 2",
      "Schema": "sample string 3"
    },
    "Digitised": true,
    "HeldBy": [
      {
        "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"
      }
    ],
    "Id": "sample string 11",
    "IsParent": true,
    "CatalogueLevel": 13,
    "ParentId": "sample string 14",
    "RecordOpeningDate": "sample string 15",
    "ReferencePart": "sample string 16",
    "ReferenceParentId": "sample string 17",
    "SortKey": "sample string 18",
    "Source": "sample string 19",
    "Title": "sample string 20"
  }
]

application/xml

Sample:
<ArrayOfInformationAssetIdentityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NationalArchives.DiscoveryAPI.Models.AssetViewModels">
  <InformationAssetIdentityViewModel>
    <AccessConditions>sample string 1</AccessConditions>
    <CatalogueId>2</CatalogueId>
    <CatalogueLevel>13</CatalogueLevel>
    <CitableReference>sample string 3</CitableReference>
    <ClosureCode>sample string 4</ClosureCode>
    <ClosureStatus>sample string 5</ClosureStatus>
    <ClosureType>sample string 6</ClosureType>
    <CoveringDates>sample string 7</CoveringDates>
    <CoveringFromDate>8</CoveringFromDate>
    <CoveringToDate>9</CoveringToDate>
    <Digitised>true</Digitised>
    <HeldBy>
      <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>
    </HeldBy>
    <Id>sample string 11</Id>
    <IsParent>true</IsParent>
    <ParentId>sample string 14</ParentId>
    <RecordOpeningDate>sample string 15</RecordOpeningDate>
    <ReferenceParentId>sample string 17</ReferenceParentId>
    <ReferencePart>sample string 16</ReferencePart>
    <ScopeContent>
      <Description>sample string 1</Description>
      <Ephemera>sample string 2</Ephemera>
      <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>
      <Schema>sample string 3</Schema>
    </ScopeContent>
    <SortKey>sample string 18</SortKey>
    <Source>sample string 19</Source>
    <Title>sample string 20</Title>
  </InformationAssetIdentityViewModel>
  <InformationAssetIdentityViewModel>
    <AccessConditions>sample string 1</AccessConditions>
    <CatalogueId>2</CatalogueId>
    <CatalogueLevel>13</CatalogueLevel>
    <CitableReference>sample string 3</CitableReference>
    <ClosureCode>sample string 4</ClosureCode>
    <ClosureStatus>sample string 5</ClosureStatus>
    <ClosureType>sample string 6</ClosureType>
    <CoveringDates>sample string 7</CoveringDates>
    <CoveringFromDate>8</CoveringFromDate>
    <CoveringToDate>9</CoveringToDate>
    <Digitised>true</Digitised>
    <HeldBy>
      <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>
    </HeldBy>
    <Id>sample string 11</Id>
    <IsParent>true</IsParent>
    <ParentId>sample string 14</ParentId>
    <RecordOpeningDate>sample string 15</RecordOpeningDate>
    <ReferenceParentId>sample string 17</ReferenceParentId>
    <ReferencePart>sample string 16</ReferencePart>
    <ScopeContent>
      <Description>sample string 1</Description>
      <Ephemera>sample string 2</Ephemera>
      <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>
      <Schema>sample string 3</Schema>
    </ScopeContent>
    <SortKey>sample string 18</SortKey>
    <Source>sample string 19</Source>
    <Title>sample string 20</Title>
  </InformationAssetIdentityViewModel>
</ArrayOfInformationAssetIdentityViewModel>