getInstitutes - Revision history

Admin: /* Basic Response example */

2018-01-10T12:38:13Z

‎Basic Response example

Admin at 14:46, 30 August 2017

2017-08-30T14:46:10Z

Admin at 13:12, 6 June 2017

2017-06-06T13:12:06Z

Admin at 12:49, 6 June 2017

2017-06-06T12:49:51Z

Admin at 12:42, 5 June 2017

2017-06-05T12:42:54Z

Admin at 12:34, 8 March 2017

2017-03-08T12:34:26Z

Admin at 08:34, 1 November 2016

2016-11-01T08:34:25Z

Admin: /* institutes */

2016-08-11T13:50:00Z

‎institutes

Admin at 13:48, 11 August 2016

2016-08-11T13:48:50Z

Admin at 13:47, 11 August 2016

2016-08-11T13:47:33Z

@@ Line 48: / Line 48: @@
 <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": 74,
+   "totalResults": 76,
    "institutes": [
+     {
-       "name": "Gemeente Marum",
+       "name": "Štátny archív v Bratislave",
-       "id": 2744,
+       "id": 2001,
-       "country": "NETHERLANDS",
+       "country": "SLOVAKIA",
-       "countryId": 7,
+       "countryId": 32,
-       "totalDocs": 30,
+       "totalDocs": 2,
-       "repositoryCode": "NL-MamGM"
+       "repositoryCode": "SK-00000002001"
      },
+     {
-       "name": "Provincie Groningen",
+       "name": "Gemeente Leek",
-       "id": 2755,
+       "id": 2742,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "totalDocs": 0,
+       "totalDocs": 21,
-       "repositoryCode": "NL-GnPG"
+       "repositoryCode": "NL-LekGL"
      },
+     {
-       "name": "Provincie Drenthe",
+       "name": "Gemeente Marum",
-       "id": 2756,
+       "id": 2744,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "totalDocs": 9,
+       "totalDocs": 15,
-       "repositoryCode": "NL-AsnPD"
+       "repositoryCode": "NL-MamGM"
      },
+     {
-       "name": "Gemeente Noordenveld",
+       "name": "Gemeente Stadskanaal",
-       "id": 2702,
+       "id": 2749,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "totalDocs": 2,
+       "totalDocs": 19,
-       "repositoryCode": "NL-RodGN"
+       "repositoryCode": "NL-SknGS"
      },
+     {
-       "name": "Gemeente Vlieland",
+       "name": "Provincie Groningen",
-       "id": 2730,
+       "id": 2755,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "totalDocs": 7,
+       "totalDocs": 0,
-       "repositoryCode": "NL-VldGV"
+       "repositoryCode": "NL-GnPG"
+     }
+   ]

@@ Line 15: / Line 15: @@
+}
 </pre>
-−
 == count ==
 The resultlist is delivered in chunks of a certain size. Request parameter "count" describes the number of results that are in one chunk. Required.
@@ Line 48: / Line 48: @@
 <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": 4,
+   "totalResults": 74,
    "institutes": [
+     {
-       "name": "Noord-Hollands Archief",
+       "name": "Gemeente Marum",
-       "id": 32125,
+       "id": 2744,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "totalDocs": 0,
+       "totalDocs": 30,
-       "repositoryCode": "NL-HlmNHA"
+       "repositoryCode": "NL-MamGM"
      },
+     {
-       "name": "Historisch Centrum Leeuwarden",
+       "name": "Provincie Groningen",
-       "id": 32116,
+       "id": 2755,
        "country": "NETHERLANDS",
        "countryId": 7,
        "totalDocs": 0,
-       "repositoryCode": "NL-LwHCL"
+       "repositoryCode": "NL-GnPG"
      },
+     {
-       "name": "Regionaal Archief Tilburg",
+       "name": "Provincie Drenthe",
-       "id": 32018,
+       "id": 2756,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "totalDocs": 0,
+       "totalDocs": 9,
-       "repositoryCode": "NL-TbRAT"
+       "repositoryCode": "NL-AsnPD"
      },
+     {
-       "name": "Nationaal Archief",
+       "name": "Gemeente Vlieland",
-       "id": 32171,
+       "id": 2730,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "totalDocs": 15,
+       "totalDocs": 7,
-       "repositoryCode": "NL-HaNA"
+       "repositoryCode": "NL-VldGV"
+     }
+   ]

