searchEadChildren - Revision history

Admin: /* Basic Request example */

2018-01-09T14:44:39Z

‎Basic Request example

Admin: /* Basic Response example */

2018-01-09T14:43:40Z

‎Basic Response example

Show changes

Admin at 14:38, 30 August 2017

2017-08-30T14:38:46Z

Show changes

Admin: /* sortFields */

2017-06-06T13:15:57Z

‎sortFields

Admin: /* Basic Response example */

2017-06-06T09:48:19Z

‎Basic Response example

Admin at 09:47, 6 June 2017

2017-06-06T09:47:40Z

Admin at 11:48, 5 June 2017

2017-06-05T11:48:17Z

Show changes

Admin at 12:13, 8 March 2017

2017-03-08T12:13:50Z

Admin: Created page with "Request url: `https://api.archivesportaleurope.net/services/search/ead/{id}/children`. This service is a POST-request. This search service delivers a list of archi..."

2016-11-01T08:26:56Z

Created page with "Request url: <code>https://api.archivesportaleurope.net/services/search/ead/{id}/children</code>. This service is a POST-request. This search service delivers a list of archi..."

New page

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

This search service delivers a list of archival descriptions with the requested searchterm one level deeper in the hierarchy 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>
= Request parameters =
Three request parameters can be used to do a search in archival descriptions.

eg.

<pre>
{
"count": 5,
"startIndex": 0,
"query": "nepal"
}
</pre>

On [base_url]/search/ead/F9816/children, it gives all the clevel descriptive units of finding aid identified with "F9816", in hierarchy directly under F9816 that contain the searchterm "nepal".

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

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

eg.
<pre>
{
"totalResults": 1,
"startIndex": 0,
"totalPages": 1,
"eadSearchResults": [
{
"id": "C5026409",
"fondsUnitTitle": "Inventaris van het code-archief van het Ministerie van Buitenlandse Zaken, 1955-1964",
"fondsUnitId": "2.05.118",
"repository": "Nationaal Archief",
"country": "NETHERLANDS",
"language": "",
"langMaterial": "",
"unitDate": "1961",
"repositoryCode": "NL-HaNA",
"hasDigitalObject": false,
"docType": "Descriptive Unit",
"docTypeId": "du",
"level": "clevel",
"indexDate": "Mon Dec 07 10:18:59 UTC 2015",
"unitId": "2.05.118 - 11917",
"unitTitle": "Nepal, 1961",
"unitTitleWithHighlighting": "<em>Nepal</em>, 1961",
"scopeContent": "",
"scopeContentWithHighlighting": null
}
],
"sortFields": [
"date",
"findingAidNo",
"orderId",
"title",
"referenceCode"
]
}
</pre>

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

{| class="wikitable"
| id
| Internal APE identifier of the result
|-
| unitId
| Identifier of the result provided by the repository
|-
| unitTitle
| Description of the result
|-
| unitTitleWithHighlighting
| Description of the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request.
|-
| unitDate
| Date of creation of the result.
|-
| scopeContent
| More descriptive information about the result.
|-
| 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
| TRUE/FALSE
|-
| langMaterial
| Language in which the result is created.
|-
| language
| Language of the description of the result.
|-
| docType
| Type of archives describing document where 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
|-
| fondsUnitId
| Identifier of the fonds provided by the repository.
|-
| fondsUnitTitle
| Title of the finding aid.
|-
| 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.
|}

== 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
* orderId
* title
* referenceCode

[[Category:Technical_documentation]]

@@ Line 21: / Line 21: @@
 == 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 = C392726467
+ID = C372271857
+{
    "count": "5",
    "startIndex": 0,
-   "query": "reglement"
+   "query": "Jaarverslagen"
+}
 </pre>

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

@@ Line 2: / Line 2: @@
 This service is a POST-request.
-This search service delivers a list of archival descriptions with the requested searchterm one level deeper in the hierarchy 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 one level deeper in the hierarchy 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>
@@ Line 8: / Line 8: @@
 Three 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;">
 ID = .....
@@ Line 19: / Line 19: @@
 </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;">
 ID = C85446159
@@ Line 30: / Line 30: @@
 </pre>
-On [base_url]/search/ead/C85446159/children, it gives all the clevel descriptive units of descriptive unit identified with "C85446159", in the hierarchy directly under C85446159 that contain the searchterm "KNVB".
+On [base_url]/search/ead/C85446159/children, it gives all the clevel descriptive units of descriptive unit identified with "C85446159", in the hierarchy directly under C85446159 that contain the search term "KNVB".
 == count ==
@@ Line 39: / Line 39: @@
 == query ==
-Containing the searchterm(s). Required.
+Containing the search term(s). Required.
 = 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.
-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 83: / Line 83: @@
 </pre>
-Basic Response example (ie response for the basic request example above):
+== Basic Response 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;">
+{
@@ Line 136: / Line 137: @@
 == 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"
@@ Line 152: / Line 153: @@
 |-
 | country
-| Name of the country where the repository is. In English
+| Name of the country where the repository is, in English
 |-
 | language
@@ Line 164: / Line 165: @@
 |-
 | 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]
 |-
 | hasDigitalObject
@@ Line 179: / Line 180: @@
 |-
 | docType
-| Type of archives describing document where the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit"
+| Type of document in which 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"
+| Acronym for the type of document: "fa" for "Finding Aid", "hg" for "Holdings Guide", "sg" for "Source Guide" or "du" for "Descriptive unit"
 |-
 | level
@@ Line 197: / Line 198: @@
 |-
 | unitTitleWithHighlighting
-| Description of the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request
+| Description of the result, with the mark "<nowiki><em></nowiki>" to emphasise the search term that was used in the search request
 |-
 | scopeContent
@@ Line 203: / Line 204: @@
 |-
 | 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
+| 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

← Older revision		Revision as of 12:13, 8 March 2017
Line 1:		Line 1:
−	Request url: <code>https://api.archivesportaleurope.net/services/search/ead/{id}/children</code>.	+	Request url: [https://www.archivesportaleurope.net/ApeApi/#!/search/getChildren <code>https://api.archivesportaleurope.net/services/search/ead/{id}/children</code>].
	This service is a POST-request.		This service is a POST-request.

@@ Line 211: / Line 211: @@
 == 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: [[searchEad#sortRequest]]):
 * date

searchEadChildren - Revision history

Admin: /* Basic Request example */

Admin: /* Basic Response example */

Admin at 14:38, 30 August 2017

Admin: /* sortFields */

Admin: /* Basic Response example */

Admin at 09:47, 6 June 2017

Admin at 11:48, 5 June 2017

Admin at 12:13, 8 March 2017

Admin: Created page with "Request url: https://api.archivesportaleurope.net/services/search/ead/{id}/children. This service is a POST-request. This search service delivers a list of archi..."

Admin: Created page with "Request url: `https://api.archivesportaleurope.net/services/search/ead/{id}/children`. This service is a POST-request. This search service delivers a list of archi..."