Brontekst bekijken van Edurep:Jsonsearch

Met het jsonsearch endpoint worden Edurep responses in JSON format geleverd.

== Endpoints ==
* productie: <nowiki>https://wszoeken.edurep.kennisnet.nl/jsonsearch</nowiki>
* staging: <nowiki>https://staging.edurep.kennisnet.nl/jsonsearch</nowiki>

== Request ==
{| class="wikitable
|-
! argument
! #
! omschrijving
|-
| query
| 1
| CQL zoekopdracht
|-
| page-size
| 0-1
| aantal resultaten per pagina, max 100
|-
| page
| 0-1
| pagina van resultatenset
|-
| facet
| 0-*
| veld om drilldown op uit te voeren
|-
| recordSchema
| 0-1
| specificeer recordSchema (default jsonld)
|-
|}

=== Query ===
{{:Edurep:Zoekopdracht/Query}}
=== Paginering ===
{{:Edurep:Zoekopdracht/Paginering}}
{{:Edurep:Zoekopdracht/Paginering/Jsonsearch}}
=== Drilldown ===
{{:Edurep:Zoekopdracht/Drilldown}}
{{:Edurep:Zoekopdracht/Drilldown/Jsonsearch}}
=== Sortering ===
{{:Edurep:Zoekopdracht/Sortering}}
{{:Edurep:Zoekopdracht/Sortering/Jsonsearch}}
=== recordSchema ===
{{:Edurep:Zoekopdracht/recordSchema}}
{{:Edurep:Zoekopdracht/recordSchema/Jsonsearch}}

== Response ==
{| class="wikitable"
|-
! veld
! #
! beschrijving
|-
| /response
| 1
| response containter
|-
| /response/total
| 1
| aantal records van totale respons
|-
| /response/items
| 0-1
| lijst met response records
|-
| /response/facets
| 1
| facets container
|-
| /response/facets/<facetid>
| 0-*
| voor elke opgevraagde valide facet een container met de facet waarden
|-
| /response/facets/<facetid>/count
| 1
| aantal keer dat facet waarde voorkomt in resultatenset
|-
| /response/facets/<facetid>/link
| 1
| directe link naar query op facet waarde
|-
| /response/facets/<facetid>/link
| 1
| de individuele facet waarde
|-
| /response/next
| 0-1
| container met informatie over volgende pagina
|-
| /response/next/link
| 1
| directe link naar volgende pagina
|-
| /response/next/page
| 1
| nummer van volgende pagina
|-
| /response/previous
| 0-1
| container met informatie over vorige pagina
|-
| /response/previous/link
| 1
| directe link naar vorige pagina
|-
| /response/previous/page
| 1
| nummer van vorige pagina
|-
| /response/querytimes
| 1
| querytimes container
|-
| /request
| 1
| request container
|-
| /request/query
| 1
| gestelde query
|-
| /request/page-size
| 0-1
| gevraagd aantal resultaten per pagina
|-
| /request/page
| 0-1
| gevraagde paginanummer
|-
| /request/facet
| 0-1
| container met opgevraagde facets
|-
| /request/facet/index
| 1
| individuele gevraagde facet waarde
|-
| /request/facet/max-terms
| 1
| opgevraagde maximum aantal waarden voor facet waarde
|-
| /version
| 1
| api versie
|}

'''voorbeeld'''
<syntaxhighlight lang="json">
{
  "response": {
    "total": 763,
    "items": [
      {}, {}
    ],
    "facets": {
      "example:facet1": [
        {
          "count": 212,
          "link": "/jsonsearch?facet=schema%3Alicense&facet=dcterms%3Apublisher%3A40&facet-filter=example%facet1%3Dvalue1&page-size=1&query=fiets",
          "value": "value1"
        }
      ],
      "example:facet2": [
        {
          "count": 213,
          "link": "/jsonsearch?facet=schema%3Alicense&facet=dcterms%3Apublisher%3A40&facet-filter=example%3Afacet2%3DvalueX&page-size=1&query=fiets",
          "value": "valueX"
        }
      ]
    },
    "querytimes": {
      "handlingTime": 0.328,
      "indexTime": 0.015,
      "queryTime": 0.021
    },
    "next": {
        "link": "/jsonsearch?facet=example%3Afacet1&facet=example%3Afacet2%3A40&page=4&page-size=1&query=fiets",
        "page": 4
    },
    "previous": {
        "link": "/jsonsearch?facet=example%3Afacet1&facet=example%3Afacet2%3A40&page=2&page-size=1&query=fiets",
        "page": 2
    }
  },
  "request": {
    "facet": [
        {
            "index": "example:facet1",
            "max-terms": 1
        },
        {
            "index": "example:facet2",
            "max-terms": 1
        }
    ],
    "page-size": 1,
    "page": 3,
    "query": "fiets"
  },
  "version": "0.1.beta"
}
</syntaxhighlight>

== Foutmeldingen ==
{{:Edurep:Foutmeldingen/Jsonsearch}}
== Eigenschappen ==
{{:Edurep:Interface eigenschappen}}
== Veldenlijst ==
=== algemeen ===
{{:Edurep:Veldenlijst/Schema.org}}
=== LearningResource ===
{{:Edurep:Veldenlijst/Schema.org/LearningResource}}
=== Event ===
{{:Edurep:Veldenlijst/Schema.org/Event}}
=== invalid ===
{{:Edurep:Veldenlijst/Schema.org/invalid}}
=== about ===
{{:Edurep:Veldenlijst/about}}

== See Also ==
{{:Edurep:SeeAlso|use=[[Edurep:Leermateriaal_Metadata_Opvragen|Leermateriaal Metadata Opvragen]]|sibling=[[Edurep:LOM_SearchRetrieve]] &bull; [[Edurep:SMO_SearchRetrieve]] &bull; [[CS:Entry_SearchRetrieve]]|related=[[Edurep:Veldenlijst]] &bull; [[Standaarden:Schema.org|Schema.org]]}}

[[Categorie:Edurep]]
[[Categorie:Interface]]