hierarchyEadAncestors - Revision history

Admin at 14:44, 30 August 2017

2017-08-30T14:44:15Z

Admin at 12:26, 6 June 2017

2017-06-06T12:26:46Z

Admin: /* Response parameters */

2017-06-05T12:38:58Z

‎Response parameters

Admin at 12:38, 5 June 2017

2017-06-05T12:38:19Z

Show changes

Admin at 12:28, 8 March 2017

2017-03-08T12:28:40Z

Admin: Created page with "Request url: `https://api.archivesportaleurope.net/services/hierarchy/ead/{id}/ancestors`. This service is a POST-request. This hierarchy service delivers a list o..."

2016-11-01T08:31:18Z

Created page with "Request url: <code>https://api.archivesportaleurope.net/services/hierarchy/ead/{id}/ancestors</code>. This service is a POST-request. This hierarchy service delivers a list o..."

New page

Request url: <code>https://api.archivesportaleurope.net/services/hierarchy/ead/{id}/ancestors</code>.
This service is a POST-request.

This hierarchy service delivers a list of all archival descriptions in the path from root to {id} in the hierarchy of the archival description. A web developer can use this service to create a tree-like presentation of a finding aid.

<div><br/>__TOC__<br/></div>
= Request parameters =
Two request parameters can be used to do a search in archival descriptions.

eg.

<pre>
{
"count": "5",
"startIndex": 0
}
</pre>

On [base_url]/hierarchy/ead/{id}/ancestors, it gives all the clevel descriptive units of finding aid identified with "{id}" that are on the path from {id} to the root of the hierarchy of the finding aid.

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

eg.
<pre>
{
"totalResults": 0,
"startIndex": 0,
"totalPages": 0,
"ancestors": [
{
"id": "string",
"fondsUnitTitle": "string",
"fondsUnitId": "string",
"repository": "string",
"country": "string",
"language": "string",
"langMaterial": "string",
"unitDate": "string",
"repositoryCode": "string",
"hasDigitalObject": false,
"docType": "string",
"docTypeId": "string",
"level": "string",
"indexDate": "string",
"unitId": "string",
"unitTitle": "string",
"scopeContent": "string",
"siblingPosition": "string",
"treeDepth": "string"
}
}
</pre>

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

== ancestors ==
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"
| id
| Internal APE identifier of the result
|-
| unitId
| Identifier of the result provided by the repository
|-
| unitTitle
| Description of the result
|-
| unitTitleWithHighlighting
| Description of the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request.
|-
| unitDate
| Date of creation of the result.
|-
| scopeContent
| More descriptive information about the result.
|-
| 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
| TRUE/FALSE
|-
| langMaterial
| Language in which the result is created.
|-
| language
| Language of the description of the result.
|-
| docType
| Type of archives describing document where the result is found : "Finding Aid", "Holdings Guide", "Source Guide" or "Descriptive Unit".
|-
| level
| Type of result: "archdesc" for highest level description or "clevel" for subordinate components
|-
| fondsUnitId
| Identifier of the fonds provided by the repository.
|-
| fondsUnitTitle
| Title of the finding aid.
|-
| repository
| Name of the repository holding the fonds
|-
| 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].
|-
| country
| Name of the country where the repository is. In English.
|}

[[Category:Technical_documentation]]

@@ Line 10: / Line 10: @@
 On [base_url]/hierarchy/ead/{id}/ancestors, all the clevel descriptive units that are on the path from {id} to the root in the hierarchy of a finding aid, holdings guide or source guide are given.
-<br/><br/>
 = Response parameters =
