Edurep:LOM SearchRetrieve: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(iface)
(met voorbeeld)
Regel 1: Regel 1:
LOM data kan in Edurep worden opgevraagd via een SRU of SRW endpoint, gebruik makend van de CQL querie taal. Op deze pagina staat een overzicht van de specifieke implementatie van SRU/SRW voor de LOM endpoints.
+
LOM data kan in Edurep worden opgevraagd via een {{Standaard|SRU}} of SRW endpoint, gebruik makend van de CQL querie taal. Op deze pagina staat een overzicht van de specifieke implementatie van SRU/SRW voor de LOM endpoints.
   
 
== Endpoints ==
 
== Endpoints ==
Regel 9: Regel 9:
 
Een overzicht van de ondersteunde argumenten:
 
Een overzicht van de ondersteunde argumenten:
 
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}
 
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}
  +
  +
== Voorbeeld Verzoek ==
  +
<nowiki>http://wszoeken.edurep.kennisnet.nl:8000/edurep/sruns?version=1.2&operation=searchRetrieve&query=fiets&startRecord=6&maximumRecords=5</nowiki>
  +
  +
== Voorbeeld Respons ==
  +
<syntaxhighlight lang="xml">
  +
<srw:searchRetrieveResponse>
  +
<srw:version>1.2</srw:version>
  +
<srw:numberOfRecords>1215</srw:numberOfRecords>
  +
<srw:records>
  +
<srw:record>
  +
<srw:recordSchema>lom</srw:recordSchema>
  +
<srw:recordPacking>xml</srw:recordPacking>
  +
<srw:recordIdentifier>Teleblik:oai:vp-core.snkn.nl:19026</srw:recordIdentifier>
  +
<srw:recordData>
  +
...
  +
<!-- Hier staan een gevonden record. -->
  +
...
  +
</srw:recordData>
  +
<srw:extraRecordData>
  +
<srw:recordData recordSchema="<schema>">
  +
...
  +
<!-- Hier staat het betreffende recordSchema van het gevonden record. -->
  +
...
  +
</srw:recordData>
  +
...
  +
<!-- En eventueel nog andere recordSchema's. -->
  +
...
  +
</srw:extraRecordData>
  +
</srw:record>
  +
...
  +
<!-- Hier staan overige gevonden recorddata en extra recorddata. -->
  +
...
  +
</srw:records>
  +
<srw:nextRecordPosition>11</srw:nextRecordPosition>
  +
<srw:echoedSearchRetrieveRequest>
  +
<srw:version>1.1</srw:version>
  +
<srw:query>fiets</srw:query>
  +
<srw:startRecord>6</srw:startRecord>
  +
<srw:recordPacking>string</srw:recordPacking>
  +
<srw:recordSchema>lom</srw:recordSchema>
  +
<srw:x-recordSchema>extra</srw:x-recordSchema>
  +
<srw:x-recordSchema>smo</srw:x-recordSchema>
  +
<srw:x-recordSchema>smbAggregatedData</srw:x-recordSchema>
  +
</srw:echoedSearchRetrieveRequest>
  +
</srw:searchRetrieveResponse>
  +
</syntaxhighlight>
  +
  +
  +
== Foutmeldingen ==
  +
{{:Edurep:Foutmeldingen}}
   
 
[[Categorie:Edurep]]
 
[[Categorie:Edurep]]

Versie van 28 aug 2013 10:50

LOM data kan in Edurep worden opgevraagd via een SRU of SRW endpoint, gebruik makend van de CQL querie taal. Op deze pagina staat een overzicht van de specifieke implementatie van SRU/SRW voor de LOM endpoints.

Endpoints

Argumenten

Een overzicht van de ondersteunde argumenten:

Voorbeeld Verzoek

http://wszoeken.edurep.kennisnet.nl:8000/edurep/sruns?version=1.2&operation=searchRetrieve&query=fiets&startRecord=6&maximumRecords=5

Voorbeeld Respons

<srw:searchRetrieveResponse>
  <srw:version>1.2</srw:version>
  <srw:numberOfRecords>1215</srw:numberOfRecords>
  <srw:records>
    <srw:record>
      <srw:recordSchema>lom</srw:recordSchema>
      <srw:recordPacking>xml</srw:recordPacking>
      <srw:recordIdentifier>Teleblik:oai:vp-core.snkn.nl:19026</srw:recordIdentifier>
      <srw:recordData>
        ...
        <!-- Hier staan een gevonden record. -->
        ...
      </srw:recordData>
      <srw:extraRecordData>
        <srw:recordData recordSchema="<schema>">
          ...
          <!-- Hier staat het betreffende recordSchema van het gevonden record. -->
          ...
        </srw:recordData>
        ...
        <!-- En eventueel nog andere recordSchema's. -->
        ...
      </srw:extraRecordData>
    </srw:record>
    ...
    <!-- Hier staan overige gevonden recorddata en extra recorddata. -->
    ...
  </srw:records>
  <srw:nextRecordPosition>11</srw:nextRecordPosition>
  <srw:echoedSearchRetrieveRequest>
    <srw:version>1.1</srw:version>
    <srw:query>fiets</srw:query>
    <srw:startRecord>6</srw:startRecord>
    <srw:recordPacking>string</srw:recordPacking>
    <srw:recordSchema>lom</srw:recordSchema>
    <srw:x-recordSchema>extra</srw:x-recordSchema>
    <srw:x-recordSchema>smo</srw:x-recordSchema>
    <srw:x-recordSchema>smbAggregatedData</srw:x-recordSchema>
  </srw:echoedSearchRetrieveRequest>
</srw:searchRetrieveResponse>


Foutmeldingen

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