Revision as of 12:38, 5 June 2017

Request url: https://api.archivesportaleurope.net/services/hierarchy/ead/{id}/ancestors. This service is a POST-request.

This hierarchy service delivers a list of all archival descriptions in the path from root to {id} in the hierarchy of the archival description. A web developer can use this service to create a tree-like presentation of a finding aid.

Request parameters

Only one request parameter is required: the internal APE identifier of the descriptive unit for which a list of higher level ancestors is needed.

On [base_url]/hierarchy/ead/{id}/ancestors, all the clevel descriptive units of that are on the path from {id} to the root of the hierarchy of the finding aid are given.

Response parameters

The response contains a list of the descriptions that were found from the descriptive unit for which an identifier was provided up till the root of the finding aid.

Empty Response example:

{
  "totalResults": 0,
  "startIndex": 0,
  "totalPages": 0,
  "results": [
    {
      "id": "string",
      "fondsUnitTitle": "string",
      "fondsUnitId": "string",
      "repository": "string",
      "country": "string",
      "language": "string",
      "langMaterial": "string",
      "unitDate": "string",
      "repositoryCode": "string",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "string",
      "docTypeId": "string",
      "level": "string",
      "indexDate": "string",
      "unitId": "string",
      "unitTitle": "string",
      "scopeContent": "string",
      "siblingPosition": 0,
      "ancestorLevel": 0
    }
  ]
}

Basic Response example (for identifier: C85437490):

{
  "totalResults": 2,
  "startIndex": 0,
  "totalPages": 1,
  "results": [
    {
      "id": "F379211",
      "fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
      "fondsUnitId": "2.13.132",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1938-1960",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 23297,
      "numberOfDescendents": 5627,
      "docType": "Finding Aid",
      "docTypeId": "fa",
      "level": "archdesc",
      "indexDate": "",
      "unitId": "2.13.132",
      "unitTitle": "Ministerie van Defensie: Strijdkrachten in Nederlands-Indië",
      "scopeContent": "In het archief zijn de onder meer opgenomen de archieven van het Hoofdkwartier van de Generale Staf in Nederlands-Indië (HKGS-NI) (1945-1950), de Centrale Militaire Inlichtingendienst (1941-1949), de Commandant \"7 December\" Divisie, de Adjudant-Generaal in Nederlands-Indië/Indonesië (1945-1952), de staven van de T t/m Z Brigade, de Compagnieën Aan- en Afvoertroepen, de Kwartiermeester-Generaal en het Afwikkelingscommando in Indonesië (1950-1951). Tenslotte bevat het archief ook een collectie onderdeelsverslagen van Koninklijke Landmacht en het KNIL. Daaronder bevinden zich ook verslagen van het Korps Speciale Troepen en Korps Militaire Politie/Koninklijke Marechaussee.  Inhoud Onderzoek toonde aan dat bij het Bureau Centraal Archievendepot (BCAD) van het Defensie, Archieven-, Registratie- en Informatiecentrum een aantal archieven aanwezig was die door militaire instanties/onderdelen gevormd waren in het voormalige Nederlands-Indië. In overleg met het Nationaal Archief is besloten om deze in de \"Collectie archieven Strijdkrachten in Nederlands-Indië, (1938-1939) 1941-1957 [1960]\" samen te brengen, te inventariseren en over te dragen aan het Nationaal Archief. Het betreft hier de volgende archieven: Beleidsterrein Operatiën: Hoofdkwartier van de Generale Staf in Nederlands-Indië, 1945 - 1950; Hoofdkwartier van de Generale Staf in Nederlands-Indië, Sectie Krijgsgeschiedenis, 1945 - 1949; Kabinet van de Legercommandant in Nederlands-Indië, 1945 - 1950; Netherlands Forces Intelligence Service/Centrale Militaire Inlichtingendienst, 1941 - 1949; Hoofdkwartier Militaire Luchtvaart van het KNIL, Kantoor Inlichtingen in Nederlands-Indië, (1938-1939) 1942 - 1950; Collectie verspreide archivalia van de strijdkrachten in Indonesië, speciaal Oost-Java, 1945 - 1949; Collectie archiefbescheiden van de Commandant \"7 December\" Divisie en de onder zijn bevel ressorterende onderdelen in Nederlands-Indië, 1945 - 1950; Staven van de T t/m Z-Brigade en de Staf Bataljon 2-13 Regiment Infanterie in Nederlands-Indië, [1945] 1946 - 1950; Collectie onderdeelsverslagen in Nederlands-Indië, 1945 - 1950; Bataljons behorende tot Regimenten Infanterie in Nederlands-Indië, 1945 - 1950; Compagnieën Aan- en Afvoertroepen, 1945 - 1950; 6, 10 en 14 Genie Veldcompagnie Indië, 1947 - 1950. Beleidsterrein Personeel: Korps Militaire Politie/Koninklijke Marechaussee KNIL, 1947 - 1951; Hoofdkwartier Adjudant-Generaal in Indonesië, 1945 - 1952; Afwikkelingscommando in Indonesië, 1950 - 1951; Hoofdkwartier Militaire Luchtvaart, Kantoor Personeel, 1945 - 1949; Hoofd van de Militaire Geneeskundige Dienst te Batavia, 1948 - 1949; Subsistentenbataljon, 1946 - 1951; Persoonlijk archief van reserve luitenant-kolonel mr. J.F. Scheers, 1946 - 1948, 1952 - 1957 [1960]. Beleidsterrein Materieel: Kwartiermeester-Generaal/Territorium Nieuw-Guinea, 1949; Kwartiermeester-Generaal/Legermaterieeldienst, 1947 - 1950; Kwartiermeester-Generaal/Assistent Directeur Leger Materieeldienst - 3, [1947] 1949; Commissie van Proefneming in Nederlands-Indië, 1946 - 1950. Het totaal van de collectie heeft een omvang van 125m.",
      "siblingPosition": 0,
      "ancestorLevel": 0
    },
    {
      "id": "C85435671",
      "fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
      "fondsUnitId": "2.13.132",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 23297,
      "numberOfDescendents": 4525,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.13.132 - A",
      "unitTitle": "Beleidsterrein Operatiën",
      "scopeContent": "",
      "siblingPosition": 1,
      "ancestorLevel": 1
    }
  ]
}

totalResults

The response parameter "totalResults" gives the number of results.

startIndex

The response parameter "startIndex" gives the number of the chunk you requested.

totalPages

The response parameter "totalPages" gives the number of chunks.

results

Enumeration of the results. A result could be a holdings guide, a source guide, a finding aid, or a descriptive unit (ie. a sublevel component). They are all optional except "id".