Difference between revisions of "contentEadClevel"

From Archives Portal Europe Wiki
Jump to: navigation, search
Line 12: Line 12:
 
= Response parameters =
 
= Response parameters =
  
 +
Empty Response example:
 
<pre>
 
<pre>
 
{
 
{
   "id": "C4134966",
+
   "id": "string",
   "unitId": "2.05.313 - 2.77",
+
   "unitId": "string",
   "unitTitle": "Nepal",
+
  "unitTitle": "string",
   "fondsUnitTitle": "Inventaris van het code-archief van het Ministerie van Buitenlandse Zaken, 1965-1974",
+
  "fondsUnitTitle": "string",
   "repositoryId": 361,
+
  "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",
 +
    "id": "string",
 +
    "altrender": "string",
 +
    "audience": "string",
 +
    "otherlevel": "string",
 +
    "encodinganalog": "string",
 +
    "tpattern": "string",
 +
    "mdescFull": [
 +
      {}
 +
    ]
 +
  }
 +
}
 +
</pre>
 +
 
 +
Basic Response example (for the identifier: C85430764):
 +
<pre>
 +
{
 +
  "id": "C85430764",
 +
  "unitId": "4.AANW - 1298",
 +
   "unitTitle": "Brielle Prent van stadsgezicht.",
 +
   "fondsUnitTitle": "Inventaris van de collectie Aanwinsten Kaarten en Tekeningen sinds 1888",
 +
   "repositoryId": 32171,
 
   "repository": "Nationaal Archief",
 
   "repository": "Nationaal Archief",
 
   "content": {
 
   "content": {
  --- skip ---
+
    "did": {
 +
      "mdid": [
 +
        {
 +
          "content": [
 +
            {
 +
              "name": "{urn:isbn:1-931666-22-9}extptr",
 +
              "declaredType": "gov.loc.ead.Extptr",
 +
              "scope": "gov.loc.ead.Unitid",
 +
              "value": {
 +
                "type": "simple",
 +
                "href": "http://proxy.handle.net/10648/da934103-d2bb-46c6-97dc-099cffb844d8"
 +
              },
 +
              "nil": false,
 +
              "globalScope": false,
 +
              "typeSubstituted": false
 +
            },
 +
            "4.AANW - 1298"
 +
          ],
 +
          "type": "call number",
 +
          "encodinganalog": "3.1.1"
 +
        },
 +
        {
 +
          "content": [
 +
            "Brielle",
 +
            {
 +
              "name": "{urn:isbn:1-931666-22-9}lb",
 +
              "declaredType": "gov.loc.ead.Lb",
 +
              "scope": "gov.loc.ead.Unittitle",
 +
              "value": {},
 +
              "nil": false,
 +
              "globalScope": false,
 +
              "typeSubstituted": false
 +
            },
 +
            "Prent van stadsgezicht. "
 +
          ],
 +
          "encodinganalog": "3.1.2"
 +
        },
 +
        {
 +
          "content": [
 +
            "[ca. 1700]"
 +
          ],
 +
          "encodinganalog": "3.1.3",
 +
          "era": "ce",
 +
          "calendar": "gregorian",
 +
          "normal": "1700"
 +
        },
 +
        {
 +
          "content": [
 +
            "1 blad ",
 +
            {
 +
              "name": "{urn:isbn:1-931666-22-9}physfacet",
 +
              "declaredType": "gov.loc.ead.Physfacet",
 +
              "scope": "gov.loc.ead.Physdesc",
 +
              "value": {
 +
                "content": [
 +
                  "Gedrukt."
 +
                ]
 +
              },
 +
              "nil": false,
 +
              "globalScope": false,
 +
              "typeSubstituted": false
 +
            }
 +
          ],
 +
          "encodinganalog": "3.1.5"
 +
        }
 +
      ]
 +
    },
 +
    "id": "d2e46036",
 +
    "encodinganalog": "3.1.4"
 
   }
 
   }
 
}
 
}

Revision as of 12:31, 5 June 2017

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.

Response parameters

Empty Response example:

{
  "id": "string",
  "unitId": "string",
  "unitTitle": "string",
  "fondsUnitTitle": "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",
    "id": "string",
    "altrender": "string",
    "audience": "string",
    "otherlevel": "string",
    "encodinganalog": "string",
    "tpattern": "string",
    "mdescFull": [
      {}
    ]
  }
}

Basic Response example (for the identifier: C85430764):

{
  "id": "C85430764",
  "unitId": "4.AANW - 1298",
  "unitTitle": "Brielle Prent van stadsgezicht.",
  "fondsUnitTitle": "Inventaris van de collectie Aanwinsten Kaarten en Tekeningen sinds 1888",
  "repositoryId": 32171,
  "repository": "Nationaal Archief",
  "content": {
    "did": {
      "mdid": [
        {
          "content": [
            {
              "name": "{urn:isbn:1-931666-22-9}extptr",
              "declaredType": "gov.loc.ead.Extptr",
              "scope": "gov.loc.ead.Unitid",
              "value": {
                "type": "simple",
                "href": "http://proxy.handle.net/10648/da934103-d2bb-46c6-97dc-099cffb844d8"
              },
              "nil": false,
              "globalScope": false,
              "typeSubstituted": false
            },
            "4.AANW - 1298"
          ],
          "type": "call number",
          "encodinganalog": "3.1.1"
        },
        {
          "content": [
            "Brielle",
            {
              "name": "{urn:isbn:1-931666-22-9}lb",
              "declaredType": "gov.loc.ead.Lb",
              "scope": "gov.loc.ead.Unittitle",
              "value": {},
              "nil": false,
              "globalScope": false,
              "typeSubstituted": false
            },
            "Prent van stadsgezicht. "
          ],
          "encodinganalog": "3.1.2"
        },
        {
          "content": [
            "[ca. 1700]"
          ],
          "encodinganalog": "3.1.3",
          "era": "ce",
          "calendar": "gregorian",
          "normal": "1700"
        },
        {
          "content": [
            "1 blad ",
            {
              "name": "{urn:isbn:1-931666-22-9}physfacet",
              "declaredType": "gov.loc.ead.Physfacet",
              "scope": "gov.loc.ead.Physdesc",
              "value": {
                "content": [
                  "Gedrukt."
                ]
              },
              "nil": false,
              "globalScope": false,
              "typeSubstituted": false
            }
          ],
          "encodinganalog": "3.1.5"
        }
      ]
    },
    "id": "d2e46036",
    "encodinganalog": "3.1.4"
  }
}

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.

fondsUnitTitle

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.