Edurep:Jsonsearch: verschil tussen versies
Naar navigatie springen
Naar zoeken springen
(→Request: add request) |
(→Response: add response example) |
||
Regel 36: | Regel 36: | ||
== Response == |
== Response == |
||
* response velden |
* response velden |
||
+ | |||
− | * voorbeeld (stuf item data) |
||
+ | '''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&query=fiets", |
||
+ | "value": "value1" |
||
+ | } |
||
+ | ], |
||
+ | "example:facet2": [ |
||
+ | { |
||
+ | "count": 213, |
||
+ | "link": "/jsonsearch?facet=schema%3Alicense&facet=dcterms%3Apublisher%3A40&facet-filter=example%3Afacet2%3DvalueX&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=2&query=fiets", |
||
+ | "page": 2 |
||
+ | } |
||
+ | }, |
||
+ | "request": { |
||
+ | "facet": [ |
||
+ | { |
||
+ | "index": "example:facet1", |
||
+ | "max-terms": 1 |
||
+ | }, |
||
+ | { |
||
+ | "index": "example:facet2", |
||
+ | "max-terms": 1 |
||
+ | } |
||
+ | ], |
||
+ | "query": "fiets" |
||
+ | }, |
||
+ | "version": "0.1.beta" |
||
+ | } |
||
+ | </syntaxhighlight> |
||
== Foutmeldingen == |
== Foutmeldingen == |
Versie van 4 okt 2021 06:32
Vanwege de aankomende release zijn we bezig het voorbereiden van de wiki. Met name de informatie rondom schema.org en de jsonsearch is nog niet bruikbaar op productie. |
Met het jsonsearch endpoint worden Edurep responses in JSON format geleverd.
Endpoints
- TODO url
Request
argument | # | omschrijving |
---|---|---|
query | 1 | CQL zoekopdracht |
page-size | 0-1 | aantal resultaten per pagina, max 100 |
page | 0-1 | ? |
facet | 0-* | veld om drilldown op uit te voeren |
voorbeeld
- https://wszoeken.edurep.kennisnet.nl/?query=fiets&facet=schema:license
Response
- response velden
voorbeeld
{
"response": {
"total": 763,
"items": [
{}, {}
],
"facets": {
"example:facet1": [
{
"count": 212,
"link": "/jsonsearch?facet=schema%3Alicense&facet=dcterms%3Apublisher%3A40&facet-filter=example%facet1%3Dvalue1&query=fiets",
"value": "value1"
}
],
"example:facet2": [
{
"count": 213,
"link": "/jsonsearch?facet=schema%3Alicense&facet=dcterms%3Apublisher%3A40&facet-filter=example%3Afacet2%3DvalueX&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=2&query=fiets",
"page": 2
}
},
"request": {
"facet": [
{
"index": "example:facet1",
"max-terms": 1
},
{
"index": "example:facet2",
"max-terms": 1
}
],
"query": "fiets"
},
"version": "0.1.beta"
}
Foutmeldingen
- include uit foutmeldingen doc
Veldenlijst
zoekveld | x-term-drilldown | sortKeys | <, <=, >=, > | exact |
---|---|---|---|---|
schema:name | ||||
schema:identifier | V |