searchEac - Revision history

Admin: /* Basic Response example */

2018-01-09T15:56:29Z

‎Basic Response example

Show changes

Admin at 14:36, 30 August 2017

2017-08-30T14:36:18Z

Admin: /* sortFields */

2017-06-06T13:14:35Z

‎sortFields

Admin: /* Basic Response example */

2017-06-06T08:56:04Z

‎Basic Response example

Admin: /* Response parameters */

2017-06-06T08:55:19Z

‎Response parameters

Admin: /* Request parameters */

2017-06-06T08:50:19Z

‎Request parameters

Admin: /* Response parameters */

2017-06-05T11:37:39Z

‎Response parameters

Admin: /* Response parameters */

2017-06-05T11:37:02Z

‎Response parameters

Admin: /* dateFilters */

2017-06-05T10:52:03Z

‎dateFilters

Admin: /* filters */

2017-06-05T10:51:50Z

‎filters

@@ Line 42: / Line 42: @@
    "count": "5",
    "startIndex": 0,
-   "query": "Onderwijsraad",
+   "query": "Inlichtingendienst",
    "filters": [
+     {
@@ Line 53: / Line 53: @@
    "dateFilters": [
+     {
-       "dateFieldName": "fromdate",
+       "dateFieldName": "fromDate",
        "dateFieldId": "1800-01-01_2"
+     }
@@ Line 66: / Line 66: @@
 </pre>
-This example searches for archival descriptions with the term "Onderwijsraad" 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).
+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 ==
@@ Line 202: / Line 202: @@
    "eacSearchResults": [
+     {
-       "id": "15170",
+       "id": "26005",
-       "recordId": "0b04eb34-8732-4387-8417-3ea1a120723d",
+       "recordId": "489d662d-b214-4b7a-98e2-d01b253c773f",
        "entityType": "corporatebody",
        "nameEntries": [
-         "Onderwijsraad (OenW, OCW)",
+         "Militaire Inlichtingendienst (Defensie)",
-         "Onderwijsraad (OenW, OCW)"
+         "MID",
        ],
        "nameEntriesWithHighlighting": [
-         "<em>Onderwijsraad</em> (OenW, OCW)"
+         "Militaire <em>Inlichtingendienst</em> (Defensie)"
        ],
-       "existDates": "1919",
+       "existDates": "1988 - 2002",
-       "description": " Rijksoverheid De Onderwijsraad is het adviesorgaan voor de regering op het terrein van het onderwijs. De raad adviseert over de hoofdlijnen van het beleid en de wetgeving op het gebied van het onderwijs. Hij neemt een onafhankelijke positie in zowel ten opzichte van het Ministerie van Onderwijs, Cultuur en Wetenschap en dat van Economische Zaken, Landbouw en Innovatie als ten opzichte van het onderwijsveld. Niet alleen adviseert de raad - gevraagd dan wel ongevraagd - de betrokken bewindslieden, maar ook de Eerste en Tweede Kamer kunnen om advies vragen. Ook gemeenten kunnen in speciale bij de wet geregelde gevallen een beroep doen op de Onderwijsraad.SamenstellingDe raad telt ten minste acht en ten hoogste negentien leden. Zij worden bij Koninklijk Besluit op persoonlijke titel voor een periode van maximaal vier jaar benoemd. Daarna kunnen zij twee maal worden herbenoemd. Zij zijn onafhankelijk en vertegenwoordigen geen belangengroepen. De leden van de raad worden benoemd vanwege hun deskundigheid en zijn afkomstig uit verschillende geledingen van de maatschappij (onderwijs, wetenschap, het openbaar bestuur).",
+       "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 handhaving 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": " Rijksoverheid De <em>Onderwijsraad</em> is het adviesorgaan voor de regering op het terrein van het onderwijs",
+       "descriptionWithHighlighting": " In 1988 ontstaan uit samenvoeging van de Marine <em>Inlichtingendienst</em> (MARID",
-       "other": "",
+       "other": " Algemene Leiding (Defensie) Militaire Inlichtingen- en Veiligheidsdienst (Defensie) Marine Inlichtingendienst (Defensie) Landmacht Inlichtingendienst (Defensie) Luchtmacht Inlichtingendienst (Defensie)",
-       "otherWithHighlighting": null,
+       "otherWithHighlighting": ") Marine <em>Inlichtingendienst</em> (Defensie) Landmacht <em>Inlichtingendienst</em> (Defensie",
        "repository": "Nationaal Archief",
        "repositoryCode": "NL-HaNA",
@@ Line 222: / Line 223: @@
        "countryId": "7",
        "numberOfArchivalMaterialRelations": "0",
-       "numberOfNameRelations": "0"
+       "numberOfNameRelations": "5"
+     }
    ],
@@ Line 238: / Line 239: @@
      "repository": [
+       {
-         "id": "32171",
+         "id": "2437",
          "name": "Nationaal Archief",
          "frequency": 1
@@ Line 260: / Line 261: @@
      "unitDateType": [
+       {
-         "id": "unknownstartdate",
+         "id": "normal",
-         "name": "unknownstartdate",
+         "name": "normal",
          "frequency": 1
+       }
@@ Line 269: / Line 270: @@
      "fromDate": [
+       {
-         "id": "1800-01-01_2",
+         "id": "1980-01-01_3",
-         "name": "1800-1999",
+         "name": "1980-1999",
          "frequency": 1
+       }
      ],
-     "toDate": []
+     "toDate": [
+   }
+}

@@ Line 342: / Line 342: @@
 == sortFields ==
-This response parameter sums up the various fields you can use to order the resultList in a, new, additional request (see [[searchEac#sortRequest]]):
+This response parameter sums up the various fields you can use to order the resultList in a, new, additional request (see: [[searchEac#sortRequest]]):
 * date

@@ Line 194: / Line 194: @@
 == Basic Response example ==
-Response for the basic request example above:
+Response for the [[searchEac#Basic_Request_example|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;">
+{

@@ Line 95: / Line 95: @@
 = 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 descriptions 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 193: / Line 193: @@
 </pre>
-Basic Response example (ie response for the basic request example above):
+== 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 304: / Line 305: @@
 |-
 | nameEntriesWithHighlighting
-| Name of the entity that is being described in the record, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request
+| Name of the entity that is being described in the record, with the mark "<nowiki><em></nowiki>" to emphasise the search term that was used in the search request
 |-
 | existDates
@@ Line 313: / Line 314: @@
 |-
 | descriptionWithHighlighting
-| Further description of the entity, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request
+| Further description of the entity, with the mark "<nowiki><em></nowiki>" to emphasise the search term that was used in the search request
 |-
 | other
@@ Line 319: / Line 320: @@
 |-
 | otherWithHighlighting
-| Possible additional description of the entity, with the mark "<nowiki><em></nowiki>" to emphasize the search term that was used in the search request
+| Possible additional description of the entity, with the mark "<nowiki><em></nowiki>" to emphasise the search term that was used in the search request
 |-
 | repository
@@ Line 325: / Line 326: @@
 |-
 | 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]
 |-
 | country
-| Name of the country where the repository is. In English
+| Name of the country where the repository is, in English
 |-
 | countryId
@@ Line 350: / Line 351: @@
 {| class="wikitable"
 | id
-| Internal APE identifier of the value. Use this "id" in the filter request parameter.
+| Internal APE identifier of the value; use this "id" in the filter request parameter
 |-
 | name
-| Human readable value (in English).
+| Human readable value (in English)
 |-
 | frequency
-| The number of results of this facet containing the searchterm.
+| The number of results of this facet containing the search term
 |}
@@ Line 363: / Line 364: @@
 {| class="wikitable"
 | country
-| Name of the country where the repository is. In English.
+| Name of the country where the repository is, in English.
 |-
 | repository
-| Name of the repository responsible for the record.
+| Name of the repository responsible for the record
 |-
 | entityType
@@ Line 378: / Line 379: @@
 |-
 | unitDateType
-| Type of date describing the archival unit.
+| 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
+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.
 {| class="wikitable"
 | fromDate
-| Grouping of the search result in starting dates.
+| Grouping of the search result in starting dates
 |-
 | toDate
-| Grouping of the search result in ending dates.
+| Grouping of the search result in ending dates
 |}
 [[Category:Technical_documentation]]

@@ Line 8: / Line 8: @@
 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:
+== Empty Request 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;">
 <pre>
+{
    "count": "5",
@@ Line 38: / Line 37: @@
 </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;">
+{
    "count": "5",
@@ Line 76: / Line 75: @@
 == query ==
-Containing the searchterm(s). Required.
+Containing the search term(s). Required.
 == filters ==
-Request parameter "filters" enables you to filter the result on facets. The facets are summarized in [[searchEac#facets]].
+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 summarized in [[searchEac#date_facets]]
+Request parameters "dateFilters" enables you to filter the result on a certain period of time. The dateFacets are summarised in [[searchEac#date_facets]]
 == sortRequest ==