Difference between revisions of "getInstitutes"
From Archives Portal Europe Wiki
| Line 2: | Line 2: | ||
This service is a POST-request. | This service is a POST-request. | ||
| − | This institute service delivers a list of institutes that provide their data | + | This institute-service delivers a list of institutes that provide their data as Open Data via the API. Remember that this list only contains institutes that have enabled Open Data in the Archives Portal Europe's Dashboard. |
<div><br/>__TOC__<br/></div> | <div><br/>__TOC__<br/></div> | ||
= Request parameters = | = 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. | + | 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 | + | == Empty Request example == |
| − | <pre> | + | <pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;"> |
{ | { | ||
"count": "5", | "count": "5", | ||
| Line 25: | Line 25: | ||
= Response parameters = | = Response parameters = | ||
| − | The response contains basic information on the institutions that have enabled the API services for their datasets in the Archives Portal Europe's Dashboard. | + | 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 | + | == Empty Response example == |
| − | <pre> | + | <pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;"> |
{ | { | ||
"totalResults": 0, | "totalResults": 0, | ||
| Line 44: | Line 44: | ||
</pre> | </pre> | ||
| − | Basic Response example | + | == Basic Response example == |
| − | <pre> | + | For count = 5: |
| + | <pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;"> | ||
{ | { | ||
"totalResults": 4, | "totalResults": 4, | ||
| Line 94: | Line 95: | ||
{| class="wikitable" | {| class="wikitable" | ||
| name | | name | ||
| − | | Name of the archival institution | + | | Name of the (archival) institution |
|- | |- | ||
| id | | id | ||
| − | | Internal APE identifier of the result, ie the internal APE identifier of the archival institution | + | | Internal APE identifier of the result, ie the internal APE identifier of the (archival) institution |
|- | |- | ||
| country | | country | ||
| − | | Name of the country where the repository is | + | | Name of the country where the repository is, in English |
|- | |- | ||
| countryId | | countryId | ||
| Line 106: | Line 107: | ||
|- | |- | ||
| totalDocs | | totalDocs | ||
| − | | Total amount of documents of the archival institution available via the API services | + | | Total amount of documents of the (archival) institution available via the API services |
|- | |- | ||
| repositoryCode | | repositoryCode | ||
| − | | Code of the repository holding the fonds | + | | Code of the repository holding the fonds; preferably, but not necessarily [https://en.wikipedia.org/wiki/International_Standard_Identifier_for_Libraries_and_Related_Organizations ISIL] |
|} | |} | ||
[[Category:Technical_documentation]] | [[Category:Technical_documentation]] | ||
Revision as of 12:49, 6 June 2017
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 as Open Data via the API. Remember that this list only contains institutes that have enabled Open Data in the Archives Portal Europe's Dashboard.
Contents
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": 4,
"institutes": [
{
"name": "Noord-Hollands Archief",
"id": 32125,
"country": "NETHERLANDS",
"countryId": 7,
"totalDocs": 0,
"repositoryCode": "NL-HlmNHA"
},
{
"name": "Historisch Centrum Leeuwarden",
"id": 32116,
"country": "NETHERLANDS",
"countryId": 7,
"totalDocs": 0,
"repositoryCode": "NL-LwHCL"
},
{
"name": "Regionaal Archief Tilburg",
"id": 32018,
"country": "NETHERLANDS",
"countryId": 7,
"totalDocs": 0,
"repositoryCode": "NL-TbRAT"
},
{
"name": "Nationaal Archief",
"id": 32171,
"country": "NETHERLANDS",
"countryId": 7,
"totalDocs": 15,
"repositoryCode": "NL-HaNA"
}
]
}
totalResults
The response parameter "totalResults" gives the number of results.
institutes
Enumeration of the results.
| name | Name of the (archival) institution |
| id | Internal APE identifier of the result, ie the internal APE identifier of the (archival) institution |
| country | Name of the country where the repository is, in English |
| countryId | Internal APE identifier of the country |
| totalDocs | Total amount of documents of the (archival) institution available via the API services |
| repositoryCode | Code of the repository holding the fonds; preferably, but not necessarily ISIL |
