hierarchyEadChildren

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

This hierarchy service delivers a list of all archival descriptions one level deeper in the hierarchy of the archival description identified with {id}. A web developer can use this service to create a tree-like presentation of a finding aid.

Request parameters

Two request parameters can be used to get a list of children of an archival description.

eg.

{
  "count": "5",
  "startIndex": 0
}

On [base_url]/search/ead/F9816/descendants, it gives all the clevel descriptive units of finding aid identified with "F9816", that contain the searchterm "nepal".

count

The resultlist is delivered in chunks of a certain size. Request parameter "count" describes the number of results that are in one chunk. Optional. Default value is 5.

startIndex

Request parameter "startIndex" enables you to select the results that you want to have. Counting starts at zero. If "count" = 5, the second chunk starts with startIndex 5, the following at startIndex 10, etc. Optional. Default value is 0.

Response parameters

The response contains a list of the descriptions where the requested search-term(s) was/were found.

eg.

{
  "totalResults": 0,
  "startIndex": 0,
  "totalPages": 0,
  "children": [
    {
      "id": "string",
      "fondsUnitTitle": "string",
      "fondsUnitId": "string",
      "repository": "string",
      "country": "string",
      "language": "string",
      "langMaterial": "string",
      "unitDate": "string",
      "repositoryCode": "string",
      "hasDigitalObject": false,
      "docType": "string",
      "docTypeId": "string",
      "level": "string",
      "indexDate": "string",
      "unitId": "string",
      "unitTitle": "string",
      "scopeContent": "string",
      "siblingPosition": "string",
      "treeDepth": "string"
    }
}

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.

children

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".

id	Internal APE identifier of the result
unitId	Identifier of the result provided by the repository
unitTitle	Description of the result
unitTitleWithHighlighting	Description of the result, with the mark "<em>" to emphasize the search term that was used in the search request.
unitDate	Date of creation of the result.
scopeContent	More descriptive information about the result.
scopeContentWithHighlighting	More descriptive information about the result, with the mark "<em>" to emphasize the search term that was used in the search request.
hasDigitalObject	TRUE/FALSE
langMaterial	Language in which the result is created.
language	Language of the description of the result.
docType	Type of archives describing document where the result is found : "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit".
level	Type of result: "archdesc" for highest level description or "clevel" for subordinate components
fondsUnitId	Identifier of the fonds provided by the repository.
fondsUnitTitle	Title of the finding aid.
repository	Name of the repository holding the fonds
repositoryCode	Code of the repository holding the fonds. Preferably, but not necessarily ISIL.
country	Name of the country where the repository is. In English.