searchEadDescendantsWithAncestors

From Archives Portal Europe Wiki
Revision as of 15:48, 9 January 2018 by Admin (Talk | contribs) (→‎Basic Response example)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Request url: https://www.archivesportaleurope.net/ApeApi/#!/search/getDescendantsWithAncestors. This service is a POST-request.

This search-service is a combination of the /search/ead/{id}/descendants service and the /hierarchy/ead/{id}/ancestors service. This service provides the results on a specific search term in all descendants of a given id, including an ancestorslist per result.



Request parameters

Several request parameters can be used to do a search for a finding aid and a finding aid plus descriptive unit.

Empty Request example

ID = .....

{
  "count": "5",
  "startIndex": 0,
  "query": "*",
  "filters": [
    {
      "facetFieldName": "string",
      "facetFieldIds": [
        "string"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "string",
      "dateFieldId": "string"
    }
  ],
  "sortRequest": {
    "sortType": "asc",
    "fields": [
      "string"
    ]
  }
}

Basic Request example

ID = F1045936

{
  "count": "5",
  "startIndex": 0,
  "query": "*",
  "filters": [
    {
      "facetFieldName": "string",
      "facetFieldIds": [
        "string"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "string",
      "dateFieldId": "string"
    }
  ],
  "sortRequest": {
    "sortType": "asc",
    "fields": [
      "string"
    ]
  }
}

On [base_url]/search/ead/F1045936/descendantsWithAncestors, it gives all the clevel descriptive units of the finding aid with "F1045936", that contain the search term "nepal", including their ancestorslist.

N.B.: you can find the (internal APE) identifier of a finding aid (always starting with a "F") 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.

query

Containing the search term(s). Required.

filters

Request parameter "filters" enables you to filter the result on facets. The facets are summarised in searchEad#facets.

dateFilters

Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in searchEad#date_facets

sortRequest

Request parameters "sortRequest" enables you to sort the result. The sortRequest contains two parameters: sortType and fields.

In "fields", you can provide a list of 1 or more fields. The resultlist is ordered on field[0] first, field[1] secondly, etc. The possible fields are:

  • date: date of the archival material, provided in <unitdate>
  • findingAidNo: number of the finding aid, provided by the repository in <eadid>
  • title: description of the archival material, provided in <unittitle>
  • referenceCode: identifier of the archival material, provided by the repository in <unitid>

In all situations you can sort ascending or descending by setting request parameter "sortType" "asc" or "desc" respectively.

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",
      "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",
      "unitTitleWithHighlighting": "string",
      "scopeContent": "string",
      "scopeContentWithHighlighting": "string",
      "numberOfAncestors": 0,
      "ancestors": [
        {
          "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
        }
      ]
    }
  ],
  "sortFields": [
    "string"
  ],
  "facetFields": {
    "country": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "subject": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "repository": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "docType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "level": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "hasDigitalObject": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "digitalObjectType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "unitDateType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "toDate": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ]
  }
}

Basic Response example

Response for the basic request example above: 

