hierarchyEadAncestors

From Archives Portal Europe Wiki
Revision as of 09:31, 1 November 2016 by Admin (Talk | contribs) (Created page with "Request url: <code>https://api.archivesportaleurope.net/services/hierarchy/ead/{id}/ancestors</code>. This service is a POST-request. This hierarchy service delivers a list o...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

Two request parameters can be used to do a search in archival descriptions.

eg.

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

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

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,
  "ancestors": [
    {
      "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.

ancestors

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.