getDocs - Revision history

Admin: /* Basic Response example */

2018-01-10T12:41:02Z

‎Basic Response example

Show changes

Admin: /* Empty Request example */

2018-01-10T12:40:10Z

‎Empty Request example

Admin at 14:46, 30 August 2017

2017-08-30T14:46:50Z

Show changes

Admin at 13:02, 6 June 2017

2017-06-06T13:02:53Z

Admin at 13:02, 6 June 2017

2017-06-06T13:02:15Z

Admin: /* Response parameters */

2017-06-05T12:44:27Z

‎Response parameters

Admin at 12:43, 5 June 2017

2017-06-05T12:43:51Z

Show changes

Admin at 12:36, 8 March 2017

2017-03-08T12:36:25Z

Admin at 08:35, 1 November 2016

2016-11-01T08:35:11Z

Admin at 13:54, 11 August 2016

2016-08-11T13:54:11Z

@@ Line 13: / Line 13: @@
    "count": "5",
    "startIndex": 0,
-   "instituteId": "string",
+   "instituteId": " ",
-   "docType": "string",
+   "docType": "fa",
    "sortRequest": {
      "sortType": "asc",

@@ Line 77: / Line 77: @@
 == Basic Response example ==
-For the basic request example above:
+For the [[getDocs#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 institute service delivers a list of Finding Aids, Holding Guides and Source Guides provided through the API. Remember that this only contains document of institutes that have enabled Open Data in the APE Dashboard.
+This institute-service delivers a list of finding aids, holding guides and source guides provided by one particular (archival) institution as Open Data via the API. Remember that this only works for (archival) institutions that have enabled Open Data in the Archives Portal Europe's Dashboard.
 <div><br/>__TOC__<br/></div>
 = Request parameters =
-Four request parameters can be used to get a list of the documents of an archival institution that has enabled the API services for its datasets in the Archives Portal Europe's Dashboard.
+Four request parameters can be used to get a list of the documents of an (archival) institution that has enabled the API services for its datasets in the Archives Portal Europe's Dashboard.
-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 18: / Line 18: @@
 </pre>
-Basic Request example (for 5 documents, ie finding aids (fa), of the Nationaal Archief, ie with as internal APE identifier 32171):
+== Basic Request example ==
-<pre>
+For 5 documents, ie finding aids (fa), of the Nationaal Archief, ie identified with internal APE identifier 32171:
+{
    "count": "5",
@@ Line 43: / Line 44: @@
 = Response parameters =
-The response contains basic information on the documents of the archival institution for which the list of documents was requested.
+The response contains basic information on the documents of the (archival) institution for which the list of documents was requested.
-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 75: / Line 76: @@
 </pre>
-Basic Response example (for 5 documents, ie finding aids (fa), of the Nationaal Archief, ie with as internal APE identifier 32171):
+== 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 207: / Line 209: @@
 |-
 | country
-| Name of the country where the repository is. In English
+| Name of the country where the repository is, in English
 |-
 | language
@@ Line 219: / Line 221: @@
 |-
 | 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 237: / Line 239: @@
 |-
 | docTypeId
-| Acronym for the type of document ("fa" for "Finding Aid", "hg" for "Holdings Guide" or "sg" for "Source Guide")
+| Acronym for the type of document: "fa" for "Finding Aid", "hg" for "Holdings Guide" or "sg" for "Source Guide"
 |-
 | level

@@ Line 76: / Line 76: @@
 Basic Response example (for 5 documents, ie finding aids (fa), of the Nationaal Archief, ie with as internal APE identifier 32171):
-<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": 6754,

@@ Line 1: / Line 1: @@
-Request url: <code>https://api.archivesportaleurope.net/services/institute/getDocs</code>
+Request url: [https://www.archivesportaleurope.net/ApeApi/#!/institute/getInsDocument <code>https://api.archivesportaleurope.net/services/institute/getDocs</code>].
 This service is a POST-request.
@@ Line 10: / Line 10: @@
+{
    "count": 0,
-   "startIndex": 0
+   "startIndex": 0,
    "instituteId": "361",
-   "docType": "fa",
+   "docType": "fa"
+}
 </pre>

@@ Line 7: / Line 7: @@
 <pre>
+{
    "count": 0,
    "startIndex": 0
+}
 </pre>
 == instituteId ==
@@ Line 20: / Line 26: @@
 Depending on which type of archival description you want, use "fa" for finding aid, "hg" for holdingsguide or "sg" for sourceguide. Required.
 <br/><br/>
 = Response parameters =