Difference between revisions of "getInstitutes"
From Archives Portal Europe Wiki
| Line 6: | Line 6: | ||
<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. | ||
| + | Empty Request example: | ||
| + | <pre> | ||
| + | { | ||
| + | "count": "5", | ||
| + | "startIndex": 0 | ||
| + | } | ||
| + | </pre> | ||
| + | |||
== count == | == 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. | The resultlist is delivered in chunks of a certain size. Request parameter "count" describes the number of results that are in one chunk. Required. | ||
| Line 13: | Line 22: | ||
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. | 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. | ||
<br/><br/> | <br/><br/> | ||
| + | |||
= 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. | |
| + | |||
| + | Empty Response example: | ||
<pre> | <pre> | ||
{ | { | ||
| − | "totalResults": | + | "totalResults": 0, |
| + | "institutes": [ | ||
| + | { | ||
| + | "name": "string", | ||
| + | "id": 0, | ||
| + | "country": "string", | ||
| + | "countryId": 0, | ||
| + | "totalDocs": 0, | ||
| + | "repositoryCode": "string" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | Basic Response example (for count = 5): | ||
| + | <pre> | ||
| + | { | ||
| + | "totalResults": 4, | ||
"institutes": [ | "institutes": [ | ||
{ | { | ||
"name": "Noord-Hollands Archief", | "name": "Noord-Hollands Archief", | ||
| − | "id": | + | "id": 32125, |
"country": "NETHERLANDS", | "country": "NETHERLANDS", | ||
"countryId": 7, | "countryId": 7, | ||
| − | " | + | "totalDocs": 0, |
"repositoryCode": "NL-HlmNHA" | "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" | ||
} | } | ||
] | ] | ||
} | } | ||
</pre> | </pre> | ||
| − | |||
== totalResults == | == totalResults == | ||
| Line 38: | Line 90: | ||
== institutes == | == institutes == | ||
| − | + | Enumeration of the results. | |
| + | |||
| + | {| class="wikitable" | ||
| + | | 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 [https://en.wikipedia.org/wiki/International_Standard_Identifier_for_Libraries_and_Related_Organizations ISIL] | ||
| + | |} | ||
| + | |||
[[Category:Technical_documentation]] | [[Category:Technical_documentation]] | ||
Revision as of 12:42, 5 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 through the API. Remember that this only contains institutes that have enabled Open Data in the APE 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 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 |
