Latest revision as of 14:44, 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 = C372271857

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

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

id	Internal APE identifier of the result
findingAidTitle	Title of the finding aid
findingAidNo	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 document in which the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit"
docTypeId	Acronym for the type of 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
parentId	Internal APE Identifier of the parent of the result
unitTitle	Description of the result
unitTitleWithHighlighting	Description of the result, with the mark "<em>" to emphasise 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 emphasise 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

Difference between revisions of "searchEadChildren"

Latest revision as of 14:44, 9 January 2018

Contents

Request parameters

Empty Request example

Basic Request example

count

startIndex

query

Response parameters

Empty Response example

Basic Response example

totalResults

startIndex

totalPages

eadSearchResults

sortFields

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 13: / Line 13: @@
 {
-   "count": 5,
+   "count": "5",
    "startIndex": 0,
    "query": "*"
@@ Line 21: / Line 21: @@
 == Basic Request example ==
 <pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;">
-ID = C85446159
+ID = C372271857
 {
    "count": "5",
    "startIndex": 0,
-   "query": "KNVB"
+   "query": "Jaarverslagen"
 }
 </pre>
-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 search term "KNVB".
+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 [[searchEad | /search/ead]] service''
 == count ==
@@ Line 53: / Line 55: @@
      {
        "id": "string",
-       "fondsUnitTitle": "string",
+       "findingAidTitle": "string",
-       "fondsUnitId": "string",
+       "findingAidNo": "string",
        "repository": "string",
        "country": "string",
@@ Line 70: / Line 72: @@
        "indexDate": "string",
        "unitId": "string",
+      "parentId": "string",
        "unitTitle": "string",
        "unitTitleWithHighlighting": "string",
@@ Line 84: / Line 87: @@
 == Basic Response example ==
-Response for the basic request example above:
+Response for the [[searchEadChildren#Basic_Request_example|basic request example above]]:
 <pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;">
 {
-   "totalResults": 1,
+   "totalResults": 2,
    "startIndex": 0,
    "totalPages": 1,
    "eadSearchResults": [
      {
-       "id": "C85446159",
+       "id": "C372271907",
-       "fondsUnitTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
+       "findingAidTitle": "Inventaris van de archieven van de Vereniging van Archivarissen in Nederland, 1891-1960",
-       "fondsUnitId": "2.19.123",
+       "findingAidNo": "2.19.021",
        "repository": "Nationaal Archief",
        "country": "NETHERLANDS",
        "language": "",
        "langMaterial": "",
-       "unitDate": "1947",
+       "unitDate": "1949-1959",
        "repositoryCode": "NL-HaNA",
        "hasDigitalObject": false,
@@ Line 109: / Line 112: @@
        "level": "clevel",
        "indexDate": "",
-       "unitId": "2.19.123 - 3345",
+       "unitId": "2.19.021 - 357",
-       "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,",
+      "parentId": "C372271857",
-       "unitTitleWithHighlighting": ", over de fusering van den Rotterdamschen Voetbalbond met de <em>KNVB</em>,",
+       "unitTitle": "Jaarverslagen en toespraken van de voorzitters.",
+       "unitTitleWithHighlighting": "<em>Jaarverslagen</em> en toespraken van de voorzitters.",
        "scopeContent": "",
        "scopeContentWithHighlighting": null,
-       "numberOfAncestors": 6
+       "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
      }
    ],
@@ Line 143: / Line 173: @@
 | Internal APE identifier of the result
 |-
-| fondsUnitTitle
+| findingAidTitle
 | Title of the finding aid
 |-
-| fondsUnitId
+| findingAidNo
 | Identifier of the fonds provided by the repository
 |-
@@ Line 193: / Line 223: @@
 | unitId
 | Identifier of the result provided by the repository
+|-
+| parentId
+| Internal APE Identifier of the parent of the result
 |-
 | unitTitle
@@ Line 211: / Line 244: @@
 == sortFields ==
-This response parameter sums up the various fields you can use to order the resultList in a, new, additional request (see [[searchEad#sortRequest]]):
+This response parameter sums up the various fields you can use to order the resultList in a, new, additional request (see: [[searchEad#sortRequest]]):
 * date