Difference between revisions of "hierarchyEadChildren"

From Archives Portal Europe Wiki
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
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, holdings guide or source guide.  
  
 
<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 = C376209320
  
 
{
 
{
Line 27: Line 27:
 
}
 
}
 
</pre>
 
</pre>
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".
+
On [base_url]/search/ead/C376209320/children, it gives all the clevel descriptive units one level deeper in the hierarchy of the descriptive unit identified with "C376209320".
 +
 
 +
''N.B.: you can find the (internal APE) identifier of a descriptive unit (always starting with a "C") which is necessary for using this service via the [[searchEad | /search/ead]] service''
  
 
== count ==
 
== count ==
Line 37: Line 39:
  
 
= Response parameters =
 
= Response parameters =
The response contains a list of the descriptions where the requested search-term(s) was/were found.
+
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 48: Line 50:
 
     {
 
     {
 
       "id": "string",
 
       "id": "string",
       "fondsUnitTitle": "string",
+
       "findingAidTitle": "string",
       "fondsUnitId": "string",
+
       "findingAidNo": "string",
 
       "repository": "string",
 
       "repository": "string",
 
       "country": "string",
 
       "country": "string",
Line 74: Line 76:
 
</pre>
 
</pre>
  
Basic Response example (for identifier: C85437490):
+
== Basic Response example ==
<pre>
+
For identifier C376209320:
 +
<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": 22,
 
   "startIndex": 0,
 
   "startIndex": 0,
   "totalPages": 1,
+
   "totalPages": 5,
 
   "results": [
 
   "results": [
 
     {
 
     {
       "id": "C85437491",
+
       "id": "C376209321",
       "fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
+
       "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
       "fondsUnitId": "2.13.132",
+
       "findingAidNo": "2.13.132",
 
       "repository": "Nationaal Archief",
 
       "repository": "Nationaal Archief",
 
       "country": "NETHERLANDS",
 
       "country": "NETHERLANDS",
 
       "language": "",
 
       "language": "",
 
       "langMaterial": "",
 
       "langMaterial": "",
       "unitDate": "",
+
       "unitDate": "1945 - 1946",
 
       "repositoryCode": "NL-HaNA",
 
       "repositoryCode": "NL-HaNA",
 
       "hasDigitalObject": false,
 
       "hasDigitalObject": false,
 
       "numberOfDigitalObjects": 0,
 
       "numberOfDigitalObjects": 0,
 
       "numberOfDigitalObjectsInDescendents": 0,
 
       "numberOfDigitalObjectsInDescendents": 0,
       "numberOfDescendents": 64,
+
       "numberOfDescendents": 0,
 
       "docType": "Descriptive Unit",
 
       "docType": "Descriptive Unit",
 
       "docTypeId": "du",
 
       "docTypeId": "du",
 
       "level": "clevel",
 
       "level": "clevel",
 
       "indexDate": "",
 
       "indexDate": "",
       "unitId": "2.13.132 - A.5.1",
+
       "unitId": "2.13.132 - 4700",
       "unitTitle": "Militaire Luchtvaart in Nederlands-Indië",
+
       "unitTitle": "Stukken betreffende twee luitenanten-vlieger die ongeoorloofd het 5th Replacement Depot te Manilla en het krijgsgevangenkamp te Pakan Baroe (Sumatra) hebben verlaten en zich hebben gemeld in Australië voor de ML.",
 
       "scopeContent": "",
 
       "scopeContent": "",
 
       "siblingPosition": 0,
 
       "siblingPosition": 0,
Line 106: Line 109:
 
     },
 
     },
 
     {
 
     {
       "id": "C85437556",
+
       "id": "C376209322",
       "fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
+
       "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
       "fondsUnitId": "2.13.132",
+
       "findingAidNo": "2.13.132",
 
       "repository": "Nationaal Archief",
 
       "repository": "Nationaal Archief",
 
       "country": "NETHERLANDS",
 
       "country": "NETHERLANDS",
 
       "language": "",
 
       "language": "",
 
       "langMaterial": "",
 
       "langMaterial": "",
       "unitDate": "",
+
       "unitDate": "1945 - 1947",
 
       "repositoryCode": "NL-HaNA",
 
       "repositoryCode": "NL-HaNA",
 
       "hasDigitalObject": false,
 
       "hasDigitalObject": false,
 
       "numberOfDigitalObjects": 0,
 
       "numberOfDigitalObjects": 0,
 
       "numberOfDigitalObjectsInDescendents": 0,
 
       "numberOfDigitalObjectsInDescendents": 0,
       "numberOfDescendents": 53,
+
       "numberOfDescendents": 0,
 
       "docType": "Descriptive Unit",
 
       "docType": "Descriptive Unit",
 
       "docTypeId": "du",
 
       "docTypeId": "du",
 
       "level": "clevel",
 
       "level": "clevel",
 
       "indexDate": "",
 
       "indexDate": "",
       "unitId": "2.13.132 - A.5.2",
+
       "unitId": "2.13.132 - 4701",
       "unitTitle": "Geallieerde Commando's",
+
       "unitTitle": "Opgave van hoofdofficieren welke in aanmerking komen voor ontslag uit de militaire dienst, een bezettingsopgave van hogere functies bij de ML en een nota inzake het voorleggen van grieven aan officieren van het hoofdkwartier door klagers buiten medeweten van hun onmiddellijke chefs.",
 
       "scopeContent": "",
 
       "scopeContent": "",
 
       "siblingPosition": 1,
 
       "siblingPosition": 1,
Line 130: Line 133:
 
     },
 
     },
 
     {
 
     {
       "id": "C85437610",
+
       "id": "C376209323",
       "fondsUnitTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
+
       "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
       "fondsUnitId": "2.13.132",
+
       "findingAidNo": "2.13.132",
 
       "repository": "Nationaal Archief",
 
       "repository": "Nationaal Archief",
 
       "country": "NETHERLANDS",
 
       "country": "NETHERLANDS",
 
       "language": "",
 
       "language": "",
 
       "langMaterial": "",
 
       "langMaterial": "",
       "unitDate": "",
+
       "unitDate": "1946",
 
       "repositoryCode": "NL-HaNA",
 
       "repositoryCode": "NL-HaNA",
 
       "hasDigitalObject": false,
 
       "hasDigitalObject": false,
 
       "numberOfDigitalObjects": 0,
 
       "numberOfDigitalObjects": 0,
 
       "numberOfDigitalObjectsInDescendents": 0,
 
       "numberOfDigitalObjectsInDescendents": 0,
       "numberOfDescendents": 40,
+
       "numberOfDescendents": 0,
 
       "docType": "Descriptive Unit",
 
       "docType": "Descriptive Unit",
 
       "docTypeId": "du",
 
       "docTypeId": "du",
 
       "level": "clevel",
 
       "level": "clevel",
 
       "indexDate": "",
 
       "indexDate": "",
       "unitId": "2.13.132 - A.5.3",
+
       "unitId": "2.13.132 - 4702",
       "unitTitle": "Geallieerde landen",
+
       "unitTitle": "Bezwaarschrift van een kapitein, tewerkgesteld als hoofd Welfare ML, over het functioneren van deze dienst alsmede klachten over de voormalige commandant 6 Vliegbasis rond de caputilatie, maart 1942.",
 
       "scopeContent": "",
 
       "scopeContent": "",
 
       "siblingPosition": 2,
 
       "siblingPosition": 2,
 +
      "ancestorLevel": 3
 +
    },
 +
    {
 +
      "id": "C376209324",
 +
      "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
 +
      "findingAidNo": "2.13.132",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "1946",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 +
      "docType": "Descriptive Unit",
 +
      "docTypeId": "du",
 +
      "level": "clevel",
 +
      "indexDate": "",
 +
      "unitId": "2.13.132 - 4703",
 +
      "unitTitle": "Opgave van het aantal deelgenomen oorlogsmissies door het marinepersoneel.",
 +
      "scopeContent": "",
 +
      "siblingPosition": 3,
 +
      "ancestorLevel": 3
 +
    },
 +
    {
 +
      "id": "C376209325",
 +
      "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
 +
      "findingAidNo": "2.13.132",
 +
      "repository": "Nationaal Archief",
 +
      "country": "NETHERLANDS",
 +
      "language": "",
 +
      "langMaterial": "",
 +
      "unitDate": "1946",
 +
      "repositoryCode": "NL-HaNA",
 +
      "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 +
      "docType": "Descriptive Unit",
 +
      "docTypeId": "du",
 +
      "level": "clevel",
 +
      "indexDate": "",
 +
      "unitId": "2.13.132 - 4704",
 +
      "unitTitle": "Rapport van een ongeoorloofd bezoek van een inlichtingenofficier van het Detachement ML Kemajoran aan Djokja met een C-47 Dakota transportvliegtuig van de RAF.",
 +
      "scopeContent": "",
 +
      "siblingPosition": 4,
 
       "ancestorLevel": 3
 
       "ancestorLevel": 3
 
     }
 
     }
Line 167: Line 218:
  
 
== results ==
 
== 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".
+
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 173: Line 224:
 
| Internal APE identifier of the result
 
| Internal APE identifier of the result
 
|-
 
|-
| fondsUnitTitle
+
| findingAidTitle
| Title of the finding aid
+
| Title of the finding aid, holdings guide or source guide
 
|-
 
|-
| fondsUnitId
+
| findingAidNo
 
| Identifier of the fonds provided by the repository
 
| Identifier of the fonds provided by the repository
 
|-
 
|-
Line 183: Line 234:
 
|-
 
|-
 
| country  
 
| country  
| Name of the country where the repository is. In English
+
| Name of the country where the repository is, in English
 
|-
 
|-
 
| language  
 
| language  
Line 195: Line 246:
 
|-
 
|-
 
| repositoryCode  
 
| 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]
+
| 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 261:
 
|-
 
|-
 
| docType  
 
| docType  
| Type of archives describing document where the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit"
+
| 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 archives document ("fa" for "Finding Aid", "hg" for "Holdings Guide", "sg" for "Source Guide" or "du" for "Descriptive unit"
+
| 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

Latest revision as of 15:42, 30 August 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, holdings guide or source guide.



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 = C376209320

{
  "count": "5",
  "startIndex": 0
}

On [base_url]/search/ead/C376209320/children, it gives all the clevel descriptive units one level deeper in the hierarchy of the descriptive unit identified with "C376209320".

N.B.: you can find the (internal APE) identifier of a descriptive unit (always starting with a "C") which is necessary for using this service via the /search/ead service

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",
      "findingAidTitle": "string",
      "findingAidNo": "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 C376209320:

{
  "totalResults": 22,
  "startIndex": 0,
  "totalPages": 5,
  "results": [
    {
      "id": "C376209321",
      "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
      "findingAidNo": "2.13.132",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1945 - 1946",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.13.132 - 4700",
      "unitTitle": "Stukken betreffende twee luitenanten-vlieger die ongeoorloofd het 5th Replacement Depot te Manilla en het krijgsgevangenkamp te Pakan Baroe (Sumatra) hebben verlaten en zich hebben gemeld in Australië voor de ML.",
      "scopeContent": "",
      "siblingPosition": 0,
      "ancestorLevel": 3
    },
    {
      "id": "C376209322",
      "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
      "findingAidNo": "2.13.132",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1945 - 1947",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.13.132 - 4701",
      "unitTitle": "Opgave van hoofdofficieren welke in aanmerking komen voor ontslag uit de militaire dienst, een bezettingsopgave van hogere functies bij de ML en een nota inzake het voorleggen van grieven aan officieren van het hoofdkwartier door klagers buiten medeweten van hun onmiddellijke chefs.",
      "scopeContent": "",
      "siblingPosition": 1,
      "ancestorLevel": 3
    },
    {
      "id": "C376209323",
      "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
      "findingAidNo": "2.13.132",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1946",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.13.132 - 4702",
      "unitTitle": "Bezwaarschrift van een kapitein, tewerkgesteld als hoofd Welfare ML, over het functioneren van deze dienst alsmede klachten over de voormalige commandant 6 Vliegbasis rond de caputilatie, maart 1942.",
      "scopeContent": "",
      "siblingPosition": 2,
      "ancestorLevel": 3
    },
    {
      "id": "C376209324",
      "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
      "findingAidNo": "2.13.132",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1946",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.13.132 - 4703",
      "unitTitle": "Opgave van het aantal deelgenomen oorlogsmissies door het marinepersoneel.",
      "scopeContent": "",
      "siblingPosition": 3,
      "ancestorLevel": 3
    },
    {
      "id": "C376209325",
      "findingAidTitle": "Inventaris van de collectie archieven Strijdkrachten in Nederlands-Indië, (1938 - 1939) 1941 - 1957 [1960]",
      "findingAidNo": "2.13.132",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1946",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.13.132 - 4704",
      "unitTitle": "Rapport van een ongeoorloofd bezoek van een inlichtingenofficier van het Detachement ML Kemajoran aan Djokja met een C-47 Dakota transportvliegtuig van de RAF.",
      "scopeContent": "",
      "siblingPosition": 4,
      "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
findingAidTitle Title of the finding aid, holdings guide or source guide
findingAidNo 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