Difference between revisions of "getInstitutes"

From Archives Portal Europe Wiki
Jump to: navigation, search
(Created page with "Request url: <code>https://api.archivesportaleurope.net/services/institute/getInstitutes/{startIndex}/{count}</code> This service is a GET-request. --> We want to turn it in...")
 
(→‎Basic Response example)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Request url: <code>https://api.archivesportaleurope.net/services/institute/getInstitutes/{startIndex}/{count}</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 GET-request.
+
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.
  
−
--> We want to turn it into a POST-request, which feels more consistent...
 
 
<div><br/>__TOC__<br/></div>
 
<div><br/>__TOC__<br/></div>
 
= Request parameters =
 
= 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.
  
−
== startIndex ==
+
== Empty Request example ==
−
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.
+
<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",
 +
  "startIndex": 0
 +
}
 +
</pre>
  
 
== count ==
 
== 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.
 
The resultlist is delivered in chunks of a certain size. Request parameter "count" describes the number of results that are in one chunk. Required.
 +
 +
== 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. Required.
 
<br/><br/>
 
<br/><br/>
 +
 
= Response parameters =
 
= Response parameters =
  
−
eg.
+
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.
−
<pre>
+
 
 +
== Empty 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;">
 
{
 
{
−
   "totalResults": 1,
+
   "totalResults": 0,
 
   "institutes": [
 
   "institutes": [
 
     {
 
     {
−
       "name": "Noord-Hollands Archief",
+
       "name": "string",
−
       "id": 362,
+
      "id": 0,
 +
      "country": "string",
 +
      "countryId": 0,
 +
      "totalDocs": 0,
 +
      "repositoryCode": "string"
 +
    }
 +
  ]
 +
}
 +
</pre>
 +
 
 +
== Basic Response example ==
 +
For count = 5:
 +
<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": 76,
 +
  "institutes": [
 +
    {
 +
      "name": "Štátny archív v Bratislave",
 +
      "id": 2001,
 +
      "country": "SLOVAKIA",
 +
      "countryId": 32,
 +
      "totalDocs": 2,
 +
      "repositoryCode": "SK-00000002001"
 +
    },
 +
    {
 +
      "name": "Gemeente Leek",
 +
       "id": 2742,
 
       "country": "NETHERLANDS",
 
       "country": "NETHERLANDS",
 
       "countryId": 7,
 
       "countryId": 7,
−
       "numberOfFindingAids": 2452,
+
       "totalDocs": 21,
−
       "repositoryCode": "NL-HlmNHA"
+
       "repositoryCode": "NL-LekGL"
 +
    },
 +
    {
 +
      "name": "Gemeente Marum",
 +
      "id": 2744,
 +
      "country": "NETHERLANDS",
 +
      "countryId": 7,
 +
      "totalDocs": 15,
 +
      "repositoryCode": "NL-MamGM"
 +
    },
 +
    {
 +
      "name": "Gemeente Stadskanaal",
 +
      "id": 2749,
 +
      "country": "NETHERLANDS",
 +
      "countryId": 7,
 +
      "totalDocs": 19,
 +
      "repositoryCode": "NL-SknGS"
 +
    },
 +
    {
 +
      "name": "Provincie Groningen",
 +
      "id": 2755,
 +
      "country": "NETHERLANDS",
 +
      "countryId": 7,
 +
      "totalDocs": 0,
 +
      "repositoryCode": "NL-GnPG"
 
     }
 
     }
 
   ]
 
   ]
 
}
 
}
 
</pre>
 
</pre>
−
 
  
 
== totalResults ==
 
== totalResults ==
Line 38: Line 99:
 
== institutes ==
 
== institutes ==
  
−
(tabel)
+
Enumeration of the results.
 +
 
 +
{| class="wikitable"
 +
| name
 +
| Name of the (archival) institution
 +
|-
 +
| id
 +
| 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
 +
|-
 +
| countryId
 +
| Internal APE identifier of the country
 +
|-
 +
| totalDocs
 +
| 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]
 +
|}
 +
 
  
 
[[Category:Technical_documentation]]
 
[[Category:Technical_documentation]]

Latest revision as of 12:38, 10 January 2018

Request url: https://api.archivesportaleurope.net/services/institute/getInstitutes/. This service is a POST-request.

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.



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.

Empty Request example

{
  "count": "5",
  "startIndex": 0
}

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.

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

Response parameters

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

{
  "totalResults": 0,
  "institutes": [
    {
      "name": "string",
      "id": 0,
      "country": "string",
      "countryId": 0,
      "totalDocs": 0,
      "repositoryCode": "string"
    }
  ]
}

Basic Response example

For count = 5: 

{
  "totalResults": 76,
  "institutes": [
    {
      "name": "Štátny archív v Bratislave",
      "id": 2001,
      "country": "SLOVAKIA",
      "countryId": 32,
      "totalDocs": 2,
      "repositoryCode": "SK-00000002001"
    },
    {
      "name": "Gemeente Leek",
      "id": 2742,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 21,
      "repositoryCode": "NL-LekGL"
    },
    {
      "name": "Gemeente Marum",
      "id": 2744,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 15,
      "repositoryCode": "NL-MamGM"
    },
    {
      "name": "Gemeente Stadskanaal",
      "id": 2749,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 19,
      "repositoryCode": "NL-SknGS"
    },
    {
      "name": "Provincie Groningen",
      "id": 2755,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 0,
      "repositoryCode": "NL-GnPG"
    }
  ]
}

totalResults

The response parameter "totalResults" gives the number of results.

institutes

Enumeration of the results.

name Name of the (archival) institution
id 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
countryId Internal APE identifier of the country
totalDocs 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 ISIL
Retrieved from "http://wiki-deprecated.archivesportaleurope.net/index.php?title=getInstitutes&oldid=1795"