Revision as of 14:43, 9 January 2018

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 search term 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 = C392726467

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

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

N.B.: you can find the (internal APE) identifier of a descriptive unit (always starting with a "C") which is necessary for using this service via the /search/ead service

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 search term(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",
      "findingAidTitle": "string",
      "findingAidNo": "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",
      "parentId": "string",
      "unitTitle": "string",
      "unitTitleWithHighlighting": "string",
      "scopeContent": "string",
      "scopeContentWithHighlighting": "string",
      "numberOfAncestors": 0
    }
  ],
  "sortFields": [
    "string"
  ]
}

Basic Response example

Response for the basic request example above:

{
  "totalResults": 2,
  "startIndex": 0,
  "totalPages": 1,
  "eadSearchResults": [
    {
      "id": "C372271907",
      "findingAidTitle": "Inventaris van de archieven van de Vereniging van Archivarissen in Nederland, 1891-1960",
      "findingAidNo": "2.19.021",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1949-1959",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.021 - 357",
      "parentId": "C372271857",
      "unitTitle": "Jaarverslagen en toespraken van de voorzitters.",
      "unitTitleWithHighlighting": "<em>Jaarverslagen</em> en toespraken van de voorzitters.",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 2
    },
    {
      "id": "C372271908",
      "findingAidTitle": "Inventaris van de archieven van de Vereniging van Archivarissen in Nederland, 1891-1960",
      "findingAidNo": "2.19.021",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1949/1950 - 1950/1951",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.021 - 358",
      "parentId": "C372271857",
      "unitTitle": "Jaarverslagen van de penningmeester, 1940/1941.",
      "unitTitleWithHighlighting": "<em>Jaarverslagen</em> van de penningmeester, 1940/1941.",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 2
    }
  ],
  "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".

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