Difference between revisions of "hierarchyEadChildren"
From Archives Portal Europe Wiki
| Line 2: | Line 2: | ||
This service is a POST-request. | This service is a POST-request. | ||
| − | This hierarchy service delivers a list of all archival descriptions one level deeper in the hierarchy of the archival description identified with {id}. A web developer can use this service to create a tree-like presentation of a finding aid. | + | This hierarchy-service delivers a list of all archival descriptions one level deeper in the hierarchy of the archival description identified with {id}. A web developer can use this service to create a tree-like presentation of a finding aid. |
<div><br/>__TOC__<br/></div> | <div><br/>__TOC__<br/></div> | ||
| Line 8: | Line 8: | ||
Two request parameters can be used to get a list of children of an archival description. | Two request parameters can be used to get a list of children of an archival description. | ||
| − | 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;"> |
ID = ..... | ID = ..... | ||
| Line 18: | Line 18: | ||
</pre> | </pre> | ||
| − | Basic Request example | + | == Basic 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;"> |
ID = C85437490 | ID = C85437490 | ||
| Line 37: | Line 37: | ||
= Response parameters = | = Response parameters = | ||
| − | The response contains a list of the | + | The response contains a list of the descriptive units where the requested search term(s) was/were found. |
| − | 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 74: | Line 74: | ||
</pre> | </pre> | ||
| − | Basic Response example | + | == Basic Response example == |
| − | <pre> | + | For identifier C85437490: |
| + | <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": 3, | "totalResults": 3, | ||
| Line 167: | Line 168: | ||
== results == | == results == | ||
| − | Enumeration of the results. A result could be a holdings guide, a source guide, a finding aid, or a descriptive unit (ie | + | Enumeration of the results. A result could be a holdings guide, a source guide, a finding aid, or a descriptive unit (ie a sublevel component). They are all optional except "id". |
{| class="wikitable" | {| class="wikitable" | ||
| Line 183: | Line 184: | ||
|- | |- | ||
| country | | country | ||
| − | | Name of the country where the repository is | + | | Name of the country where the repository is, in English |
|- | |- | ||
| language | | language | ||
| Line 195: | Line 196: | ||
|- | |- | ||
| 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] |
|- | |- | ||
| hasDigitalObject | | hasDigitalObject | ||
| Line 210: | Line 211: | ||
|- | |- | ||
| docType | | docType | ||
| − | | Type of | + | | Type of document in which the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit" |
|- | |- | ||
| docTypeId | | docTypeId | ||
| − | | Acronym for the type of | + | | Acronym for the type of document: "fa" for "Finding Aid", "hg" for "Holdings Guide", "sg" for "Source Guide" or "du" for "Descriptive unit" |
|- | |- | ||
| level | | level | ||
Revision as of 10:46, 6 June 2017
Request url: https://api.archivesportaleurope.net/services//hierarchy/ead/{id}/children.
This service is a POST-request.
This hierarchy-service delivers a list of all archival descriptions one level deeper in the hierarchy of the archival description identified with {id}. A web developer can use this service to create a tree-like presentation of a finding aid.
Contents
Request parameters
Two request parameters can be used to get a list of children of an archival description.
Empty Request example
ID = .....
{
"count": "5",
"startIndex": 0
}
Basic Request example
ID = C85437490
{
"count": "5",
"startIndex": 0
}
On [base_url]/search/ead/C85437490/children, it gives all the clevel descriptive units one level deeper in the hierarchy of the descriptive unit identified with "C85437490".
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
The response contains a list of the descriptive units where the requested search term(s) was/were found.
Empty Response example
{
"totalResults": 0,
"startIndex": 0,
"totalPages": 0,
"results": [
{
"id": "string",
"fondsUnitTitle": "string",
"fondsUnitId": "string",
"repository": "string",
"country": "string",
"language": "string",
"langMaterial": "string",
"unitDate": "string",
"repositoryCode": "string",
"hasDigitalObject": false,
"numberOfDigitalObjects": 0,
"numberOfDigitalObjectsInDescendents": 0,
"numberOfDescendents": 0,
"docType": "string",
"docTypeId": "string",
"level": "string",
"indexDate": "string",
"unitId": "string",
"unitTitle": "string",
"scopeContent": "string",
"siblingPosition": 0,
"ancestorLevel": 0
}
]
}
Basic Response example
For identifier C85437490:
{
"totalResults": 3,
"startIndex": 0,
"totalPages": 1,
"results": [
{
"id": "C85437491",
"fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
"fondsUnitId": "2.13.132",
"repository": "Nationaal Archief",
"country": "NETHERLANDS",
"language": "",
"langMaterial": "",
"unitDate": "",
"repositoryCode": "NL-HaNA",
"hasDigitalObject": false,
"numberOfDigitalObjects": 0,
"numberOfDigitalObjectsInDescendents": 0,
"numberOfDescendents": 64,
"docType": "Descriptive Unit",
"docTypeId": "du",
"level": "clevel",
"indexDate": "",
"unitId": "2.13.132 - A.5.1",
"unitTitle": "Militaire Luchtvaart in Nederlands-Indië",
"scopeContent": "",
"siblingPosition": 0,
"ancestorLevel": 3
},
{
"id": "C85437556",
"fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
"fondsUnitId": "2.13.132",
"repository": "Nationaal Archief",
"country": "NETHERLANDS",
"language": "",
"langMaterial": "",
"unitDate": "",
"repositoryCode": "NL-HaNA",
"hasDigitalObject": false,
"numberOfDigitalObjects": 0,
"numberOfDigitalObjectsInDescendents": 0,
"numberOfDescendents": 53,
"docType": "Descriptive Unit",
"docTypeId": "du",
"level": "clevel",
"indexDate": "",
"unitId": "2.13.132 - A.5.2",
"unitTitle": "Geallieerde Commando's",
"scopeContent": "",
"siblingPosition": 1,
"ancestorLevel": 3
},
{
"id": "C85437610",
"fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
"fondsUnitId": "2.13.132",
"repository": "Nationaal Archief",
"country": "NETHERLANDS",
"language": "",
"langMaterial": "",
"unitDate": "",
"repositoryCode": "NL-HaNA",
"hasDigitalObject": false,
"numberOfDigitalObjects": 0,
"numberOfDigitalObjectsInDescendents": 0,
"numberOfDescendents": 40,
"docType": "Descriptive Unit",
"docTypeId": "du",
"level": "clevel",
"indexDate": "",
"unitId": "2.13.132 - A.5.3",
"unitTitle": "Geallieerde landen",
"scopeContent": "",
"siblingPosition": 2,
"ancestorLevel": 3
}
]
}
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.
results
Enumeration of the results. A result could be a holdings guide, a source guide, a finding aid, or a descriptive unit (ie a sublevel component). They are all optional except "id".
| id | Internal APE identifier of the result |
| fondsUnitTitle | Title of the finding aid |
| fondsUnitId | Identifier of the fonds provided by the repository |
| repository | Name of the repository holding the fonds |
| country | Name of the country where the repository is, in English |
| language | Language of the description of the result |
| langMaterial | Language in which the result is created |
| unitDate | Date of creation of the result. |
| repositoryCode | Code of the repository holding the fonds; preferably, but not necessarily ISIL |
| hasDigitalObject | TRUE/FALSE |
| numberOfDigitalObjects | Amount of digital objects available for the search result (is always 0 in case 'hasDigitalObject' = FALSE) |
| numberOfDigitalOjectsInDescendents | Amount of digital objects available for descendents of the search result (can be > 0 in case 'hasDigtalObject' = FALSE) |
| numberOfDescendents | Amount of descendents of the search result |
| docType | Type of document in which the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit" |
| docTypeId | Acronym for the type of document: "fa" for "Finding Aid", "hg" for "Holdings Guide", "sg" for "Source Guide" or "du" for "Descriptive unit" |
| level | Type of result: "archdesc" for highest level description or "clevel" for subordinate components |
| indexDate | Date showing when the result was ingested/updated and indexed in the Archives Portal Europe (ie last change date) |
| unitId | Identifier of the result provided by the repository |
| unitTitle | Description of the result |
| scopeContent | More descriptive information about the result |
| siblingPosition | Position of the result in the order of children in the level beneath the descriptive unit of the identifier in the request |
| ancestorLevel | Position of the descriptive unit of the identifier in the request in the higher hierarchy of the document it belongs to |
