Revision as of 14:46, 30 August 2017

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": 74,
  "institutes": [
    {
      "name": "Gemeente Marum",
      "id": 2744,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 30,
      "repositoryCode": "NL-MamGM"
    },
    {
      "name": "Provincie Groningen",
      "id": 2755,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 0,
      "repositoryCode": "NL-GnPG"
    },
    {
      "name": "Provincie Drenthe",
      "id": 2756,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 9,
      "repositoryCode": "NL-AsnPD"
    },
    {
      "name": "Gemeente Noordenveld",
      "id": 2702,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 2,
      "repositoryCode": "NL-RodGN"
    },
    {
      "name": "Gemeente Vlieland",
      "id": 2730,
      "country": "NETHERLANDS",
      "countryId": 7,
      "totalDocs": 7,
      "repositoryCode": "NL-VldGV"
    }
  ]
}

totalResults

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

institutes

Enumeration of the results.