searchEadDoclist - Revision history

Admin: /* Basic Response example */

2018-01-09T14:14:28Z

‎Basic Response example

Show changes

Admin: /* Empty Request example */

2018-01-09T14:14:02Z

‎Empty Request example

Admin at 20:35, 30 August 2017

2017-08-30T20:35:45Z

Admin at 14:37, 30 August 2017

2017-08-30T14:37:02Z

Show changes

Admin: /* Basic Response example */

2017-06-06T09:12:44Z

‎Basic Response example

Admin at 09:12, 6 June 2017

2017-06-06T09:12:11Z

Admin at 11:00, 5 June 2017

2017-06-05T11:00:21Z

Show changes

Admin at 11:52, 8 March 2017

2017-03-08T11:52:55Z

Admin: Created page with "Request url: `https://api.archivesportaleurope.net/services/search/ead/docList`. This service is a POST-request. This search service delivers a list of Finding Aid..."

2016-11-01T08:24:15Z

Created page with "Request url: <code>https://api.archivesportaleurope.net/services/search/ead/docList</code>. This service is a POST-request. This search service delivers a list of Finding Aid..."

New page

Request url: <code>https://api.archivesportaleurope.net/services/search/ead/docList</code>.
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.

<div><br/>__TOC__<br/></div>
= Request parameters =
Several request parameters can be used to do a search in archival descriptions.

eg.

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

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 searchterm(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 summarized in [[searchEadDoclist#facets]].

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

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

eg.
<pre>
{
"totalResults": 151,
"startIndex": 0,
"totalPages": 6,
"totalDocs": 27,
"eadDocList": [
{
"id": "F9816",
"fondsUnitTitle": "Inventaris van het code-archief van het Ministerie van Buitenlandse Zaken, 1955-1964",
"numberOfResults": 35,
"repository": "Nationaal Archief",
"country": "NETHERLANDS",
"language": "",
"repositoryCode": "NL-HaNA"
},
... skip ...
],
"facetFields": {
"country": [
{
"id": "7",
"name": "NETHERLANDS",
"frequency": 151
}
],
"subject": [],
... skip ...
}
}
</pre>

== 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".

{| class="wikitable"
| id
| Internal APE identifier of the result
|-
| fondsUnitTitle
| Title of the finding aid.
|-
| numberOfResults
| Number of clevels of this finding aid, holdingsguide or sourceguide containing the searchterm.
|-
| language
| Language of the description of the result.
|-
| repository
| Name of the repository holding the fonds
|-
| 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].
|-
| country
| Name of the country where the repository is. In English.
|}

== 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 searchterm.
|}

=== 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 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

{| class="wikitable"
| fromDate
| Grouping of the search result in starting dates.
|-
| toDate
| Grouping of the search result in ending dates.
|}

[[Category:Technical_documentation]]

← Older revision		Revision as of 20:35, 30 August 2017
Line 1:		Line 1:
−	Request url: [https://www.archivesportaleurope.net/ApeApi/#!/search/~~context~~ <code>https://api.archivesportaleurope.net/services/search/ead/docList</code>].	+	Request url: [https://www.archivesportaleurope.net/ApeApi/#!/search/searchEadDocs <code>https://api.archivesportaleurope.net/services/search/ead/docList</code>].
	This service is a POST-request.		This service is a POST-request.

@@ Line 182: / Line 182: @@
 == Basic Response example ==
-Response for the basic request example above:
+Response for the [[searchEadDoclist#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;">
+{

← Older revision		Revision as of 11:52, 8 March 2017
Line 1:		Line 1:
−	Request url: <code>https://api.archivesportaleurope.net/services/search/ead/docList</code>.	+	Request url: [https://www.archivesportaleurope.net/ApeApi/#!/search/context <code>https://api.archivesportaleurope.net/services/search/ead/docList</code>].
	This service is a POST-request.		This service is a POST-request.

@@ Line 14: / Line 14: @@
    "startIndex": 0,
    "query": "*",
-   "docType": "string",
+   "docType": "fa",
    "filters": [
+     {

@@ Line 2: / Line 2: @@
 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>
@@ Line 8: / Line 8: @@
 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",
@@ Line 32: / Line 32: @@
 </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",
@@ Line 65: / Line 65: @@
 == query ==
-Containing the searchterm(s). Required.
+Containing the search term(s). Required.
 == docType ==
@@ Line 71: / Line 71: @@
 == 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 ==
-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/>
 = 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,
@@ Line 181: / Line 181: @@
 </pre>
-Basic Response example (ie response for the basic request example above):
+== Basic Response example ==
-<pre>
+Response for the basic request example above:
+{
    "totalResults": 1,
@@ Line 293: / Line 294: @@
 |-
 | 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
@@ Line 299: / Line 300: @@
 |-
 | country
-| Name of the country where the repository is. In English.
+| Name of the country where the repository is, in English
 |-
 | language
-| Language of the description of the result.
+| Language of the description of the result
 |-
 | 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
@@ Line 331: / Line 332: @@
 {| class="wikitable"
 | 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
-| Human readable value (in English).
+| Human readable value (in English)
 |-
 | 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"
 | country
-| Name of the country where the repository is. In English.
+| Name of the country where the repository is, in English
 |-
 | subject
@@ Line 353: / Line 354: @@
 |-
 | 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
@@ Line 365: / Line 366: @@
 |-
 | unitDateType
-| Type of date describing the archival unit.
+| 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
+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.
+| Grouping of the search result in starting dates
 |-
 | toDate
-| Grouping of the search result in ending dates.
+| Grouping of the search result in ending dates
 |}
 [[Category:Technical_documentation]]

searchEadDoclist - Revision history

Admin: /* Basic Response example */

Admin: /* Empty Request example */

Admin at 20:35, 30 August 2017

Admin at 14:37, 30 August 2017

Admin: /* Basic Response example */

Admin at 09:12, 6 June 2017

Admin at 11:00, 5 June 2017

Admin at 11:52, 8 March 2017

Admin: Created page with "Request url: https://api.archivesportaleurope.net/services/search/ead/docList. This service is a POST-request. This search service delivers a list of Finding Aid..."

Admin: Created page with "Request url: `https://api.archivesportaleurope.net/services/search/ead/docList`. This service is a POST-request. This search service delivers a list of Finding Aid..."