hierarchyEadChildren - Revision history

Admin at 14:42, 30 August 2017

2017-08-30T14:42:57Z

Show changes

Admin at 12:34, 6 June 2017

2017-06-06T12:34:51Z

Admin at 10:46, 6 June 2017

2017-06-06T10:46:34Z

Admin at 12:32, 5 June 2017

2017-06-05T12:32:36Z

Show changes

Admin at 12:26, 8 March 2017

2017-03-08T12:26:30Z

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

2016-11-01T08:30:20Z

Created page with "Request url: <code>https://api.archivesportaleurope.net/services//hierarchy/ead/{id}/children</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}/children</code>.
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.

<div><br/>__TOC__<br/></div>
= Request parameters =
Two request parameters can be used to get a list of children of an archival description.

eg.

<pre>
{
"count": "5",
"startIndex": 0
}
</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".

== 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,
"children": [
{
"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.

== children ==
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 2: / Line 2: @@
 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>
@@ Line 8: / Line 8: @@
 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 = .....
@@ Line 18: / Line 18: @@
 </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
@@ Line 37: / Line 37: @@
 = 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,
@@ Line 74: / Line 74: @@
 </pre>
-Basic Response example (for identifier: C85437490):
+== Basic Response example ==
-<pre>
+For identifier C85437490:
+{
    "totalResults": 3,
@@ Line 167: / Line 168: @@
 == 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 183: / Line 184: @@
 |-
 | country
-| Name of the country where the repository is. In English
+| Name of the country where the repository is, in English
 |-
 | language
@@ Line 195: / Line 196: @@
 |-
 | 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 210: / Line 211: @@
 |-
 | 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

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

@@ Line 2: / Line 2: @@
 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>
@@ Line 175: / Line 175: @@
 |-
 | fondsUnitTitle
-| Title of the finding aid
+| Title of the finding aid, holdings guide or source guide
 |-
 | fondsUnitId