Difference between revisions of "getInstitutes"

From Archives Portal Europe Wiki
Jump to: navigation, search
(institutes)
Line 1: Line 1:
Request url: <code>https://api.archivesportaleurope.net/services/institute/getInstitutes/{startIndex}/{count}</code>
+
Request url: <code>https://api.archivesportaleurope.net/services/institute/getInstitutes/</code>
 
+
 
This service is a POST-request.
 
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.
 +
 
<div><br/>__TOC__<br/></div>
 
<div><br/>__TOC__<br/></div>
 
= Request parameters =
 
= Request parameters =

Revision as of 08:34, 1 November 2016

Request url: https://api.archivesportaleurope.net/services/institute/getInstitutes/ 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.



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.

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

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

(table)