Difference between revisions of "searchEadFindingAidNo"
(Created page with "Request url: [https://www.archivesportaleurope.net/ApeApi/#!/search/searchEadFindingAidNo <code>https://www.archivesportaleurope.net/ApeApi/#!/search/searchEadFindingAidNo</co...") |
(No difference)
|
Revision as of 16:07, 30 August 2017
Request url: https://www.archivesportaleurope.net/ApeApi/#!/search/searchEadFindingAidNo. This service is a POST-request.
This search-service delivers information on a specific finding aid for the requested finding aid number. The service also offers the possibility to request information on a combination of a specific finding aid number and a specific descriptive unit number of that particular finding aid.
Request parameters
Several request parameters can be used to do a search for a finding aid and a finding aid plus descriptive unit.
Empty Request example
{
"count": "5",
"startIndex": 0,
"findingAidNo": "string",
"unitId": "string",
"filters": [
{
"facetFieldName": "string",
"facetFieldIds": [
"string"
]
}
],
"dateFilters": [
{
"dateFieldName": "string",
"dateFieldId": "string"
}
],
"sortRequest": {
"sortType": "asc",
"fields": [
"string"
]
}
}
Basic Request example 1
{
"count": "5",
"startIndex": 0,
"findingAidNo": "2.13.80",
"unitId": "",
"filters": [
{
"facetFieldName": "repository",
"facetFieldIds": [
"2437"
]
}
],
"dateFilters": [
{
"dateFieldName": "string",
"dateFieldId": "string"
}
],
"sortRequest": {
"sortType": "asc",
"fields": [
"string"
]
}
}
This example searches for finding aid number "2.13.80" from the archival institution "Nationaal Archief" (= repository id: "2437"), without a request for a specific descriptive unit number of this finding aid, hence the empty "unitId".
Basic Request example 2
{
"count": "5",
"startIndex": 0,
"findingAidNo": "2.13.80",
"unitId": "5",
"filters": [
{
"facetFieldName": "repository",
"facetFieldIds": [
"2437"
]
}
],
"dateFilters": [
{
"dateFieldName": "string",
"dateFieldId": "string"
}
],
"sortRequest": {
"sortType": "asc",
"fields": [
"string"
]
}
}
This example searches for finding aid number "2.13.80" from the archival institution "Nationaal Archief" (= repository id: "2437") and within that finding aid for the specific descriptive unit number "5", hence the "unitId": "5".
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.
findingAidNo
Identifier of the fonds provided by the repository.
unitId
Original identifier of the information provided by the repository.
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",
"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 1
Response for the basic request example 1 above:
{
"totalResults": 1,
"startIndex": 0,
"totalPages": 1,
"eadSearchResults": [
{
"id": "F1116396",
"findingAidTitle": "Inventaris van het archief van de Commissie voor het model van de veldjas, 1937-1940",
"findingAidNo": "2.13.80",
"repository": "Nationaal Archief",
"country": "NETHERLANDS",
"language": "",
"langMaterial": "",
"unitDate": "1937-1940",
"repositoryCode": "NL-HaNA",
"hasDigitalObject": false,
"numberOfDigitalObjects": 0,
"numberOfDigitalObjectsInDescendents": 0,
"numberOfDescendents": 7,
"docType": "Finding Aid",
"docTypeId": "fa",
"level": "archdesc",
"indexDate": "",
"unitId": "2.13.80",
"parentId": "",
"unitTitle": "Ministerie van Defensie: Commissie voor het Model van de Veldjas",
"unitTitleWithHighlighting": null,
"scopeContent": "Het archief van de commissie voor het model van de veldjas bevat stukken betreffen het onderzoek en ontwikkeling van een nieuwe veldjas voor de Nederlandse strijdkrachten.",
"scopeContentWithHighlighting": null,
"numberOfAncestors": 0
}
],
"sortFields": [
"date",
"findingAidNo",
"orderId",
"title",
"referenceCode"
],
"facetFields": {
"country": [
{
"id": "7",
"name": "NETHERLANDS",
"frequency": 1
}
],
"subject": [],
"repository": [
{
"id": "2437",
"name": "Nationaal Archief",
"frequency": 1
}
],
"docType": [
{
"id": "fa",
"name": "fa",
"frequency": 1
}
],
"level": [
{
"id": "archdesc",
"name": "archdesc",
"frequency": 1
}
],
"hasDigitalObject": [
{
"id": "false",
"name": "false",
"frequency": 1
}
],
"digitalObjectType": [],
"unitDateType": [
{
"id": "normal",
"name": "normal",
"frequency": 1
}
]
},
"facetDateFields": {
"fromDate": [
{
"id": "1800-01-01_2",
"name": "1800-1999",
"frequency": 1
}
],
"toDate": [
{
"id": "1800-01-01_2",
"name": "1800-1999",
"frequency": 1
}
]
}
}
Basic Response example 2
Response for the basic request example 2 above:
{
"totalResults": 1,
"startIndex": 0,
"totalPages": 1,
"eadSearchResults": [
{
"id": "C403389981",
"findingAidTitle": "Inventaris van het archief van de Commissie voor het model van de veldjas, 1937-1940",
"findingAidNo": "2.13.80",
"repository": "Nationaal Archief",
"country": "NETHERLANDS",
"language": "",
"langMaterial": "",
"unitDate": "1937-1938",
"repositoryCode": "NL-HaNA",
"hasDigitalObject": false,
"numberOfDigitalObjects": 0,
"numberOfDigitalObjectsInDescendents": 0,
"numberOfDescendents": 0,
"docType": "Descriptive Unit",
"docTypeId": "du",
"level": "clevel",
"indexDate": "",
"unitId": "2.13.80 - 5",
"parentId": "",
"unitTitle": "Stukken betreffende de mening van militaire attachés over de veldjassen zoals deze door het Duitse, Engelse, Franse en Belgische leger gedragen worden.",
"unitTitleWithHighlighting": null,
"scopeContent": "",
"scopeContentWithHighlighting": null,
"numberOfAncestors": 1
}
],
"sortFields": [
"date",
"findingAidNo",
"orderId",
"title",
"referenceCode"
],
"facetFields": {
"country": [
{
"id": "7",
"name": "NETHERLANDS",
"frequency": 1
}
],
"subject": [],
"repository": [
{
"id": "2437",
"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": "1800-01-01_2",
"name": "1800-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 |
| 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 (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 |
| 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
- 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 |
