searchEadDescendants - Revision history

Admin: /* Basic Response example */

2018-01-09T14:20:41Z

‎Basic Response example

Admin at 14:37, 30 August 2017

2017-08-30T14:37:51Z

Show changes

Admin: /* eadSearchResults */

2017-06-06T09:53:24Z

‎eadSearchResults

Admin: /* Basic Response example */

2017-06-06T09:23:09Z

‎Basic Response example

Admin at 09:22, 6 June 2017

2017-06-06T09:22:06Z

Admin: /* Response parameters */

2017-06-05T11:18:43Z

‎Response parameters

Admin: /* Response parameters */

2017-06-05T11:18:00Z

‎Response parameters

Admin: /* Response parameters */

2017-06-05T11:16:54Z

‎Response parameters

Admin: /* Response parameters */

2017-06-05T11:10:27Z

‎Response parameters

Admin: /* Response parameters */

2017-06-05T11:09:28Z

‎Response parameters

@@ Line 247: / Line 247: @@
        "indexDate": "",
        "unitId": "2.19.225 - 5529",
-       "parentId": "",
+       "parentId": "C372728458",
        "unitTitle": "Nepal",
        "unitTitleWithHighlighting": "<em>Nepal</em>",
@@ Line 273: / Line 273: @@
        "indexDate": "",
        "unitId": "2.19.225 - 2798",
-       "parentId": "",
+       "parentId": "C372725884",
        "unitTitle": "C. Kant Jha ten behoeve van onderzoek in Nepal",
        "unitTitleWithHighlighting": "C. Kant Jha ten behoeve van onderzoek in <em>Nepal</em>",
@@ Line 299: / Line 299: @@
        "indexDate": "",
        "unitId": "2.19.225 - 2124",
-       "parentId": "",
+       "parentId": "C372725096",
        "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>'",

@@ Line 234: / Line 234: @@
 |-
 | 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 archives document: "fa" for "Finding Aid", "hg" for "Holdings Guide", "sg" for "Source Guide" or "du" for "Descriptive unit"
 |-
 | level

@@ Line 85: / Line 85: @@
 == Basic Response example ==
-Response for the basic request example above:
+Response for the [[searchEadDescendants#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 search term in the subtree 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 in the subtree 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 = F379215
@@ Line 30: / Line 30: @@
 </pre>
-On [base_url]/search/ead/F379215/descendants, it gives all the clevel descriptive units of finding aid identified with "F379215", that contain the searchterm "nepal".
+On [base_url]/search/ead/F379215/descendants, it gives all the clevel descriptive units of finding aid identified with "F379215", that contain the search term "nepal".
 == count ==
@@ Line 39: / Line 39: @@
 == query ==
-Containing the searchterm(s). Required.
+Containing the search term(s). Required.
 <br/><br/>
 = 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 84: / Line 84: @@
 </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 187: / Line 188: @@
 == 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 194: / Line 195: @@
 |-
 | fondsUnitTitle
-| Title of the finding aid.
+| Title of the finding aid
 |-
 | fondsUnitId
@@ Line 203: / Line 204: @@
 |-
 | country
-| Name of the country where the repository is. In English
+| Name of the country where the repository is, in English
 |-
 | language
@@ Line 215: / Line 216: @@
 |-
 | 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 248: / Line 249: @@
 |-
 | 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 254: / Line 255: @@
 |-
 | 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
@@ Line 261: / Line 262: @@
 == 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

@@ Line 85: / Line 85: @@
 Basic Response example (ie response for the basic request example above):
-<pre style="overflow:auto; width:auto;">
+<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": 3,