Revision as of 13:51, 11 August 2016

Request url: https://api.archivesportaleurope.net/services/institute/getDocs

This service is a POST-request.

Request parameters

eg.

{
  "instituteId": "361",
  "docType": "fa",
  "count": 0,
  "startIndex": 0
}

instituteId

APE-identifier for the repository from which you want to get the list of documents. Required.

docType

Depending on which type of archival description you want, use "fa" for finding aid, "hg" for holdingsguide or "sg" for sourceguide. 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. Optional. Default value is 5.

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. Optional. Default value is 0.

Response parameters

eg.

{
  "totalResults": 6714,
  "startIndex": 0,
  "totalPages": 1343,
  "eadResults": [
    {
      "id": "F11649",
      "fondsUnitTitle": "Inventaris van de Burgerlijke Stand der gemeente Sommelsdijk",
      "fondsUnitId": "3.198.07",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1812-1932",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "docType": "Finding Aid",
      "docTypeId": "fa",
      "level": "archdesc",
      "indexDate": "Sun Dec 13 16:07:22 UTC 2015"
    }
  ]
}

totalResults

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

startIndex

The response parameter "startIndex" gives the number of the chunk you requested.

totalPages

The response parameter "totalPages" gives the number of chunks.

eadResults

Enumeration of the results. Depending on the value of Request parameter 'docType', result could be a holdings guide, a source guide or a finding aid.

(table)