Difference between revisions of "hierarchyEadChildren"

From Archives Portal Europe Wiki
Jump to: navigation, search
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.
  
−
eg.
+
Empty Request example:
−
 
+
 
<pre>
 
<pre>
 +
ID = .....
 +
 
{
 
{
 
   "count": "5",
 
   "count": "5",
Line 17: Line 18:
 
</pre>
 
</pre>
  
−
On [base_url]/search/ead/F9816/descendants, it gives all the clevel descriptive units of finding aid identified with "F9816", that contain the searchterm "nepal".
+
Basic Request example:
 +
<pre>
 +
ID = C85437490
 +
 
 +
{
 +
  "count": "5",
 +
  "startIndex": 0
 +
}
 +
</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".
  
 
== count ==
 
== count ==
Line 24: Line 34:
 
== startIndex ==
 
== 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.
 
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.
 +
<br/><br/>
  
 
= 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 descriptions where the requested search-term(s) was/were found.
  
−
eg.
+
Empty Response example:
 
<pre>
 
<pre>
 
{
 
{
Line 34: Line 45:
 
   "startIndex": 0,
 
   "startIndex": 0,
 
   "totalPages": 0,
 
   "totalPages": 0,
−
   "children": [
+
   "results": [
 
     {
 
     {
 
       "id": "string",
 
       "id": "string",
Line 46: Line 57:
 
       "repositoryCode": "string",
 
       "repositoryCode": "string",
 
       "hasDigitalObject": false,
 
       "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 
       "docType": "string",
 
       "docType": "string",
 
       "docTypeId": "string",
 
       "docTypeId": "string",
Line 53: Line 67:
 
       "unitTitle": "string",
 
       "unitTitle": "string",
 
       "scopeContent": "string",
 
       "scopeContent": "string",
−
       "siblingPosition": "string",
+
       "siblingPosition": 0,
−
       "treeDepth": "string"
+
       "ancestorLevel": 0
 
     }
 
     }
 +
  ]
 +
}
 +
</pre>
 +
 +
Basic Response example (for identifier: C85437490):
 +
<pre>
 +
{
 +
  "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
 +
    }
 +
  ]
 
}
 
}
 
</pre>
 
</pre>
Line 68: Line 166:
 
The response parameter "totalPages" gives the number of chunks.
 
The response parameter "totalPages" gives the number of chunks.
  
−
== children ==
+
== 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".
  
Line 75: Line 173:
 
| Internal APE identifier of the result
 
| Internal APE identifier of the result
 
|-
 
|-
−
| unitId
+
| fondsUnitTitle
−
| Identifier of the result provided by the repository
+
| Title of the finding aid
 
|-
 
|-
−
| unitTitle
+
| fondsUnitId
−
| Description of the result
+
| Identifier of the fonds provided by the repository
 
|-
 
|-
−
| unitTitleWithHighlighting
+
| repository
−
| Description of the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request.
+
| 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  
 
| unitDate  
 
| Date of creation of the result.
 
| Date of creation of the result.
 
|-
 
|-
−
| scopeContent
+
| repositoryCode
−
| More descriptive information about the result.
+
| 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]
−
|-
+
−
| scopeContentWithHighlighting
+
−
| More descriptive information about the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request.
+
 
|-
 
|-
 
| hasDigitalObject  
 
| hasDigitalObject  
 
| TRUE/FALSE
 
| TRUE/FALSE
 
|-
 
|-
−
| langMaterial
+
| numberOfDigitalObjects
−
| Language in which the result is created.
+
| Amount of digital objects available for the search result (is always 0 in case 'hasDigitalObject' = FALSE)
 
|-
 
|-
−
| language
+
| numberOfDigitalOjectsInDescendents
−
| Language of the description of the result.
+
| 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  
 
| docType  
−
| Type of archives describing document where the result is found : "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit".
+
| Type of archives describing document where the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit"
 +
|-
 +
| 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"
 
|-
 
|-
 
| level
 
| level
 
| Type of result: "archdesc" for highest level description or "clevel" for subordinate components
 
| Type of result: "archdesc" for highest level description or "clevel" for subordinate components
 
|-
 
|-
−
| fondsUnitId
+
| indexDate
−
| Identifier of the fonds provided by the repository.
+
| Date showing when the result was ingested/updated and indexed in the Archives Portal Europe (ie last change date)
 
|-
 
|-
−
| fondsUnitTitle
+
| unitId
−
| Title of the finding aid.
+
| Identifier of the result provided by the repository
 
|-
 
|-
−
| repository
+
| unitTitle
−
| Name of the repository holding the fonds
+
| Description of the result
 
|-
 
|-
−
| repositoryCode
+
| scopeContent
−
| 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].
+
| More descriptive information about the result
 
|-
 
|-
−
| country
+
| siblingPosition
−
| Name of the country where the repository is. In English.
+
| 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 
 
|}
 
|}
  
 
[[Category:Technical_documentation]]
 
[[Category:Technical_documentation]]

Revision as of 12:32, 5 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.



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 descriptions 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 archives describing document where the result is found: "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit"
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"
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
Retrieved from "http://wiki-deprecated.archivesportaleurope.net/index.php?title=hierarchyEadChildren&oldid=1613"