@@ Line 24: / Line 25: @@
+     {
        "id": "string",
-       "fondsUnitTitle": "string",
+       "findingAidTitle": "string",
-       "fondsUnitId": "string",
+       "findingAidNo": "string",
        "repository": "string",
        "country": "string",
@@ Line 51: / Line 52: @@
 == Basic Response example ==
-For identifier C85437490:
+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;">
+{
@@ Line 59: / Line 60: @@
    "results": [
+     {
-       "id": "F379211",
+       "id": "F1049165",
-       "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",
        "country": "NETHERLANDS",
@@ Line 83: / Line 84: @@
      },
+     {
-       "id": "C85435671",
+       "id": "C376208583",
-       "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",
        "country": "NETHERLANDS",
@@ Line 94: / Line 95: @@
        "hasDigitalObject": false,
        "numberOfDigitalObjects": 0,
-       "numberOfDigitalObjectsInDescendents": 23297,
+       "numberOfDigitalObjectsInDescendents": 0,
-       "numberOfDescendents": 4525,
+       "numberOfDescendents": 831,
        "docType": "Descriptive Unit",
        "docTypeId": "du",
        "level": "clevel",
        "indexDate": "",
-       "unitId": "2.13.132 - A",
+       "unitId": "2.13.132 - B",
-       "unitTitle": "Beleidsterrein Operatiën",
+       "unitTitle": "Beleidsterrein Personeel",
        "scopeContent": "",
-       "siblingPosition": 1,
+       "siblingPosition": 2,
        "ancestorLevel": 1
+     }
@@ Line 126: / Line 127: @@
 | Internal APE identifier of the result
 |-
-| fondsUnitTitle
+| findingAidTitle
 | Title of the finding aid, holdings guide or source guide
 |-
-| fondsUnitId
+| findingAidUnitId
 | Identifier of the fonds provided by the repository
 |-

@@ Line 2: / Line 2: @@
 This service is a POST-request.
-This hierarchy service delivers a list of all archival descriptions in the path from root to {id} in the hierarchy of the archival description. 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 in the path from root to {id} of an archival description in the hierarchy of finding aid, a holdings guide or a source guide. A web developer can use this service to create a tree-like presentation of a finding aid, holdings guide or source guide.
@@ Line 9: / Line 9: @@
 Only one request parameter is required: the internal APE identifier of the descriptive unit for which a list of higher level ancestors is needed.
-On [base_url]/hierarchy/ead/{id}/ancestors, all the clevel descriptive units of that are on the path from {id} to the root of the hierarchy of the finding aid are given.
+On [base_url]/hierarchy/ead/{id}/ancestors, all the clevel descriptive units that are on the path from {id} to the root in the hierarchy of a finding aid, holdings guide or source guide are given.
 <br/><br/>
 = Response parameters =
-The response contains a list of the descriptions that were found from the descriptive unit for which an identifier was provided up till the root of the finding aid.
+The response contains a list of the descriptions that were found, from the descriptive unit for which an identifier was provided up till the root of the finding aid, holding guide or source guide.
-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,
@@ Line 50: / Line 50: @@
 </pre>
-Basic Response example (for identifier: C85437490):
+== Basic Response example ==
 <pre style="white-space:-moz-pre-wrap; white-space:-pre-wrap; white-space:-o-pre-wrap; white-space:pre-wrap; word-wrap:break-word;">
+{
@@ Line 119: / Line 120: @@
 == 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"
@@ Line 126: / Line 127: @@
 |-
 | fondsUnitTitle
-| Title of the finding aid
+| Title of the finding aid, holdings guide or source guide
 |-
 | fondsUnitId
@@ Line 135: / Line 136: @@
 |-
 | country
-| Name of the country where the repository is. In English
+| Name of the country where the repository is, in English
 |-
 | language
@@ Line 144: / Line 145: @@
 |-
 | unitDate
-| Date of creation of the result.
+| Date of creation of the result
 |-
 | 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
@@ Line 162: / Line 163: @@
 |-
 | 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
-| 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

@@ Line 51: / Line 51: @@
 Basic Response example (for identifier: C85437490):
-<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": 2,

← Older revision		Revision as of 12:28, 8 March 2017
Line 1:		Line 1:
−	Request url: <code>https://api.archivesportaleurope.net/services/hierarchy/ead/{id}/ancestors</code>.	+	Request url: [https://www.archivesportaleurope.net/ApeApi/#!/hierarchy/getAncestors <code>https://api.archivesportaleurope.net/services/hierarchy/ead/{id}/ancestors</code>].
	This service is a POST-request.		This service is a POST-request.