Difference between revisions of "searchEadDescendants"

From Archives Portal Europe Wiki
Jump to: navigation, search
(Created page with "Request url: <code>https://api.archivesportaleurope.net/services/search/ead/{id}/descendants</code>. This service is a POST-request. This search service delivers a list of ar...")
 
(→‎Basic Response example)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Request url: <code>https://api.archivesportaleurope.net/services/search/ead/{id}/descendants</code>.
+
Request url: [https://www.archivesportaleurope.net/ApeApi/#!/search/getDescendants <code>https://api.archivesportaleurope.net/services/search/ead/{id}/descendants</code>].
 
This service is a POST-request.
 
This service is a POST-request.
  
−
This search service delivers a list of archival descriptions with the requested search term in the subtree of the archival description identified with {id}. A web developer can use this service to create a tree-like presentation of a search result.  
+
This search-service delivers a list of archival descriptions with the requested search term in the subtree of the archival description identified with {id}. A web developer can use this service to create a tree-like presentation of a search result.  
  
 
<div><br/>__TOC__<br/></div>
 
<div><br/>__TOC__<br/></div>
Line 8: Line 8:
 
Three request parameters can be used to do a search in archival descriptions.
 
Three request parameters can be used to do a search in archival descriptions.
  
−
eg.
+
== Empty 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 = .....
  
−
<pre>
 
 
{
 
{
−
   "count": 5,
+
   "count": "5",
 
   "startIndex": 0,
 
   "startIndex": 0,
−
   "query": "nepal"
+
   "query": "*",
 +
  "filters": [
 +
    {
 +
      "facetFieldName": "string",
 +
      "facetFieldIds": [
 +
        "string"
 +
      ]
 +
    }
 +
  ],
 +
  "dateFilters": [
 +
    {
 +
      "dateFieldName": "string",
 +
      "dateFieldId": "string"
 +
    }
 +
  ],
 +
  "sortRequest": {
 +
    "sortType": "asc",
 +
    "fields": [
 +
      "string"
 +
    ]
 +
  }
 
}
 
}
 
</pre>
 
</pre>
  
−
On [base_url]/search/ead/F9816/descendants, it gives all the clevel descriptive units of finding aid identified with "F9816", that contain the searchterm "nepal".
+
== 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 = F1045936
 +
 
 +
{
 +
  "count": "5",
 +
  "startIndex": 0,
 +
  "query": "nepal",
 +
  "filters": [
 +
    {
 +
      "facetFieldName": "string",
 +
      "facetFieldIds": [
 +
        "string"
 +
      ]
 +
    }
 +
  ],
 +
  "dateFilters": [
 +
    {
 +
      "dateFieldName": "string",
 +
      "dateFieldId": "string"
 +
    }
 +
  ],
 +
  "sortRequest": {
 +
    "sortType": "asc",
 +
    "fields": [
 +
      "string"
 +
    ]
 +
  }
 +
}
 +
</pre>
 +
 
 +
On [base_url]/search/ead/F1045936/descendants, it gives all the clevel descriptive units of the finding aid identified with "F1045936", that contain the search term "nepal".
 +
 
 +
''N.B.: you can find the (internal APE) identifier of a finding aid (always starting with a "F") which is necessary for using this service via the [[searchEad | /search/ead]] service''
  
 
== count ==
 
== count ==
Line 27: Line 81:
  
 
== query ==
 
== query ==
−
Containing the searchterm(s). Required.
+
Containing the search term(s). Required.
 +
 
 +
== filters ==
 +
Request parameter "filters" enables you to filter the result on facets. The facets are summarised in [[searchEadDescendants#facets]].
 +
 
 +
== dateFilters ==
 +
Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in [[searchEadDescendants#date_facets]]
 +
 
 +
== sortRequest ==
 +
Request parameters "sortRequest" enables you to sort the result. The sortRequest contains two parameters: sortType and fields.
 +
 
 +
In "fields", you can provide a list of 1 or more fields. The resultlist is ordered on field[0] first, field[1] secondly, etc.
 +
The possible fields are:
 +
 
 +
* date: date of the archival material, provided in <unitdate>
 +
* findingAidNo: number of the finding aid, provided by the repository in <eadid>
 +
* title: description of the archival material, provided in <unittitle>
 +
* referenceCode: identifier of the archival material, provided by the repository in <unitid>
 +
 
 +
In all situations you can sort ascending or descending by setting request parameter "sortType" "asc" or "desc" respectively.
 +
<br/><br/>
  
 
= Response parameters =
 
= Response parameters =
−
The response contains a list of the descriptions where the requested search-term(s) was/were found.
+
The response contains a list of the descriptions where the requested search term(s) was/were found.
  
−
eg.
+
== Empty Response example ==
−
<pre>
+
<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": 34,
+
   "totalResults": 0,
 
   "startIndex": 0,
 
   "startIndex": 0,
−
   "totalPages": 7,
+
   "totalPages": 0,
 
   "eadSearchResults": [
 
   "eadSearchResults": [
 
     {
 
     {
−
       "id": "C5026409",
+
       "id": "string",
−
       "fondsUnitTitle": "Inventaris van het code-archief van het Ministerie van Buitenlandse Zaken, 1955-1964",
+
       "findingAidTitle": "string",
−
       "fondsUnitId": "2.05.118",
+
      "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"
 +
  ],
 +
  "facetFields": {
 +
    "country": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "subject": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "repository": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "docType": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "level": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "hasDigitalObject": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "digitalObjectType": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "unitDateType": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ]
 +
  },
 +
  "facetDateFields": {
 +
    "fromDate": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ],
 +
    "toDate": [
 +
      {
 +
        "id": "string",
 +
        "name": "string",
 +
        "frequency": 0
 +
      }
 +
    ]
 +
  }
 +
}
 +
</pre>
 +
 
 +
== Basic Response example ==
 +
Response for the [[searchEadDescendants#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": 3,
 +
  "startIndex": 0,
 +
  "totalPages": 1,
 +
  "eadSearchResults": [
 +
    {
 +
      "id": "C372728566",
 +
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
 +
       "findingAidNo": "2.19.225",
 
       "repository": "Nationaal Archief",
 
       "repository": "Nationaal Archief",
 
       "country": "NETHERLANDS",
 
       "country": "NETHERLANDS",
 
       "language": "",
 
       "language": "",
 
       "langMaterial": "",
 
       "langMaterial": "",
−
       "unitDate": "1961",
+
       "unitDate": "2002",
 
       "repositoryCode": "NL-HaNA",
 
       "repositoryCode": "NL-HaNA",
 
       "hasDigitalObject": false,
 
       "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 
       "docType": "Descriptive Unit",
 
       "docType": "Descriptive Unit",
 
       "docTypeId": "du",
 
       "docTypeId": "du",
 
       "level": "clevel",
 
       "level": "clevel",
−
       "indexDate": "Mon Dec 07 10:18:59 UTC 2015",
+
       "indexDate": "",
−
       "unitId": "2.05.118 - 11917",
+
       "unitId": "2.19.225 - 5529",
−
       "unitTitle": "Nepal, 1961",
+
      "parentId": "C372728458",
−
       "unitTitleWithHighlighting": "<em>Nepal</em>, 1961",
+
       "unitTitle": "Nepal",
 +
       "unitTitleWithHighlighting": "<em>Nepal</em>",
 
       "scopeContent": "",
 
       "scopeContent": "",
−
       "scopeContentWithHighlighting": null
+
       "scopeContentWithHighlighting": null,
 +
      "numberOfAncestors": 4
 
     },
 
     },
−
  ... skip ...
+
    {
 +
      "id": "C372725896",
 +
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
 +
      "findingAidNo": "2.19.225",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "2003",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 +
      "docType": "Descriptive Unit",
 +
      "docTypeId": "du",
 +
      "level": "clevel",
 +
      "indexDate": "",
 +
      "unitId": "2.19.225 - 2798",
 +
      "parentId": "C372725884",
 +
      "unitTitle": "C. Kant Jha ten behoeve van onderzoek in Nepal",
 +
      "unitTitleWithHighlighting": "C. Kant Jha ten behoeve van onderzoek in <em>Nepal</em>",
 +
      "scopeContent": "",
 +
      "scopeContentWithHighlighting": null,
 +
      "numberOfAncestors": 7
 +
    },
 +
    {
 +
      "id": "C372725161",
 +
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
 +
      "findingAidNo": "2.19.225",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "1994",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 +
      "docType": "Descriptive Unit",
 +
      "docTypeId": "du",
 +
      "level": "clevel",
 +
      "indexDate": "",
 +
      "unitId": "2.19.225 - 2124",
 +
      "parentId": "C372725096",
 +
      "unitTitle": "Paul Janssen ten behoeve van zijn studie aan de London School of Hygiene  & Tropical Medicine in verband met zijn onderzoek naar 'The rol for NGO's in the implementation of the National Aids Programme in Nepal'",
 +
      "unitTitleWithHighlighting": " the implementation of the National Aids Programme in <em>Nepal</em>'",
 +
      "scopeContent": "",
 +
      "scopeContentWithHighlighting": null,
 +
      "numberOfAncestors": 8
 +
    }
 
   ],
 
   ],
 
   "sortFields": [
 
   "sortFields": [
Line 68: Line 313:
 
     "title",
 
     "title",
 
     "referenceCode"
 
     "referenceCode"
−
   ]
+
   ],
 +
  "facetFields": {
 +
    "country": [
 +
      {
 +
        "id": "7",
 +
        "name": "NETHERLANDS",
 +
        "frequency": 3
 +
      }
 +
    ],
 +
    "subject": [],
 +
    "repository": [
 +
      {
 +
        "id": "2437",
 +
        "name": "Nationaal Archief",
 +
        "frequency": 3
 +
      }
 +
    ],
 +
    "docType": [
 +
      {
 +
        "id": "fa",
 +
        "name": "fa",
 +
        "frequency": 3
 +
      }
 +
    ],
 +
    "level": [
 +
      {
 +
        "id": "clevel",
 +
        "name": "clevel",
 +
        "frequency": 3
 +
      }
 +
    ],
 +
    "hasDigitalObject": [
 +
      {
 +
        "id": "false",
 +
        "name": "false",
 +
        "frequency": 3
 +
      }
 +
    ],
 +
    "digitalObjectType": [],
 +
    "unitDateType": [
 +
      {
 +
        "id": "normal",
 +
        "name": "normal",
 +
        "frequency": 3
 +
      }
 +
    ]
 +
  },
 +
  "facetDateFields": {
 +
    "fromDate": [
 +
      {
 +
        "id": "1800-01-01_2",
 +
        "name": "1800-1999",
 +
        "frequency": 1
 +
      },
 +
      {
 +
        "id": "2000-01-01_2",
 +
        "name": "2000-2199",
 +
        "frequency": 2
 +
      }
 +
    ],
 +
    "toDate": [
 +
      {
 +
        "id": "1800-01-01_2",
 +
        "name": "1800-1999",
 +
        "frequency": 1
 +
      },
 +
      {
 +
        "id": "2000-01-01_2",
 +
        "name": "2000-2199",
 +
        "frequency": 2
 +
      }
 +
    ]
 +
  }
 
}
 
}
 
</pre>
 
</pre>
Line 82: Line 399:
  
 
== eadSearchResults ==
 
== 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".
+
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".
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 88: Line 405:
 
| Internal APE identifier of the result
 
| Internal APE identifier of the result
 
|-
 
|-
−
| unitId
+
| findingAidTitle
−
| Identifier of the result provided by the repository
+
| Title of the finding aid
 
|-
 
|-
−
| unitTitle
+
| findingAidNo
−
| Description of the result
+
| Identifier of the fonds provided by the repository
 
|-
 
|-
−
| unitTitleWithHighlighting
+
| repository
−
| Description of the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request.
+
| 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  
 
| unitDate  
 
| Date of creation of the result.
 
| Date of creation of the result.
 
|-
 
|-
−
| scopeContent
+
| repositoryCode
−
| More descriptive information about the result.
+
| Code of the repository holding the fonds; preferably, but not necessarily [https://en.wikipedia.org/wiki/International_Standard_Identifier_for_Libraries_and_Related_Organizations ISIL]
−
|-
+
−
| scopeContentWithHighlighting
+
−
| More descriptive information about the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request.
+
 
|-
 
|-
 
| hasDigitalObject  
 
| hasDigitalObject  
 
| TRUE/FALSE
 
| TRUE/FALSE
 
|-
 
|-
−
| langMaterial
+
| numberOfDigitalObjects
−
| Language in which the result is created.
+
| Amount of digital objects available for the search result (is always 0 in case 'hasDigitalObject' = FALSE)
 
|-
 
|-
−
| language
+
| numberOfDigitalOjectsInDescendents
−
| Language of the description of the result.
+
| 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  
 
| docType  
−
| Type of archives describing document where the result is found : "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit".
+
| 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
 
| level
 
| Type of result: "archdesc" for highest level description or "clevel" for subordinate components
 
| Type of result: "archdesc" for highest level description or "clevel" for subordinate components
 
|-
 
|-
−
| fondsUnitId
+
| indexDate
−
| Identifier of the fonds provided by the repository.
+
| Date showing when the result was ingested/updated and indexed in the Archives Portal Europe (ie last change date)
 
|-
 
|-
−
| fondsUnitTitle
+
| unitId
−
| Title of the finding aid.
+
| Identifier of the result provided by the repository
 
|-
 
|-
−
| repository
+
| parentId
−
| Name of the repository holding the fonds
+
| Internal APE Identifier of the parent of the result
 
|-
 
|-
−
| repositoryCode
+
| unitTitle
−
| Code of the repository holding the fonds. Preferably, but not necessarily [https://en.wikipedia.org/wiki/International_Standard_Identifier_for_Libraries_and_Related_Organizations ISIL].
+
| Description of the result
 
|-
 
|-
−
| country
+
| unitTitleWithHighlighting
−
| Name of the country where the repository is. In English.
+
| Description of the result, with the mark "<nowiki><em></nowiki>" 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 "<nowiki><em></nowiki>" to emphasise the search term that was used in the search request
 +
|-
 +
| numberOfAncestors
 +
| Amount of ancestors (higher levels) for the result
 
|}
 
|}
  
 
== sortFields ==
 
== 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: [[searchEadDescendants#sortRequest]]):
  
 
* date
 
* date
Line 146: Line 484:
 
* referenceCode
 
* referenceCode
  
 +
== facetFields ==
 +
This response parameter gives an enumeration of facets. Every facet has three variables.
 +
 +
{| class="wikitable"
 +
| id
 +
| Internal APE identifier of the value; use this "id" in the filter request parameter
 +
|-
 +
| name
 +
| Human readable value (in English)
 +
|-
 +
| frequency
 +
| The number of results of this facet containing the search term
 +
|}
 +
 +
=== facets ===
 +
 +
{| class="wikitable"
 +
| country
 +
| Name of the country where the repository is, in English
 +
|-
 +
| subject
 +
| Subject that is added to the archival description
 +
|-
 +
| repository
 +
| Name of the repository holding the fonds
 +
|-
 +
| docType
 +
| Type of document in which 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
 +
|-
 +
| hasDigitalObject
 +
| TRUE/FALSE
 +
|-
 +
| digitalObjectType
 +
| Type of the Object: most of the time: IMAGE
 +
|-
 +
| unitDateType
 +
| Type of date describing the archival unit
 +
|}
 +
 +
=== date facets ===
 +
With the date facets you can zoom in on the period of time. Results are grouped in periods of two centuries in the first step. If you use these groupings in the request-parameter dateFilter, you'll have new dateFacets that groups the results into groups of two decades
 +
 +
{| class="wikitable"
 +
| fromDate
 +
| Grouping of the search result in starting dates
 +
|-
 +
| toDate
 +
| Grouping of the search result in ending dates
 +
|}
 
[[Category:Technical_documentation]]
 
[[Category:Technical_documentation]]

Latest revision as of 14:20, 9 January 2018

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

This search-service delivers a list of archival descriptions with the requested search term in the subtree 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": "*",
  "filters": [
    {
      "facetFieldName": "string",
      "facetFieldIds": [
        "string"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "string",
      "dateFieldId": "string"
    }
  ],
  "sortRequest": {
    "sortType": "asc",
    "fields": [
      "string"
    ]
  }
}

Basic Request example

ID = F1045936

{
  "count": "5",
  "startIndex": 0,
  "query": "nepal",
  "filters": [
    {
      "facetFieldName": "string",
      "facetFieldIds": [
        "string"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "string",
      "dateFieldId": "string"
    }
  ],
  "sortRequest": {
    "sortType": "asc",
    "fields": [
      "string"
    ]
  }
}

On [base_url]/search/ead/F1045936/descendants, it gives all the clevel descriptive units of the finding aid identified with "F1045936", that contain the search term "nepal".

N.B.: you can find the (internal APE) identifier of a finding aid (always starting with a "F") 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.

filters

Request parameter "filters" enables you to filter the result on facets. The facets are summarised in searchEadDescendants#facets.

dateFilters

Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in searchEadDescendants#date_facets

sortRequest

Request parameters "sortRequest" enables you to sort the result. The sortRequest contains two parameters: sortType and fields.

In "fields", you can provide a list of 1 or more fields. The resultlist is ordered on field[0] first, field[1] secondly, etc. The possible fields are:

  • date: date of the archival material, provided in <unitdate>
  • findingAidNo: number of the finding aid, provided by the repository in <eadid>
  • title: description of the archival material, provided in <unittitle>
  • referenceCode: identifier of the archival material, provided by the repository in <unitid>

In all situations you can sort ascending or descending by setting request parameter "sortType" "asc" or "desc" respectively.

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"
  ],
  "facetFields": {
    "country": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "subject": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "repository": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "docType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "level": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "hasDigitalObject": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "digitalObjectType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "unitDateType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "toDate": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ]
  }
}

Basic Response example

Response for the basic request example above: 

{
  "totalResults": 3,
  "startIndex": 0,
  "totalPages": 1,
  "eadSearchResults": [
    {
      "id": "C372728566",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "2002",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.225 - 5529",
      "parentId": "C372728458",
      "unitTitle": "Nepal",
      "unitTitleWithHighlighting": "<em>Nepal</em>",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 4
    },
    {
      "id": "C372725896",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "2003",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.225 - 2798",
      "parentId": "C372725884",
      "unitTitle": "C. Kant Jha ten behoeve van onderzoek in Nepal",
      "unitTitleWithHighlighting": "C. Kant Jha ten behoeve van onderzoek in <em>Nepal</em>",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 7
    },
    {
      "id": "C372725161",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1994",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.225 - 2124",
      "parentId": "C372725096",
      "unitTitle": "Paul Janssen ten behoeve van zijn studie aan de London School of Hygiene  & Tropical Medicine in verband met zijn onderzoek naar 'The rol for NGO's in the implementation of the National Aids Programme in Nepal'",
      "unitTitleWithHighlighting": " the implementation of the National Aids Programme in <em>Nepal</em>'",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 8
    }
  ],
  "sortFields": [
    "date",
    "findingAidNo",
    "orderId",
    "title",
    "referenceCode"
  ],
  "facetFields": {
    "country": [
      {
        "id": "7",
        "name": "NETHERLANDS",
        "frequency": 3
      }
    ],
    "subject": [],
    "repository": [
      {
        "id": "2437",
        "name": "Nationaal Archief",
        "frequency": 3
      }
    ],
    "docType": [
      {
        "id": "fa",
        "name": "fa",
        "frequency": 3
      }
    ],
    "level": [
      {
        "id": "clevel",
        "name": "clevel",
        "frequency": 3
      }
    ],
    "hasDigitalObject": [
      {
        "id": "false",
        "name": "false",
        "frequency": 3
      }
    ],
    "digitalObjectType": [],
    "unitDateType": [
      {
        "id": "normal",
        "name": "normal",
        "frequency": 3
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "1800-01-01_2",
        "name": "1800-1999",
        "frequency": 1
      },
      {
        "id": "2000-01-01_2",
        "name": "2000-2199",
        "frequency": 2
      }
    ],
    "toDate": [
      {
        "id": "1800-01-01_2",
        "name": "1800-1999",
        "frequency": 1
      },
      {
        "id": "2000-01-01_2",
        "name": "2000-2199",
        "frequency": 2
      }
    ]
  }
}

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 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
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: searchEadDescendants#sortRequest):

  • date
  • findingAidNo
  • orderId
  • title
  • referenceCode

facetFields

This response parameter gives an enumeration of facets. Every facet has three variables.

id Internal APE identifier of the value; use this "id" in the filter request parameter
name Human readable value (in English)
frequency The number of results of this facet containing the search term

facets

country Name of the country where the repository is, in English
subject Subject that is added to the archival description
repository Name of the repository holding the fonds
docType Type of document in which 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
hasDigitalObject TRUE/FALSE
digitalObjectType Type of the Object: most of the time: IMAGE
unitDateType Type of date describing the archival unit

date facets

With the date facets you can zoom in on the period of time. Results are grouped in periods of two centuries in the first step. If you use these groupings in the request-parameter dateFilter, you'll have new dateFacets that groups the results into groups of two decades

fromDate Grouping of the search result in starting dates
toDate Grouping of the search result in ending dates
Retrieved from "https://wiki-deprecated.archivesportaleurope.net/index.php?title=searchEadDescendants&oldid=1781"