Difference between revisions of "searchEadChildren"

From Archives Portal Europe Wiki
Jump to: navigation, search
Line 8: Line 8:
 
Three request parameters can be used to do a search in archival descriptions.
 
Three request parameters can be used to do a search in archival descriptions.
  
−
eg.
+
Empty Request example:
−
 
+
 
<pre>
 
<pre>
 +
ID = .....
 +
 
{
 
{
 
   "count": 5,
 
   "count": 5,
 
   "startIndex": 0,
 
   "startIndex": 0,
−
   "query": "nepal"
+
   "query": "*"
 +
}
 +
</pre>
 +
 
 +
Basic Request example:
 +
<pre>
 +
ID = C85446159
 +
 
 +
{
 +
  "count": "5",
 +
  "startIndex": 0,
 +
  "query": "KNVB"
 
}
 
}
 
</pre>
 
</pre>
  
−
On [base_url]/search/ead/F9816/children, it gives all the clevel descriptive units of finding aid identified with "F9816", in hierarchy directly under F9816 that contain the searchterm "nepal".
+
On [base_url]/search/ead/C85446159/children, it gives all the clevel descriptive units of descriptive unit identified with "C85446159", in the hierarchy directly under C85446159 that contain the searchterm "KNVB".
  
 
== count ==
 
== count ==
Line 32: Line 44:
 
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>
 +
{
 +
  "totalResults": 0,
 +
  "startIndex": 0,
 +
  "totalPages": 0,
 +
  "eadSearchResults": [
 +
    {
 +
      "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",
 +
      "unitTitleWithHighlighting": "string",
 +
      "scopeContent": "string",
 +
      "scopeContentWithHighlighting": "string",
 +
      "numberOfAncestors": 0
 +
    }
 +
  ],
 +
  "sortFields": [
 +
    "string"
 +
  ]
 +
}
 +
</pre>
 +
 +
Basic Response example (ie response for the basic request example above):
 +
<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": 1,
 
   "totalResults": 1,
Line 40: Line 91:
 
   "eadSearchResults": [
 
   "eadSearchResults": [
 
     {
 
     {
−
       "id": "C5026409",
+
       "id": "C85446159",
−
       "fondsUnitTitle": "Inventaris van het code-archief van het Ministerie van Buitenlandse Zaken, 1955-1964",
+
       "fondsUnitTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
−
       "fondsUnitId": "2.05.118",
+
       "fondsUnitId": "2.19.123",
 
       "repository": "Nationaal Archief",
 
       "repository": "Nationaal Archief",
 
       "country": "NETHERLANDS",
 
       "country": "NETHERLANDS",
 
       "language": "",
 
       "language": "",
 
       "langMaterial": "",
 
       "langMaterial": "",
−
       "unitDate": "1961",
+
       "unitDate": "1947",
 
       "repositoryCode": "NL-HaNA",
 
       "repositoryCode": "NL-HaNA",
 
       "hasDigitalObject": false,
 
       "hasDigitalObject": false,
 +
      "numberOfDigitalObjects": 0,
 +
      "numberOfDigitalObjectsInDescendents": 0,
 +
      "numberOfDescendents": 0,
 
       "docType": "Descriptive Unit",
 
       "docType": "Descriptive Unit",
 
       "docTypeId": "du",
 
       "docTypeId": "du",
 
       "level": "clevel",
 
       "level": "clevel",
−
       "indexDate": "Mon Dec 07 10:18:59 UTC 2015",
+
       "indexDate": "",
−
       "unitId": "2.05.118 - 11917",
+
       "unitId": "2.19.123 - 3345",
−
       "unitTitle": "Nepal, 1961",
+
       "unitTitle": "Verslag van de vergadering van afgevaardigden van verenigingen, welke op 10 mei 1940 bij den Rotterdamschen Voetbalbond waren aangesloten, over de fusering van den Rotterdamschen Voetbalbond met de KNVB,",
−
       "unitTitleWithHighlighting": "<em>Nepal</em>, 1961",
+
       "unitTitleWithHighlighting": ", over de fusering van den Rotterdamschen Voetbalbond met de <em>KNVB</em>,",
 
       "scopeContent": "",
 
       "scopeContent": "",
−
       "scopeContentWithHighlighting": null
+
       "scopeContentWithHighlighting": null,
 +
      "numberOfAncestors": 6
 
     }
 
     }
 
   ],
 
   ],
Line 87: Line 142:
 
| 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
+
| unitTitleWithHighlighting
−
| 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].
+
| Description of the result, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request
 
|-
 
|-
−
| country
+
| scopeContent
−
| Name of the country where the repository is. In English.
+
| 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
 +
|-
 +
| numberOfAncestors
 +
| Amount of ancestors (higher levels) for the result
 
|}
 
|}
  

Revision as of 11:48, 5 June 2017

Request url: https://api.archivesportaleurope.net/services/search/ead/{id}/children. This service is a POST-request.

This search service delivers a list of archival descriptions with the requested searchterm 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 search result.



Request parameters

Three request parameters can be used to do a search in archival descriptions.

Empty Request example: 

ID = .....

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

Basic Request example: 

ID = C85446159

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

On [base_url]/search/ead/C85446159/children, it gives all the clevel descriptive units of descriptive unit identified with "C85446159", in the hierarchy directly under C85446159 that contain the searchterm "KNVB".

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.

query

Containing the searchterm(s). Required.

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,
  "eadSearchResults": [
    {
      "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",
      "unitTitleWithHighlighting": "string",
      "scopeContent": "string",
      "scopeContentWithHighlighting": "string",
      "numberOfAncestors": 0
    }
  ],
  "sortFields": [
    "string"
  ]
}

Basic Response example (ie response for the basic request example above): 

{
  "totalResults": 1,
  "startIndex": 0,
  "totalPages": 1,
  "eadSearchResults": [
    {
      "id": "C85446159",
      "fondsUnitTitle": "Inventaris van het archief van de Koninklijke Nederlandse Voetbalbond (KNVB), 1889-1996 (1997)",
      "fondsUnitId": "2.19.123",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "",
      "unitDate": "1947",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "",
      "unitId": "2.19.123 - 3345",
      "unitTitle": "Verslag van de vergadering van afgevaardigden van verenigingen, welke op 10 mei 1940 bij den Rotterdamschen Voetbalbond waren aangesloten, over de fusering van den Rotterdamschen Voetbalbond met de KNVB,",
      "unitTitleWithHighlighting": ", over de fusering van den Rotterdamschen Voetbalbond met de <em>KNVB</em>,",
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 6
    }
  ],
  "sortFields": [
    "date",
    "findingAidNo",
    "orderId",
    "title",
    "referenceCode"
  ]
}

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.

eadSearchResults

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
unitTitleWithHighlighting Description of the result, with the mark "<em>" to emphasize the search term that was used in the search request
scopeContent More descriptive information about the result
scopeContentWithHighlighting More descriptive information about the result, with the mark "<em>" to emphasize the search term that was used in the search request
numberOfAncestors Amount of ancestors (higher levels) for the result

sortFields

This response parameter sums up the various fields you can use to order the resultList in a, new, additional request (see searchEad#sortRequest):

  • date
  • findingAidNo
  • orderId
  • title
  • referenceCode
Retrieved from "https://wiki-deprecated.archivesportaleurope.net/index.php?title=searchEadChildren&oldid=1607"