getInstitutes

From Archives Portal Europe Wiki
Revision as of 13:45, 11 August 2016 by Admin (Talk | contribs) (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...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Request url: https://api.archivesportaleurope.net/services/institute/getInstitutes/{startIndex}/{count}

This service is a GET-request.

--> We want to turn it into a POST-request, which feels more consistent...



Request parameters

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.

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.

Response parameters

eg.

{
  "totalResults": 1,
  "institutes": [
    {
      "name": "Noord-Hollands Archief",
      "id": 362,
      "country": "NETHERLANDS",
      "countryId": 7,
      "numberOfFindingAids": 2452,
      "repositoryCode": "NL-HlmNHA"
    }
  ]
}


totalResults

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

institutes

(tabel)