Difference between revisions of "searchEadDoclist"

From Archives Portal Europe Wiki
Jump to: navigation, search
Line 2: Line 2:
 
This service is a POST-request.
 
This service is a POST-request.
  
−
This search service delivers a list of Finding Aids, Holding Guides or Source Guides that contain archival descriptions with the requested searchterm. The docList-service can be viewed as the resultlist of the search-service, where the results are grouped by fa, hg or sg. A web developer is able to filter results on various facets.
+
This search-service delivers a list of finding aids (fa), holding guides (hg) or source guides (sg) that contain archival descriptions with the requested search term. The docList-service can be viewed as the resultlist of the search-service, where the results are grouped by fa, hg or sg. A web developer is able to filter results on various facets.
  
 
<div><br/>__TOC__<br/></div>
 
<div><br/>__TOC__<br/></div>
Line 8: Line 8:
 
Several request parameters can be used to do a search in archival descriptions.
 
Several request parameters can be used to do a search in archival descriptions.
  
−
Empty Request example:
+
== Empty Request 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;">
 
{
 
{
 
   "count": "5",
 
   "count": "5",
Line 32: Line 32:
 
</pre>
 
</pre>
  
−
Basic Request example:
+
== Basic Request 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;">
 
{
 
{
 
   "count": "5",
 
   "count": "5",
Line 65: Line 65:
  
 
== query ==
 
== query ==
−
Containing the searchterm(s). Required.
+
Containing the search term(s). Required.
  
 
== docType ==
 
== docType ==
Line 71: Line 71:
  
 
== filters ==
 
== filters ==
−
Request parameter "filters" enables you to filter the result on facets. The facets are summarized in [[searchEadDoclist#facets]].
+
Request parameter "filters" enables you to filter the result on facets. The facets are summarised in [[searchEadDoclist#facets]].
  
 
== dateFilters ==
 
== dateFilters ==
−
Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarized in [[searchEadDoclist#date_facets]]
+
Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in [[searchEadDoclist#date_facets]]
 
<br/><br/>
 
<br/><br/>
  
 
= Response parameters =
 
= Response parameters =
−
The response contains a list of the finding aids where the requested search-term(s) was/were found.
+
The response contains a list of the finding aids where the requested search term(s) was/were found.
  
−
Empty Response example:
+
== 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": 0,
 
   "totalResults": 0,
Line 181: Line 181:
 
</pre>
 
</pre>
  
−
Basic Response example (ie response for the basic request example above):
+
== Basic Response example ==
−
<pre>
+
Response for the 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": 1,
Line 293: Line 294:
 
|-
 
|-
 
| numberOfResults
 
| numberOfResults
−
| Number of clevels of this finding aid, holdingsguide or sourceguide containing the searchterm.
+
| Number of clevels of this finding aid, holdings guide or source guide containing the search term
 
|-
 
|-
 
| repository  
 
| repository  
Line 299: Line 300:
 
|-
 
|-
 
| country  
 
| country  
−
| Name of the country where the repository is. In English.
+
| Name of the country where the repository is, in English
 
|-
 
|-
 
| language  
 
| language  
−
| Language of the description of the result.
+
| Language of the description of the result
 
|-
 
|-
 
| repositoryCode  
 
| repositoryCode  
−
| 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].
+
| 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]
 
|-
 
|-
 
| fondsUnitId
 
| fondsUnitId
Line 331: Line 332:
 
{| class="wikitable"
 
{| class="wikitable"
 
| id  
 
| id  
−
| Internal APE identifier of the value. Use this "id" in the filter request parameter.
+
| Internal APE identifier of the value; use this "id" in the filter request parameter
 
|-
 
|-
 
| name
 
| name
−
| Human readable value (in English).
+
| Human readable value (in English)
 
|-
 
|-
 
| frequency
 
| frequency
−
| The number of results of this facet containing the searchterm.
+
| The number of results of this facet containing the search term
 
|}
 
|}
  
Line 344: Line 345:
 
{| class="wikitable"
 
{| class="wikitable"
 
| country  
 
| country  
−
| Name of the country where the repository is. In English.
+
| Name of the country where the repository is, in English
 
|-
 
|-
 
| subject
 
| subject
Line 353: Line 354:
 
|-
 
|-
 
| docType  
 
| docType  
−
| Type of archives describing document where the result is found : "fa" for Finding Aid, "hg" for Holdings Guide or "sg" for Source Guide.
+
| Type of archives describing document where the result is found: "fa" for Finding Aid, "hg" for Holdings Guide or "sg" for Source Guide
 
|-
 
|-
 
| level
 
| level
Line 365: Line 366:
 
|-
 
|-
 
| unitDateType
 
| unitDateType
−
| Type of date describing the archival unit.
+
| Type of date describing the archival unit
 
|}
 
|}
  
 
=== date facets ===
 
=== 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
+
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"
 
{| 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 09:12, 6 June 2017

Request url: https://api.archivesportaleurope.net/services/search/ead/docList. This service is a POST-request.

This search-service delivers a list of finding aids (fa), holding guides (hg) or source guides (sg) that contain archival descriptions with the requested search term. The docList-service can be viewed as the resultlist of the search-service, where the results are grouped by fa, hg or sg. A web developer is able to filter results on various facets.



Request parameters

Several request parameters can be used to do a search in archival descriptions.

Empty Request example

{
  "count": "5",
  "startIndex": 0,
  "query": "*",
  "docType": "string",
  "filters": [
    {
      "facetFieldName": "string",
      "facetFieldIds": [
        "string"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "string",
      "dateFieldId": "string"
    }
  ]
}

Basic Request example

{
  "count": "5",
  "startIndex": 0,
  "query": "nepal",
  "docType": "fa",
  "filters": [
    {
      "facetFieldName": "country",
      "facetFieldIds": [
        "7"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "fromDate",
      "dateFieldId": "1800-01-01_2"
    }
  ]
}

This example searches for finding aids ("fa") 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).

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.

docType

Defining on which type of EAD document the search should be performed: finding aids ("fa"), holdings guide ("hg") or source guide ("sg").

filters

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

dateFilters

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

Response parameters

The response contains a list of the finding aids where the requested search term(s) was/were found.

Empty Response example

{
  "totalResults": 0,
  "startIndex": 0,
  "totalPages": 0,
  "totalDocs": 0,
  "eadDocList": [
    {
      "id": "string",
      "fondsUnitTitle": "string",
      "numberOfResults": 0,
      "repository": "string",
      "country": "string",
      "language": "string",
      "repositoryCode": "string",
      "fondsUnitId": "string",
      "unitDate": "string",
      "scopeContent": "string",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0
    }
  ],
  "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,
  "totalDocs": 1,
  "eadDocList": [
    {
      "id": "F379215",
      "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)",
      "numberOfResults": 1,
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "repositoryCode": "NL-HaNA",
      "fondsUnitId": "2.19.225",
      "unitDate": "1994",
      "scopeContent": "",
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0
    }
  ],
  "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 in Descriptive Units. The totalDocs gives the number of findings aids, holding guides or source guides in which the search term was found.

startIndex

The response parameter "startIndex" gives the number of the chunk you requested.

totalPages

The response parameter "totalPages" gives the number of chunks.

totalDocs

The response parameter totalDocs gives the number of findings aids, holding guides or source guides in which the search term was found.

eadDocList

Enumeration of the results. All response parameters are optional, except for "id".

id Internal APE identifier of the result
fondsUnitTitle Title of the finding aid.
numberOfResults Number of clevels of this finding aid, holdings guide or source guide containing the search term
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
repositoryCode Code of the repository holding the fonds; preferably, but not necessarily ISIL
fondsUnitId Identifier of the fonds provided by the repository
unitDate Date of creation of the result
scopeContent More descriptive information about the 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

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 archives describing document where the result is found: "fa" for Finding Aid, "hg" for Holdings Guide or "sg" for Source Guide
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=searchEadDoclist&oldid=1644"