Difference between revisions of "searchEad"
(→facets) |
(→date facets) |
||
| Line 457: | Line 457: | ||
{| class="wikitable" | {| class="wikitable" | ||
| fromDate | | fromDate | ||
| − | | Grouping of the search result in starting dates | + | | Grouping of the search result in starting dates |
|- | |- | ||
| toDate | | toDate | ||
| − | | Grouping of the search result in ending dates | + | | Grouping of the search result in ending dates |
|} | |} | ||
[[Category:Technical_documentation]] | [[Category:Technical_documentation]] | ||
Revision as of 08:41, 6 June 2017
Request url: https://api.archivesportaleurope.net/services/search/ead. This service is a POST-request.
This search-service delivers a list of archival descriptions with the requested search term. There is no distinction between the level of description. The user is able to filter results on various facets and order on various fields.
Request parameters
Three request parameters can be used to do a search in archival descriptions.
Empty Request example
{
"count": "5",
"startIndex": 0,
"query": "*",
"filters": [
{
"facetFieldName": "string",
"facetFieldIds": [
"string"
]
}
],
"dateFilters": [
{
"dateFieldName": "string",
"dateFieldId": "string"
}
],
"sortRequest": {
"sortType": "asc",
"fields": [
"string"
]
}
}
Basic Request example
{
"count": 5,
"startIndex": 0,
"query": "nepal",
"filters": [
{
"facetFieldName": "country",
"facetFieldIds": [
"7"
]
}
],
"dateFilters": [
{
"dateFieldName": "fromDate",
"dateFieldId": "1800-01-01_2"
}
],
"sortRequest": {
"sortType": "asc",
"fields": [
"date"
]
}
}
This example searches for archival descriptions with the term "nepal" and filters on the facet "country" with id = 7 (identifier for "NETHERLANDS") and date-facet "fromDate" with id = "1800-01-01_2" (identifier for the period 1800-1999), ordered ascending by date.
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 searchEad#facets.
dateFilters
Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in searchEad#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",
"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"
],
"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": 1,
"startIndex": 0,
"totalPages": 1,
"eadSearchResults": [
{
"id": "C85473776",
"fondsUnitTitle": "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)",
"fondsUnitId": "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",
"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": 1
}
],
"subject": [],
"repository": [
{
"id": "32171",
"name": "Nationaal Archief",
"frequency": 1
}
],
"docType": [
{
"id": "fa",
"name": "fa",
"frequency": 1
}
],
"level": [
{
"id": "clevel",
"name": "clevel",
"frequency": 1
}
],
"hasDigitalObject": [
{
"id": "false",
"name": "false",
"frequency": 1
}
],
"digitalObjectType": [],
"unitDateType": [
{
"id": "normal",
"name": "normal",
"frequency": 1
}
]
},
"facetDateFields": {
"fromDate": [
{
"id": "1980-01-01_3",
"name": "1980-1999",
"frequency": 1
}
],
"toDate": [
{
"id": "1800-01-01_2",
"name": "1800-1999",
"frequency": 1
}
]
}
}
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 (only for the search result) |
| 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 |
| 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
- 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 |
