searchEadChildren

From Archives Portal Europe Wiki
Revision as of 11:48, 5 June 2017 by Admin (Talk | contribs)

Jump to: navigation, search

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

This search service delivers a list of archival descriptions with the requested searchterm 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 search result.



Request parameters

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

Empty Request example:

ID = .....

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

Basic Request example:

ID = C85446159

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

On [base_url]/search/ead/C85446159/children, it gives all the clevel descriptive units of descriptive unit identified with "C85446159", in the hierarchy directly under C85446159 that contain the searchterm "KNVB".

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.

query

Containing the searchterm(s). Required.

Response parameters

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

Empty Response example:

{
  "totalResults": 0,
  "startIndex": 0,
  "totalPages": 0,
  "eadSearchResults": [
    {
      "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",
      "unitTitleWithHighlighting": "string",
      "scopeContent": "string",
      "scopeContentWithHighlighting": "string",
      "numberOfAncestors": 0
    }
  ],
  "sortFields": [
    "string"
  ]
}

Basic Response example (ie response for the basic request example above):

{
  "totalResults": 1,
  "startIndex": 0,
  "totalPages": 1,
  "eadSearchResults": [
    {
      "id": "C85446159",
      "fondsUnitTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "fondsUnitId": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1947",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.123 - 3345",
      "unitTitle": "Verslag van de vergadering van afgevaardigden van verenigingen, welke op 10 mei 1940 bij den Rotterdamschen Voetbalbond waren aangesloten, over de fusering van den Rotterdamschen Voetbalbond met de KNVB,",
      "unitTitleWithHighlighting": ", over de fusering van den Rotterdamschen Voetbalbond met de <em>KNVB</em>,",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 6
    }
  ],
  "sortFields": [
    "date",
    "findingAidNo",
    "orderId",
    "title",
    "referenceCode"
  ]
}

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.

eadSearchResults

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
fondsUnitTitle Title of the finding aid
fondsUnitId Identifier of the fonds provided by the repository
repository Name of the repository holding the fonds
country Name of the country where the repository is. In English
language Language of the description of the result
langMaterial Language in which the result is created
unitDate Date of creation of the result.
repositoryCode Code of the repository holding the fonds. Preferably, but not necessarily ISIL
hasDigitalObject TRUE/FALSE
numberOfDigitalObjects Amount of digital objects available for the search result (is always 0 in case 'hasDigitalObject' = FALSE)
numberOfDigitalOjectsInDescendents Amount of digital objects available for descendents of the search result (can be > 0 in case 'hasDigtalObject' = FALSE)
numberOfDescendents Amount of descendents of the search result
docType Type of archives describing document where the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit"
docTypeId Acronym for the type of archives document ("fa" for "Finding Aid", "hg" for "Holdings Guide", "sg" for "Source Guide" or "du" for "Descriptive unit"
level Type of result: "archdesc" for highest level description or "clevel" for subordinate components
indexDate Date showing when the result was ingested/updated and indexed in the Archives Portal Europe (ie last change date)
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
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
numberOfAncestors Amount of ancestors (higher levels) for the result

sortFields

This response parameter sums up the various fields you can use to order the resultList in a, new, additional request (see searchEad#sortRequest):

  • date
  • findingAidNo
  • orderId
  • title
  • referenceCode