@@ Line 2: / Line 2: @@
 This service is a POST-request.
-This institute-service delivers a list of institutes that provide their data as Open Data via the API. Remember that this list only contains institutes that have enabled Open Data in the Archives Portal Europe's Dashboard.
+This institute-service delivers a list of (archival) institutions that provide their data as Open Data via the API. Remember that this list only contains (archival) institutions that have enabled Open Data in the Archives Portal Europe's Dashboard.
 <div><br/>__TOC__<br/></div>

@@ Line 2: / Line 2: @@
 This service is a POST-request.
-This institute service delivers a list of institutes that provide their data through the API. Remember that this only contains institutes that have enabled Open Data in the APE Dashboard.
+This institute-service delivers a list of institutes that provide their data as Open Data via the API. Remember that this list only contains institutes that have enabled Open Data in the Archives Portal Europe's Dashboard.
 <div><br/>__TOC__<br/></div>
 = Request parameters =
-Two request parameters can be used to get a list of archival institutions that have enabled the API services for their datasets in the Archives Portal Europe's Dashboard.
+Two request parameters can be used to get a list of (archival) institutions that have enabled the API services for their 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 25: / Line 25: @@
 = Response parameters =
-The response contains basic information on the institutions that have enabled the API services for their datasets in the Archives Portal Europe's Dashboard.
+The response contains basic information on the (archival) institutions that have enabled the API services for their datasets in the Archives Portal Europe's Dashboard.
-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 44: / Line 44: @@
 </pre>
-Basic Response example (for count = 5):
+== Basic Response example ==
-<pre>
+For count = 5:
+{
    "totalResults": 4,
@@ Line 94: / Line 95: @@
 {| class="wikitable"
 | name
-| Name of the archival institution
+| Name of the (archival) institution
 |-
 | id
-| Internal APE identifier of the result, ie the internal APE identifier of the archival institution
+| Internal APE identifier of the result, ie the internal APE identifier of the (archival) institution
 |-
 | country
-| Name of the country where the repository is. In English
+| Name of the country where the repository is, in English
 |-
 | countryId
@@ Line 106: / Line 107: @@
 |-
 | totalDocs
-| Total amount of documents of the archival institution available via the API services
+| Total amount of documents of the (archival) institution available via the API services
 |-
 | 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]
 |}
 [[Category:Technical_documentation]]

@@ Line 6: / Line 6: @@
 <div><br/>__TOC__<br/></div>
 = Request parameters =
 == count ==
 The resultlist is delivered in chunks of a certain size. Request parameter "count" describes the number of results that are in one chunk. Required.
@@ Line 13: / Line 22: @@
 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. Required.
 <br/><br/>
 = Response parameters =
-eg.
+The response contains basic information on the institutions that have enabled the API services for their datasets in the Archives Portal Europe's Dashboard.
 <pre>
+{
-   "totalResults": 1,
+   "totalResults": 0,
    "institutes": [
+     {
        "name": "Noord-Hollands Archief",
-       "id": 362,
+       "id": 32125,
        "country": "NETHERLANDS",
        "countryId": 7,
-       "numberOfFindingAids": 2452,
+       "totalDocs": 0,
        "repositoryCode": "NL-HlmNHA"
+     }
+   ]
+}
 </pre>
 == totalResults ==
@@ Line 38: / Line 90: @@
 == institutes ==
-(table)
+Enumeration of the results.
 [[Category:Technical_documentation]]

← Older revision		Revision as of 12:34, 8 March 2017
Line 1:		Line 1:
−	Request url: <code>https://api.archivesportaleurope.net/services/institute/getInstitutes/</code>	+	Request url: [https://www.archivesportaleurope.net/ApeApi/#!/institute/getInsByOpenData <code>https://api.archivesportaleurope.net/services/institute/getInstitutes/</code>].
	This service is a POST-request.		This service is a POST-request.

@@ Line 1: / Line 1: @@
 Request url: <code>https://api.archivesportaleurope.net/services/institute/getInstitutes/{startIndex}/{count}</code>
-This service is a GET-request.
+This service is a POST-request.
-−
---> We want to turn it into a POST-request, which feels more consistent...
 <div><br/>__TOC__<br/></div>
 = Request parameters =