Edurep:Widget Endpoint

Uit Kennisnet Developers Documentatie
Versie door Muskee01 (overleg | bijdragen) op 29 apr 2014 om 08:03 (argumenten)
Naar navigatie springen Naar zoeken springen

Edurep-symbol.png Edurep: Widget Endpoint

Voor de Widget wordt gebruik gemaakt van een JSON endpoint die ook voor het grotere publiek beschikbaar is.

Argumenten

Argumenten

Een overzicht van de ondersteunde argumenten:

naam # type omschrijving
version 1 tekst 1.2
query 1 cql query Een zoekopdracht binnen LOM records.
startrecord 0-1 getal De resultatenlijst wordt getoond vanaf dit record, standaard 1.
maximumrecords 0-1 getal Het aantal records in de getoonde resultatenlijst, standaard 10, max 100.
drilldown 0-1 edurep zoekveld Het veld waarop een term drilldown wordt gedaan voor de gevonden resultaten.

Respons

Aangezien het antwoord geen standaard NL LOM is, wat extra uitleg over het uitvoerformaat. Dit bestaat uit een aantal onderdelen:

  • config: De zoekopdracht zoals deze aan de endpoint werd meegegeven.
  • api-version: De versie van de JSON endpoint.
  • status: Toont of er tijdens het zoeken en maken van het antwoord problemen waren.
  • caching: Toont caching informatie.
  • search: De gevonden individuele resultaten.
  • drilldowns: Drilldown informatie over de resultaatset.
  • navigation: Informatie voor het ophalen van de volgende "pagina" in de resultaatset.