{
  "totalResults": 6063,
  "startIndex": 0,
  "totalPages": 1213,
  "eadSearchResults": [
    {
      "id": "C372722800",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "dut",
      "unitDate": "1914",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "Mon Jan 01 00:54:33 UTC 2018",
      "unitId": "2.19.225 - 1",
      "unitTitle": "Oprichtingsstatuten, kopie",
      "unitTitleWithHighlighting": null,
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 3,
      "ancestors": [
        {
          "id": "F1045936",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914-2011",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 6063,
          "docType": "Finding Aid",
          "docTypeId": "fa",
          "level": "archdesc",
          "indexDate": "",
          "unitId": "2.19.225",
          "unitTitle": "Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers",
          "scopeContent": "De archieven hebben betrekking op de activiteiten van de archiefvormers ten aanzien van het voorkomen en bestrijden van seksueel overdraagbare aandoeningen, waaronder hiv en aids. De archiefvormers deden (en doen) dat door middel van het ondersteunen van organisaties van mensen met hiv, door voorlichtings-, bewustwordings- en wervingscampagnes, door individuele hulp voor mensen met hiv, door ondersteuning van professionals in de zorg, door eigen onderzoek, door het verlenen van financiële bijdragen aan wetenschappelijk onderzoek en aan initiatieven van organisaties met dezelfde doelstellingen in Nederland, in Midden- en Oost Europa, in Azië, In Noord- en Zuid-Amerika en vooral in Afrika.",
          "siblingPosition": 0,
          "ancestorLevel": 0
        },
        {
          "id": "C372722798",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 4017,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A",
          "unitTitle": "Archieven",
          "scopeContent": "",
          "siblingPosition": 1,
          "ancestorLevel": 1
        },
        {
          "id": "C372722799",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914 - 1973",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 11,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A.1",
          "unitTitle": "De Nederlandsche Vereeniging tot Bestrijding der Geslachtsziekten, 1914 - 1973",
          "scopeContent": "",
          "siblingPosition": 0,
          "ancestorLevel": 2
        }
      ]
    },
    {
      "id": "C372722801",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "dut",
      "unitDate": "1933 - 1953",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "Mon Jan 01 00:54:33 UTC 2018",
      "unitId": "2.19.225 - 5198",
      "unitTitle": "Notulen van vergaderingen, correspondentie en andere stukken",
      "unitTitleWithHighlighting": null,
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 3,
      "ancestors": [
        {
          "id": "F1045936",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914-2011",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 6063,
          "docType": "Finding Aid",
          "docTypeId": "fa",
          "level": "archdesc",
          "indexDate": "",
          "unitId": "2.19.225",
          "unitTitle": "Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers",
          "scopeContent": "De archieven hebben betrekking op de activiteiten van de archiefvormers ten aanzien van het voorkomen en bestrijden van seksueel overdraagbare aandoeningen, waaronder hiv en aids. De archiefvormers deden (en doen) dat door middel van het ondersteunen van organisaties van mensen met hiv, door voorlichtings-, bewustwordings- en wervingscampagnes, door individuele hulp voor mensen met hiv, door ondersteuning van professionals in de zorg, door eigen onderzoek, door het verlenen van financiële bijdragen aan wetenschappelijk onderzoek en aan initiatieven van organisaties met dezelfde doelstellingen in Nederland, in Midden- en Oost Europa, in Azië, In Noord- en Zuid-Amerika en vooral in Afrika.",
          "siblingPosition": 0,
          "ancestorLevel": 0
        },
        {
          "id": "C372722798",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 4017,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A",
          "unitTitle": "Archieven",
          "scopeContent": "",
          "siblingPosition": 1,
          "ancestorLevel": 1
        },
        {
          "id": "C372722799",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914 - 1973",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 11,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A.1",
          "unitTitle": "De Nederlandsche Vereeniging tot Bestrijding der Geslachtsziekten, 1914 - 1973",
          "scopeContent": "",
          "siblingPosition": 0,
          "ancestorLevel": 2
        }
      ]
    },
    {
      "id": "C372722802",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "dut",
      "unitDate": "1938 - 1973",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "Mon Jan 01 00:54:33 UTC 2018",
      "unitId": "2.19.225 - 2",
      "unitTitle": "Balansen, begrotingen en jaarrekeningen",
      "unitTitleWithHighlighting": null,
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 3,
      "ancestors": [
        {
          "id": "F1045936",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914-2011",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 6063,
          "docType": "Finding Aid",
          "docTypeId": "fa",
          "level": "archdesc",
          "indexDate": "",
          "unitId": "2.19.225",
          "unitTitle": "Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers",
          "scopeContent": "De archieven hebben betrekking op de activiteiten van de archiefvormers ten aanzien van het voorkomen en bestrijden van seksueel overdraagbare aandoeningen, waaronder hiv en aids. De archiefvormers deden (en doen) dat door middel van het ondersteunen van organisaties van mensen met hiv, door voorlichtings-, bewustwordings- en wervingscampagnes, door individuele hulp voor mensen met hiv, door ondersteuning van professionals in de zorg, door eigen onderzoek, door het verlenen van financiële bijdragen aan wetenschappelijk onderzoek en aan initiatieven van organisaties met dezelfde doelstellingen in Nederland, in Midden- en Oost Europa, in Azië, In Noord- en Zuid-Amerika en vooral in Afrika.",
          "siblingPosition": 0,
          "ancestorLevel": 0
        },
        {
          "id": "C372722798",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 4017,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A",
          "unitTitle": "Archieven",
          "scopeContent": "",
          "siblingPosition": 1,
          "ancestorLevel": 1
        },
        {
          "id": "C372722799",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914 - 1973",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 11,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A.1",
          "unitTitle": "De Nederlandsche Vereeniging tot Bestrijding der Geslachtsziekten, 1914 - 1973",
          "scopeContent": "",
          "siblingPosition": 0,
          "ancestorLevel": 2
        }
      ]
    },
    {
      "id": "C372722803",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "dut",
      "unitDate": "ca.1940 - 1970",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "Mon Jan 01 00:54:33 UTC 2018",
      "unitId": "2.19.225 - 3",
      "unitTitle": "Ledenlijsten",
      "unitTitleWithHighlighting": null,
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 3,
      "ancestors": [
        {
          "id": "F1045936",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914-2011",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 6063,
          "docType": "Finding Aid",
          "docTypeId": "fa",
          "level": "archdesc",
          "indexDate": "",
          "unitId": "2.19.225",
          "unitTitle": "Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers",
          "scopeContent": "De archieven hebben betrekking op de activiteiten van de archiefvormers ten aanzien van het voorkomen en bestrijden van seksueel overdraagbare aandoeningen, waaronder hiv en aids. De archiefvormers deden (en doen) dat door middel van het ondersteunen van organisaties van mensen met hiv, door voorlichtings-, bewustwordings- en wervingscampagnes, door individuele hulp voor mensen met hiv, door ondersteuning van professionals in de zorg, door eigen onderzoek, door het verlenen van financiële bijdragen aan wetenschappelijk onderzoek en aan initiatieven van organisaties met dezelfde doelstellingen in Nederland, in Midden- en Oost Europa, in Azië, In Noord- en Zuid-Amerika en vooral in Afrika.",
          "siblingPosition": 0,
          "ancestorLevel": 0
        },
        {
          "id": "C372722798",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 4017,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A",
          "unitTitle": "Archieven",
          "scopeContent": "",
          "siblingPosition": 1,
          "ancestorLevel": 1
        },
        {
          "id": "C372722799",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914 - 1973",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 11,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A.1",
          "unitTitle": "De Nederlandsche Vereeniging tot Bestrijding der Geslachtsziekten, 1914 - 1973",
          "scopeContent": "",
          "siblingPosition": 0,
          "ancestorLevel": 2
        }
      ]
    },
    {
      "id": "C372722804",
      "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
      "findingAidNo": "2.19.225",
      "repository": "Nationaal Archief",
      "country": "NETHERLANDS",
      "language": "",
      "langMaterial": "dut",
      "unitDate": "1944 - 1972",
      "repositoryCode": "NL-HaNA",
      "hasDigitalObject": false,
      "numberOfDigitalObjects": 0,
      "numberOfDigitalObjectsInDescendents": 0,
      "numberOfDescendents": 0,
      "docType": "Descriptive Unit",
      "docTypeId": "du",
      "level": "clevel",
      "indexDate": "Mon Jan 01 00:54:33 UTC 2018",
      "unitId": "2.19.225 - 4",
      "unitTitle": "Notulen van vergaderingen van het dagelijks bestuur",
      "unitTitleWithHighlighting": null,
      "scopeContent": "",
      "scopeContentWithHighlighting": null,
      "numberOfAncestors": 3,
      "ancestors": [
        {
          "id": "F1045936",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914-2011",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 6063,
          "docType": "Finding Aid",
          "docTypeId": "fa",
          "level": "archdesc",
          "indexDate": "",
          "unitId": "2.19.225",
          "unitTitle": "Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers",
          "scopeContent": "De archieven hebben betrekking op de activiteiten van de archiefvormers ten aanzien van het voorkomen en bestrijden van seksueel overdraagbare aandoeningen, waaronder hiv en aids. De archiefvormers deden (en doen) dat door middel van het ondersteunen van organisaties van mensen met hiv, door voorlichtings-, bewustwordings- en wervingscampagnes, door individuele hulp voor mensen met hiv, door ondersteuning van professionals in de zorg, door eigen onderzoek, door het verlenen van financiële bijdragen aan wetenschappelijk onderzoek en aan initiatieven van organisaties met dezelfde doelstellingen in Nederland, in Midden- en Oost Europa, in Azië, In Noord- en Zuid-Amerika en vooral in Afrika.",
          "siblingPosition": 0,
          "ancestorLevel": 0
        },
        {
          "id": "C372722798",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 4017,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A",
          "unitTitle": "Archieven",
          "scopeContent": "",
          "siblingPosition": 1,
          "ancestorLevel": 1
        },
        {
          "id": "C372722799",
          "findingAidTitle": "Inventaris van de archieven van de Stichting Aids Fonds - Soa Aids Nederland, de Stichting STOP AIDS NOW! en de Stichting Werkmaatschappij Soa Aids en hun taakvoorgangers, 1914- 2008 (2011)",
          "findingAidNo": "2.19.225",
          "repository": "Nationaal Archief",
          "country": "NETHERLANDS",
          "language": "",
          "langMaterial": "",
          "unitDate": "1914 - 1973",
          "repositoryCode": "NL-HaNA",
          "hasDigitalObject": false,
          "numberOfDigitalObjects": 0,
          "numberOfDigitalObjectsInDescendents": 0,
          "numberOfDescendents": 11,
          "docType": "Descriptive Unit",
          "docTypeId": "du",
          "level": "clevel",
          "indexDate": "",
          "unitId": "2.19.225 - A.1",
          "unitTitle": "De Nederlandsche Vereeniging tot Bestrijding der Geslachtsziekten, 1914 - 1973",
          "scopeContent": "",
          "siblingPosition": 0,
          "ancestorLevel": 2
        }
      ]
    }
  ],
  "sortFields": [
    "date",
    "findingAidNo",
    "orderId",
    "title",
    "referenceCode"
  ],
  "facetFields": {
    "country": [
      {
        "id": "7",
        "name": "NETHERLANDS",
        "frequency": 6063
      }
    ],
    "subject": [],
    "repository": [
      {
        "id": "2437",
        "name": "Nationaal Archief",
        "frequency": 6063
      }
    ],
    "docType": [
      {
        "id": "fa",
        "name": "fa",
        "frequency": 6063
      }
    ],
    "level": [
      {
        "id": "clevel",
        "name": "clevel",
        "frequency": 6063
      }
    ],
    "hasDigitalObject": [
      {
        "id": "false",
        "name": "false",
        "frequency": 6063
      }
    ],
    "digitalObjectType": [],
    "unitDateType": [
      {
        "id": "normal",
        "name": "normal",
        "frequency": 4718
      },
      {
        "id": "nodate",
        "name": "nodate",
        "frequency": 907
      },
      {
        "id": "otherdate",
        "name": "otherdate",
        "frequency": 438
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "1800-01-01_2",
        "name": "1800-1999",
        "frequency": 3209
      },
      {
        "id": "2000-01-01_2",
        "name": "2000-2199",
        "frequency": 1509
      }
    ],
    "toDate": [
      {
        "id": "1800-01-01_2",
        "name": "1800-1999",
        "frequency": 2973
      },
      {
        "id": "2000-01-01_2",
        "name": "2000-2199",
        "frequency": 1745
      }
    ]
  }
}

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
findingAidTitle Title of the finding aid
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 (only for the search result)
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
parentId Internal APE Identifier of the parent of the result
unitTitle Description of the result
unitTitleWithHighlighting Description of the result, with the mark "<em>" to emphasise 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 emphasise 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
  • title
  • referenceCode

facetFields

This response parameter gives an enumeration of facets. Every facet has three variables.

id Internal APE identifier of the value; use this "id" in the filter request parameter
name Human readable value (in English)
frequency The number of results of this facet containing the search term

facets

country Name of the country where the repository is, in English
subject Subject that is added to the archival description
repository Name of the repository holding the fonds
docType Type of document in which 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
hasDigitalObject TRUE/FALSE
digitalObjectType Type of the Object: most of the time: IMAGE
unitDateType Type of date describing the archival unit

date facets

With the date facets you can zoom in on the period of time. Results are grouped in periods of two centuries in the first step. If you use these groupings in the request-parameter dateFilter, you'll have new dateFacets that groups the results into groups of two decades

fromDate Grouping of the search result in starting dates
toDate Grouping of the search result in ending dates
Retrieved from "https://wiki-deprecated.archivesportaleurope.net/index.php?title=searchEadDescendantsWithAncestors&oldid=1785"