Difference between revisions of "contentEadClevel"

From Archives Portal Europe Wiki
Jump to: navigation, search
(Basic Response example)
Line 70: Line 70:
  
 
== Basic Response example ==
 
== Basic Response example ==
For the identifier C392722936:
+
For the identifier C424085747:
 
<pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;">
 
<pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;">
 
{
 
{
   "id": "C392722936",
+
   "totalResults": 1,
   "unitId": "4.AANW - 1298",
+
   "startIndex": 0,
   "unitTitle": "Brielle Prent van stadsgezicht.",
+
  "totalPages": 1,
  "findingAidTitle": "Inventaris van de collectie Aanwinsten Kaarten en Tekeningen sinds 1888",
+
   "eadSearchResults": [
  "repositoryId": 2437,
+
    {
  "repository": "Nationaal Archief",
+
      "id": "C424085747",
  "content": {
+
      "findingAidTitle": "Inventaris van de collectie Aanwinsten Kaarten en Tekeningen sinds 1888",
    "did": {
+
      "findingAidNo": "4.AANW",
       "mdid": [
+
      "repository": "Nationaal Archief",
        {
+
      "country": "NETHERLANDS",
          "content": [
+
       "language": "",
            {
+
      "langMaterial": "",
              "name": "{urn:isbn:1-931666-22-9}extptr",
+
      "unitDate": "[ca. 1700]",
              "declaredType": "gov.loc.ead.Extptr",
+
      "repositoryCode": "NL-HaNA",
              "scope": "gov.loc.ead.Unitid",
+
      "hasDigitalObject": false,
              "value": {
+
      "numberOfDigitalObjects": 0,
                "type": "simple",
+
      "numberOfDigitalObjectsInDescendents": 0,
                "href": "http://proxy.handle.net/10648/da934103-d2bb-46c6-97dc-099cffb844d8"
+
      "numberOfDescendents": 0,
              },
+
      "docType": "Descriptive Unit",
              "nil": false,
+
      "docTypeId": "du",
              "globalScope": false,
+
      "level": "clevel",
              "typeSubstituted": false
+
      "indexDate": "",
            },
+
      "unitId": "4.AANW - 1298",
            "4.AANW - 1298"
+
      "parentId": "F1194841",
          ],
+
      "unitTitle": "Brielle Prent van stadsgezicht.",
          "type": "call number",
+
      "unitTitleWithHighlighting": "<em>Brielle</em> <em>Prent</em> <em>van</em> <em>stadsgezicht</em>.",
          "encodinganalog": "3.1.1"
+
      "scopeContent": "",
        },
+
      "scopeContentWithHighlighting": null,
        {
+
      "numberOfAncestors": 1
          "content": [
+
    }
            "Brielle",
+
  ],
            {
+
  "sortFields": [
              "name": "{urn:isbn:1-931666-22-9}lb",
+
    "date",
              "declaredType": "gov.loc.ead.Lb",
+
    "findingAidNo",
              "scope": "gov.loc.ead.Unittitle",
+
    "orderId",
              "value": {},
+
    "title",
              "nil": false,
+
    "referenceCode"
              "globalScope": false,
+
  ],
              "typeSubstituted": false
+
  "facetFields": {
            },
+
    "country": [
            "Prent van stadsgezicht. "
+
      {
          ],
+
        "id": "7",
          "encodinganalog": "3.1.2"
+
        "name": "NETHERLANDS",
         },
+
         "frequency": 1
        {
+
      }
          "content": [
+
    ],
            "[ca. 1700]"
+
    "subject": [],
          ],
+
    "repository": [
          "encodinganalog": "3.1.3",
+
      {
          "calendar": "gregorian",
+
        "id": "2437",
          "normal": "1700",
+
        "name": "Nationaal Archief",
          "era": "ce"
+
        "frequency": 1
         },
+
      }
         {
+
    ],
          "content": [
+
    "docType": [
            "1 blad ",
+
      {
            {
+
        "id": "fa",
              "name": "{urn:isbn:1-931666-22-9}physfacet",
+
         "name": "fa",
              "declaredType": "gov.loc.ead.Physfacet",
+
         "frequency": 1
              "scope": "gov.loc.ead.Physdesc",
+
      }
              "value": {
+
    ],
                "content": [
+
    "level": [
                  "Gedrukt."
+
      {
                ]
+
        "id": "clevel",
              },
+
        "name": "clevel",
              "nil": false,
+
        "frequency": 1
              "globalScope": false,
+
      }
              "typeSubstituted": false
+
    ],
            }
+
    "hasDigitalObject": [
          ],
+
      {
          "encodinganalog": "3.1.5"
+
        "id": "false",
         }
+
        "name": "false",
       ]
+
        "frequency": 1
     },
+
      }
     "id": "d2e46035",
+
    ],
    "encodinganalog": "3.1.4"
+
    "digitalObjectType": [],
 +
    "unitDateType": [
 +
      {
 +
        "id": "normal",
 +
        "name": "normal",
 +
        "frequency": 1
 +
      }
 +
    ]
 +
  },
 +
  "facetDateFields": {
 +
    "fromDate": [
 +
      {
 +
         "id": "1600-01-01_2",
 +
        "name": "1600-1799",
 +
        "frequency": 1
 +
       }
 +
     ],
 +
     "toDate": [
 +
      {
 +
        "id": "1600-01-01_2",
 +
        "name": "1600-1799",
 +
        "frequency": 1
 +
      }
 +
    ]
 
   }
 
   }
 
}
 
}

