Difference between revisions of "getInstitutes"

From Archives Portal Europe Wiki
Jump to: navigation, search
(institutes)
Line 36: Line 36:
 
== institutes ==
 
== institutes ==
  
(tabel)
+
(table)
  
 
[[Category:Technical_documentation]]
 
[[Category:Technical_documentation]]

Revision as of 13:50, 11 August 2016

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

This service is a POST-request.



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)