searchEac

From Archives Portal Europe Wiki
Revision as of 16:56, 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://api.archivesportaleurope.net/services/search/eac-cpf. This service is a POST-request.

This search-service delivers a list of authority records for Corporate Bodies, Persons or Families (CPF) with the requested searchterm. A web developer is able to filter results on various facets.



Request parameters

Three request parameters can be used to do a search in descriptions of records creators and two types of filters can be used.

Empty Request example

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

Basic Request example

{
  "count": "5",
  "startIndex": 0,
  "query": "Inlichtingendienst",
  "filters": [
    {
      "facetFieldName": "country",
      "facetFieldIds": [
        "7"
      ]
    }
  ],
  "dateFilters": [
    {
      "dateFieldName": "fromDate",
      "dateFieldId": "1800-01-01_2"
    }
  ],
  "sortRequest": {
    "sortType": "asc",
    "fields": [
      "string"
    ]
  }
}

This example searches for archival descriptions with the term "Inlichtingendienst" and filters on the facet "country" with id = 7 (identifier for "NETHERLANDS") and date-facet "fromDate" with id = "1800-01-01_2" (identifier for the period 1800-1999).

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 searchEac#facets.

dateFilters

Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in searchEac#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 <existDates>

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,
  "eacSearchResults": [
    {
      "id": "string",
      "recordId": "string",
      "entityType": "string",
      "nameEntries": [
        "string"
      ],
      "nameEntriesWithHighlighting": [
        "string"
      ],
      "existDates": "string",
      "description": "string",
      "descriptionWithHighlighting": "string",
      "other": "string",
      "otherWithHighlighting": "string",
      "repository": "string",
      "repositoryCode": "string",
      "country": "string",
      "countryId": "string",
      "numberOfArchivalMaterialRelations": "string",
      "numberOfNameRelations": "string"
    }
  ],
  "sortFields": [
    "string"
  ],
  "facetFields": {
    "country": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "repository": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "entityType": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "place": [
      {
        "id": "string",
        "name": "string",
        "frequency": 0
      }
    ],
    "language": [
      {
        "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": 13,
  "startIndex": 0,
  "totalPages": 3,
  "eacSearchResults": [
    {
      "id": "28240",
      "recordId": "489d662d-b214-4b7a-98e2-d01b253c773f",
      "entityType": "corporatebody",
      "nameEntries": [
        "Militaire Inlichtingendienst (Defensie)",
        "Militaire Inlichtingendienst (Defensie)",
        "MID",
        "Militaire Inlichtingendienst (2)"
      ],
      "nameEntriesWithHighlighting": [
        "Militaire <em>Inlichtingendienst</em> (Defensie)"
      ],
      "existDates": "1988 - 2002",
      "description": " In 1988 ontstaan uit samenvoeging van de Marine Inlichtingendienst (MARID), de Landmacht Inlichtingendienst (LAMID) en de Luchtmacht Inlichtingendienst (LUID). Rijksoverheid De Militaire Inlichtingendienst heeft in het belang van de nationale veiligheid tot taak:  het verrichten van onderzoek omtrent het potentieel en de strijdkrachten van andere mogendheden, ten behoeve van een juiste opbouw en een doeltreffend gebruik van de krijgsmacht en naar factoren die van invloed zijn of kunnen zijn op de handha ving en bevordering van de internationale rechtsorde voor zover de krijgsmacht daarbij is betrokken of naar verwachting betrokken kan worden;  het verrichten van veiligheidsonderzoeken als bedoeld in de Wet veiligheidsonderzoeken;  het verrichten van onderzoek dat nodig is voor het treffen van maatregelen ter voorkoming van activiteiten die ten doel hebben de veiligheid of paraatheid van de krijgsmacht te schaden, ter bevordering van een juist verloop van mobilisatie en concentratie der strijdkrachten en ten behoeve van een ongestoorde voorbereiding en inzet van de krijgsmacht.  het bevorderen van maatregelen ter bescherming van de onder c genoemde belangen, waaronder begrepen maatregelen ter beveiliging van gegevens betreffende de krijgsmacht waarvan de geheimhouding is geboden;  het verrichten van onderzoek betreffende andere landen, ten aanzien van onderwerpen met een militaire relevantie die door Onze Minister-President, Minister van Algemene Zaken, in overeenstemming met Onze betrokken Ministers, zijn aangewezen;  het opstellen van dreigingsanalyses op verzoek van Onze Minister van Binnenlandse Zaken en Koninkrijksrelaties en Onze Minister van Veiligheid en Justitie gezamenlijk ten behoeve van de beveiliging van de personen, bedoeld in de artikelen 4, derde lid, onderdeel b, en 42, eerste lid, onder c, van de Politiewet 2012 en de bewaking en de beveiliging van de objecten en de diensten die zijn aangewezen op grond van artikel 16 van die wet, voor zover het betreft personen, objecten en diensten met een militaire relevantie.",
      "descriptionWithHighlighting": " In 1988 ontstaan uit samenvoeging van de Marine <em>Inlichtingendienst</em> (MARID",
      "other": " Algemene Leiding (Defensie) Militaire Inlichtingen- en Veiligheidsdienst (Defensie) Marine Inlichtingendienst (Defensie) Landmacht Inlichtingendienst (Defensie) Luchtmacht Inlichtingendienst (Defensie) Inlichtingendienst Buitenland (AZ)",
      "otherWithHighlighting": ") Marine <em>Inlichtingendienst</em> (Defensie) Landmacht <em>Inlichtingendienst</em> (Defensie",
      "repository": "Nationaal Archief",
      "repositoryCode": "NL-HaNA",
      "country": "NETHERLANDS",
      "countryId": "7",
      "numberOfArchivalMaterialRelations": "0",
      "numberOfNameRelations": "6"
    },
    {
      "id": "29750",
      "recordId": "87202313-dcba-4c9a-9497-9cb0538a1b11",
      "entityType": "corporatebody",
      "nameEntries": [
        "Inlichtingendienst Buitenland (AZ)",
        "Inlichtingendienst Buitenland (AZ)",
        "Buitenlandse Inlichtingendienst",
        "IDB"
      ],
      "nameEntriesWithHighlighting": [
        "<em>Inlichtingendienst</em> Buitenland (AZ)"
      ],
      "existDates": "1971 - 1994",
      "description": " Per 1 januari 1971 opvolger van de Buitenlandse Inlichtingendienst (BID). In eerste instantie ressorteerde deze dienst onder het Ministerie van Defensie. Per 1 september 1972 verschoof de dienst naar AZ. Per 1 januari 1994 opgeheven. Een aantal taken is vervolgens overgenomen door de BVD en MID. Rijksoverheid Het verzamelen van gegevens betreffende het buitenland die voor de staat van belang kunnen zijn.",
      "descriptionWithHighlighting": " Per 1 januari 1971 opvolger van de Buitenlandse <em>Inlichtingendienst</em> (BID",
      "other": " Algemene Leiding (AZ) Binnenlandse Veiligheidsdienst (BZK) Militaire Inlichtingendienst (Defensie)",
      "otherWithHighlighting": ") Militaire <em>Inlichtingendienst</em> (Defensie)",
      "repository": "Nationaal Archief",
      "repositoryCode": "NL-HaNA",
      "country": "NETHERLANDS",
      "countryId": "7",
      "numberOfArchivalMaterialRelations": "0",
      "numberOfNameRelations": "3"
    },
    {
      "id": "30054",
      "recordId": "167c43e5-9f95-4d35-b613-ca8eafe2b70c",
      "entityType": "corporatebody",
      "nameEntries": [
        "Landmacht Inlichtingendienst (Defensie)",
        "Landmacht Inlichtingendienst (Defensie)",
        "LAMID",
        "Militaire Inlichtingendienst (1)"
      ],
      "nameEntriesWithHighlighting": [
        "Landmacht <em>Inlichtingendienst</em> (Defensie)"
      ],
      "existDates": "1949 - 1988",
      "description": " Rijksoverheid 1949:  Het inwinnen van gegevens welke nodig zijn voor een juiste opbouw en een doeltreffend gebruik van de Koninklijke Landmacht;  De bescherming van de geheimen van de landmacht, het uitvoeren van de bewaking tegen daden van sabotage aan objecten van de landmacht, het treffen van maatregelen tegen diefstal van materieel, wapenen en munitie welke bestemd zijn voor of in gebruik zijn bij de strijdkrachten en het tijdig onderkennen van ondermijnende politieke propaganda onder het personeel van de Koninklijke Landmacht  1972, voor zover het betreft de Koninklijke Landmacht:  Het inwinnen van gegevens omtrent het potentieel en de strijdkrachten van andere mogendheden, welke nodig zijn voor een juiste opbouw en een doeltreffend gebruik van de krijgsma cht;  Het inwinnen van gegevens welke nodig zijn voor het treffen van maatregelen:  Ter voorkoming van activiteiten die ten doel hebben de veiligheid of paraatheid van de krijgsmacht te schaden;  Ter beveiliging van gegevens binnen de krijgsmacht waarvan geheimhouding geboden is;  Ter bevordering van een juist verloop van mobilisatie en concentratie der strijdkrachten.  De LAMID had ook enkele krijgsmachtbrede taken, in 1949:  het inwinnen van gegevens die nodig zijn voor:  de mobilisatie en concentratie der landstrijdkrachten en de voorbereiding daarvan, en  het uitoefenen van het Militair Gezag en het handhaven van orde en rust in geval val de staat van oorlog of de staat van beleg is ingetreden.  In 1974 werden deze krijgsmachtbrede taken zo opgesomd:  De signaleringsregeling ten aanzien van dienstplichtigen voor indeling bij één der krijgsmachtdelen;  Antecedentenonderzoek met betrekking tot burgerpersoneel van het ministerie van Defensie, voor zover niet behorend tot één der krijgsmachtdelen;  Werkzaamheden met betrekking tot de materiële veiligheid van het ministerie van Defensie, voor zover niet behorend tot één der krijgsmachtdelen;  Werkzaamheden met betrekking tot het observeren van hier te lande geaccrediteerde vertegenwoordigers van communistische landen (dit werd later geamendeerd tot 'hier te lande geaccrediteerde militaire vertegenwoordigers van communistische landen' om competentiekwesties met de BVD te voorkomen of op zijn minst te reduceren)  Deze krijgsmachtbrede taken vloeiden voort uit het feit dat de Bevelhebber der Landstrijdkrachten bekleed kon worden met het Militair Gezag.",
      "descriptionWithHighlighting": null,
      "other": " Ministerie van Defensie Militaire Inlichtingendienst (Defensie)",
      "otherWithHighlighting": " Ministerie van Defensie Militaire <em>Inlichtingendienst</em> (Defensie)",
      "repository": "Nationaal Archief",
      "repositoryCode": "NL-HaNA",
      "country": "NETHERLANDS",
      "countryId": "7",
      "numberOfArchivalMaterialRelations": "0",
      "numberOfNameRelations": "2"
    },
    {
      "id": "30125",
      "recordId": "a2521656-e614-42a8-94fe-1ce7880dc872",
      "entityType": "corporatebody",
      "nameEntries": [
        "Luchtmacht Inlichtingendienst (Defensie)",
        "Luchtmacht Inlichtingendienst (Defensie)",
        "LUID"
      ],
      "nameEntriesWithHighlighting": [
        "Luchtmacht <em>Inlichtingendienst</em> (Defensie)"
      ],
      "existDates": "1951 - 1988",
      "description": " Rijksoverheid 1951:  Het inwinnen van gegevens welke nodig zijn voor een juiste opbouw en een doeltreffend gebruik van de Koninklijke Luchtmacht;  De bescherming van de geheimen van de luchtmacht, het uitvoeren van de bewaking tegen daden van sabotage aan objecten van de luchtmacht, het treffen van maatregelen tegen diefstal van materieel, wapenen en munitie welke bestemd zijn voor of in gebruik zijn bij de strijdkrachten en het tijdig onderkennen van ondermijnende politieke propa ganda onder het personeel van de Koninklijke Luchtmacht  1972:  Het inwinnen van gegevens omtrent het potentieel en de strijdkrachten van andere mogendheden, welke nodig zijn voor een juiste opbouw en een doeltreffend gebruik van de krijgsmacht;  Het inwinnen van gegevens welke nodig zijn voor het treffen van maatregelen:  Ter voorkoming van activiteiten die ten doel hebben de veiligheid of paraatheid van de krijgsmacht te schaden;  Ter beveiliging van gegevens binnen de krijgsmacht waarvan geheimhouding geboden is;  Ter bevordering van een juist verloop van mobilisatie en concentratie der strijdkrachten.",
      "descriptionWithHighlighting": null,
      "other": " Ministerie van Defensie Militaire Inlichtingendienst (Defensie) Bureau Legerluchtmacht-Veiligheidsdienst (Defensie)",
      "otherWithHighlighting": " Ministerie van Defensie Militaire <em>Inlichtingendienst</em> (Defensie",
      "repository": "Nationaal Archief",
      "repositoryCode": "NL-HaNA",
      "country": "NETHERLANDS",
      "countryId": "7",
      "numberOfArchivalMaterialRelations": "0",
      "numberOfNameRelations": "3"
    },
    {
      "id": "30129",
      "recordId": "94113250-940d-497b-b56e-d8048308f4d7",
      "entityType": "corporatebody",
      "nameEntries": [
        "Marine Inlichtingendienst (Defensie)",
        "Marine Inlichtingendienst (Defensie)",
        "MARID"
      ],
      "nameEntriesWithHighlighting": [
        "Marine <em>Inlichtingendienst</em> (Defensie)"
      ],
      "existDates": "1949-08-08 - 1988-02-01",
      "description": " Rijksoverheid 1949:  Het inwinnen van gegevens welke nodig zijn voor:  a. een juiste opbouw en een doeltreffend gebruik van de Koninklijke Marine;  b. de bescherming van de maritieme geheimen;  c. het uitvoeren van de bewaking tegen daden van sabotage aan maritieme objecten;  d. het treffen van maatregelen tegen diefstal van materieel, wapenen en munitie welke bestemd zijn voor of in gebruik zijn bij de Koninklijke Marine;  e. het tijdig onderkennen van ondermijnende politieke propaganda onder het Marinepersoneel.  1972:  a. het inwinnen van gegevens omtrent het potentieel en de strijdkrachten van andere mogendheden, welke nodig zijn voor een juiste opbouw en een doeltreffend gebruik van de krijgsmacht;  b. het inwinnen van gegevens welke nodig zijn voor het treffen van maatregelen:   1. ter voorkoming van activiteiten die ten doel hebben de veiligheid of paraatheid van de krijgsmacht te schaden;   2. ter beveiliging van gegevens binnen de krijgsmacht waarvan geheimhouding geboden is;   3. ter bevordering van een juist verloop van mobilisatie en concentratie der strijdkrachten.  Veiligheidsonderzoeken voor Marinepersoneel werden uitgevoerd door de Binnenlandse Veiligheidsdienst.",
      "descriptionWithHighlighting": null,
      "other": " De BVD voerde de veiligheidsonderzoeken voor het marinepersoneel uit Ministerie van Defensie Binnenlandse Veiligheidsdienst (BZK) Militaire Inlichtingendienst (Defensie)",
      "otherWithHighlighting": ") Militaire <em>Inlichtingendienst</em> (Defensie)",
      "repository": "Nationaal Archief",
      "repositoryCode": "NL-HaNA",
      "country": "NETHERLANDS",
      "countryId": "7",
      "numberOfArchivalMaterialRelations": "0",
      "numberOfNameRelations": "3"
    }
  ],
  "sortFields": [
    "date"
  ],
  "facetFields": {
    "country": [
      {
        "id": "7",
        "name": "NETHERLANDS",
        "frequency": 13
      }
    ],
    "repository": [
      {
        "id": "2437",
        "name": "Nationaal Archief",
        "frequency": 13
      }
    ],
    "entityType": [
      {
        "id": "corporatebody",
        "name": "corporatebody",
        "frequency": 13
      }
    ],
    "place": [],
    "language": [
      {
        "id": "dut",
        "name": "dut",
        "frequency": 13
      }
    ],
    "unitDateType": [
      {
        "id": "normal",
        "name": "normal",
        "frequency": 9
      },
      {
        "id": "unknownstartdate",
        "name": "unknownstartdate",
        "frequency": 4
      }
    ]
  },
  "facetDateFields": {
    "fromDate": [
      {
        "id": "1800-01-01_2",
        "name": "1800-1999",
        "frequency": 12
      },
      {
        "id": "2000-01-01_2",
        "name": "2000-2199",
        "frequency": 1
      }
    ],
    "toDate": [
      {
        "id": "1800-01-01_2",
        "name": "1800-1999",
        "frequency": 7
      },
      {
        "id": "2000-01-01_2",
        "name": "2000-2199",
        "frequency": 2
      }
    ]
  }
}

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.

eacSearchResults

Enumeration of the results. They are all optional except "id".

id Internal APE identifier of the result
recordId Identifier of the record provided by the repository
entityType Type of the entity that is being described in the record: "corporatebody", "family", "person"
nameEntries Name of the entity that is being described in the record
nameEntriesWithHighlighting Name of the entity that is being described in the record, with the mark "<em>" to emphasise the search term that was used in the search request
existDates Dates indicating the period of existence of the entity
description Further description of the entity
descriptionWithHighlighting Further description of the entity, with the mark "<em>" to emphasise the search term that was used in the search request
other Possible additional description of the entity
otherWithHighlighting Possible additional description of the entity, with the mark "<em>" to emphasise the search term that was used in the search request
repository Name of the repository holding the record of the entity
repositoryCode Code of the repository holding the fonds; preferably, but not necessarily ISIL
country Name of the country where the repository is, in English
countryId Internal APE identifier for the country
numberOfArchivalMaterialRelations Amount of relations to archival material created by the entity
numberOfNameRelations Amount of relations to other entities

sortFields

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

  • date

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.
repository Name of the repository responsible for the record
entityType Type of the entity that is being described in the record: "corporatebody", "family", "person"
place Geographical name for the location of the entity
language Language of the description of the record
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