Edurep:Foutmeldingen: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(copy)
 
k
 
(3 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 1: Regel 1:
  +
== SRU Foutmeldingen ==
Een foutmelding vanuit Edurep is te herkennen aan de aanwezigheid van het diagnostics veld. In dit veld zal dan een diagnostic staan die die volgende elementen bevat:
 
  +
{{:Edurep:Foutmeldingen/SRU}}
* een foutcode: in diagnostic/uri
 
* een titel: in diagnostic/message
 
* een beschrijving: in diagnostic/details
 
 
=== Voorbeeld ===
 
<syntaxhighlight lang="xml">
 
<srw:searchRetrieveResponse>
 
<srw:version>1.2</srw:version>
 
<srw:numberOfRecords>0</srw:numberOfRecords>
 
<srw:diagnostics>
 
<diagnostic>
 
<uri>info://srw/diagnostics/1/48</uri>
 
<details>Unexpected token after parsing ([=], CQL_QUERY(SCOPED_CLAUSE(SEARCH_CLAUSE(SEARCH_TERM(TERM('test')))))).</details>
 
<message>Query Feature Unsupported</message>
 
</diagnostic>
 
</srw:diagnostics>
 
</srw:searchRetrieveResponse>
 
</syntaxhighlight>
 
 
=== Foutcodes ===
 
 
{|class="wikitable"
 
|-
 
! foutcode
 
! titel/message
 
! uitleg
 
|-
 
| info://srw/diagnostics/1/4
 
| Unsupported Operation
 
| Alleen operaties searchRetrieve en explain worden ondersteund.
 
|-
 
| info://srw/diagnostics/1/5
 
| Unsupported Version
 
| Alleen versies 1.1 en 1.2 worden ondersteund. Gebruik 1.2
 
|-
 
| info://srw/diagnostics/1/6
 
| Unsupported Parameter Value
 
| De waarde van een query parameter is ongeldig.
 
|-
 
| info://srw/diagnostics/1/7
 
| Mandatory Parameter Not Supplied
 
| Niet alle verplichte argumenten zijn meegegeven.
 
|-
 
| info://srw/diagnostics/1/8
 
| Unsupported Parameter
 
| Een van de query parameters is ongeldig.
 
|-
 
| info://srw/diagnostics/1/12
 
| Too many characters in query
 
| Het query argument mag maximaal 4096 tekens bevatten.
 
|-
 
| info://srw/diagnostics/1/48
 
| Query Feature Unsupported
 
| De query bevat een fout.
 
|-
 
|}
 
 
   
  +
== Jsonsearch Foutmeldingen ==
  +
{{:Edurep:Foutmeldingen/Jsonsearch}}
   
 
[[Categorie:Edurep]]
 
[[Categorie:Edurep]]

Huidige versie van 20 okt 2021 om 07:46

SRU Foutmeldingen

Een foutmelding vanuit Edurep is te herkennen aan de aanwezigheid van het diagnostics veld. In dit veld zal dan een diagnostic staan die die volgende elementen bevat:

  • een foutcode: in diagnostic/uri
  • een titel: in diagnostic/message
  • een beschrijving: in diagnostic/details

Voorbeeld

<srw:searchRetrieveResponse>
  <srw:version>1.2</srw:version>
  <srw:numberOfRecords>0</srw:numberOfRecords>
  <srw:diagnostics>
    <diagnostic>
      <uri>info://srw/diagnostics/1/48</uri>
      <details>Unexpected token after parsing ([=], CQL_QUERY(SCOPED_CLAUSE(SEARCH_CLAUSE(SEARCH_TERM(TERM('test')))))).</details>
      <message>Query Feature Unsupported</message>
    </diagnostic>
  </srw:diagnostics>
</srw:searchRetrieveResponse>

Foutcodes

foutcode titel/message uitleg
info://srw/diagnostics/1/4 Unsupported Operation Alleen operaties searchRetrieve en explain worden ondersteund.
info://srw/diagnostics/1/5 Unsupported Version Alleen versies 1.1 en 1.2 worden ondersteund. Gebruik 1.2
info://srw/diagnostics/1/6 Unsupported Parameter Value De waarde van een query parameter is ongeldig.
info://srw/diagnostics/1/7 Mandatory Parameter Not Supplied Niet alle verplichte argumenten zijn meegegeven.
info://srw/diagnostics/1/8 Unsupported Parameter Een van de query parameters is ongeldig.
info://srw/diagnostics/1/12 Too many characters in query Het query argument mag maximaal 4096 tekens bevatten.
info://srw/diagnostics/1/48 Query Feature Unsupported De query bevat een fout.


Jsonsearch Foutmeldingen

Een foutmelding uit de jsonsearch is te herkennen aan de "error" key in de response.

Voorbeeld

{
    "error": {
        "message": "Missing required argument: 'query'",
        "type": "MissingArgument"
    },
    "version": "0.1.beta"
}

Foutcodes

type omschrijving
MissingArgument een vereist argument ontbreekt in het verzoek