searchEadChildren

From Archives Portal Europe Wiki
Revision as of 15:38, 30 August 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 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": 7,
  "startIndex": 0,
  "totalPages": 2,
  "eadSearchResults": [
    {
      "id": "C392726508",
      "findingAidTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "findingAidNo": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "[1946]",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.123 - 4002",
      "parentId": "",
      "unitTitle": "Voorgestelde wijzigingen en toevoegingen in artikelen van de Statuten en Huishoudelijk Reglement, het Reglement Competitie-wedstridjen van den K.N.V.B., de Amateursbepalingen, het Reglement voor de Districtsbesturen, het Reglement voor de Afdeelingen, het Reglement Competitie-wedstrijden voor de Afdeelingen, het Reglement op Seriewedstrijden en het Reglement voor het Jeugdvoetbal in den K.N.V.B.,",
      "unitTitleWithHighlighting": " en Huishoudelijk <em>Reglement</em>, het <em>Reglement</em> Competitie-wedstridjen van den K.N.V.B",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 5
    },
    {
      "id": "C392726468",
      "findingAidTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "findingAidNo": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1891-1975",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 484,
      "numberOfDescendents": 35,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.123 - 319-353",
      "parentId": "",
      "unitTitle": "Statuten en Huishoudelijke reglement van de (Koninklijke) Nederlandsche Voetbalbond,",
      "unitTitleWithHighlighting": "Statuten en Huishoudelijke <em>reglement</em> van de (Koninklijke",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 5
    },
    {
      "id": "C392726516",
      "findingAidTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "findingAidNo": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "z.d.",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.123 - 4010",
      "parentId": "",
      "unitTitle": "Reglement van orde voor de Bondsvergadering van de K.N.V.B.,",
      "unitTitleWithHighlighting": "<em>Reglement</em> van orde voor de Bondsvergadering van de K.N.V.B.,",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 5
    },
    {
      "id": "C392726509",
      "findingAidTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "findingAidNo": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1948",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.123 - 4003",
      "parentId": "",
      "unitTitle": "Advies van de Reglements-commissie inzake wijziging van de artikelen van het Huishoudelijk Reglement met 2/3 of gewone meerderheid, en voorstel tot wijziging van artikelen van de Statuten van de K.N.V.B., het Reglement Competitie-wedstrijden K.N.V.B., het Reglement voor de Afdeelingen, het Reglement Competitie-wedstrijden voor de Afdeelingen en het Reglement voor de districtsbesturen,",
      "unitTitleWithHighlighting": " van het Huishoudelijk <em>Reglement</em> met 2/3 of gewone meerderheid, en",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 5
    },
    {
      "id": "C392726510",
      "findingAidTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "findingAidNo": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1948",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.123 - 4004",
      "parentId": "",
      "unitTitle": "Rapport van de commissie tot herziening van de stemmenverhoudingen in de Districtsvergaderingen, zoals bepaald in artikel 27 van het Huishoudelijk Reglement,",
      "unitTitleWithHighlighting": " de Districtsvergaderingen, zoals bepaald in artikel 27 van het Huishoudelijk <em>Reglement</em>,",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 5
    }
  ],
  "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