Revision as of 13:26, 10 January 2018

Request url: https://api.archivesportaleurope.net/services/content/ead/clevel/{id}. This service is a GET-request.

This content-service delivers all information available of the description of an archival description identified with {id}. A web-developer can use this service to create a detailed presentation of a search result.



Request parameters

id

Internal APE identifier of a descriptive unit (id is starting with "C"). In this service, if the identifier does not start with a "C", you will get an error message. This parameter is required.

N.B.: you can find the (internal APE) identifier of a descriptive unit (always starting with a "C") which is necessary for using this service via the /search/ead service

Response parameters

Empty Response example

{
  "id": "string",
  "unitId": "string",
  "unitTitle": "string",
  "findingAidTitle": "string",
  "repositoryId": 0,
  "repository": "string",
  "content": {
    "head": {
      "content": [
        {}
      ],
      "althead": "string",
      "id": "string",
      "altrender": "string",
      "audience": "string"
    },
    "did": {
      "head": {
        "content": [
          {}
        ],
        "althead": "string",
        "id": "string",
        "altrender": "string",
        "audience": "string"
      },
      "encodinganalog": "string",
      "id": "string",
      "altrender": "string",
      "audience": "string",
      "mdid": [
        {}
      ]
    },
    "theadAndC": [
      {}
    ],
    "level": "CLASS",
    "tpattern": "string",
    "id": "string",
    "altrender": "string",
    "audience": "string",
    "otherlevel": "string",
    "encodinganalog": "string",
    "mdescFull": [
      {}
    ]
  }
}

Basic Response example

For the identifier C424085747:

{
  "totalResults": 1,
  "startIndex": 0,
  "totalPages": 1,
  "eadSearchResults": [
    {
      "id": "C424085747",
      "findingAidTitle": "Inventaris van de collectie Aanwinsten Kaarten en Tekeningen sinds 1888",
      "findingAidNo": "4.AANW",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "[ca. 1700]",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "4.AANW - 1298",
      "parentId": "F1194841",
      "unitTitle": "Brielle Prent van stadsgezicht.",
      "unitTitleWithHighlighting": "<em>Brielle</em> <em>Prent</em> <em>van</em> <em>stadsgezicht</em>.",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 1
    }
  ],
  "sortFields": [
    "date",
    "findingAidNo",
    "orderId",
    "title",
    "referenceCode"
  ],
  "facetFields": {
    "country": [
      {
        "id": "7",
        "name": "NETHERLANDS",
        "frequency": 1
      }
    ],
    "subject": [],
    "repository": [
      {
        "id": "2437",
        "name": "Nationaal Archief",
        "frequency": 1
      }
    ],
    "docType": [
      {
        "id": "fa",
        "name": "fa",
        "frequency": 1
      }
    ],
    "level": [
      {
        "id": "clevel",
        "name": "clevel",
        "frequency": 1
      }
    ],
    "hasDigitalObject": [
      {
        "id": "false",
        "name": "false",
        "frequency": 1
      }
    ],
    "digitalObjectType": [],
    "unitDateType": [
      {
        "id": "normal",
        "name": "normal",
        "frequency": 1
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "1600-01-01_2",
        "name": "1600-1799",
        "frequency": 1
      }
    ],
    "toDate": [
      {
        "id": "1600-01-01_2",
        "name": "1600-1799",
        "frequency": 1
      }
    ]
  }
}

id

Internal APE identifier of the descriptive unit. The same as your request parameter "id".

unitId

Original identifier of the information provided by the repository.

unitTitle

Title of the information, provided by the repository.

findingAidTitle

Title of the finding aid, provided by the repository.

repositoryId

Internal APE identifier of the repository.

repository

Name of the repository.

content

Information in EAD-format, serialized as JSON. This part could potentially contain all the elements that can be part of a Component-element (<c>) of an EAD/XML-document.