Standaarden:ECK-DT/CatalogService: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(add example)
k (→‎Transport: minor)
Regel 22: Regel 22:
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:eckcs="http://dt2.eck.nl/schema/catalogservice/v2.1.1">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:eckcs="http://dt2.eck.nl/schema/catalogservice/v2.1.1">
<soapenv:Header/>
+
<soapenv:Header>
  +
...
  +
</soapenv:Header>
 
<soapenv:Body>
 
<soapenv:Body>
 
<eckcs:ReadCatalog>
 
<eckcs:ReadCatalog>
Regel 35: Regel 37:
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.w3.org/2005/08/addressing">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.w3.org/2005/08/addressing">
<soapenv:Header/>
+
<soapenv:Header>
  +
...
  +
</soapenv:Header>
 
<soapenv:Body>
 
<soapenv:Body>
 
<ReadCatalogResult xmlns="http://dt2.eck.nl/schema/catalogservice/v2.1.1">
 
<ReadCatalogResult xmlns="http://dt2.eck.nl/schema/catalogservice/v2.1.1">
Regel 41: Regel 45:
 
<numEntries>50</numEntries>
 
<numEntries>50</numEntries>
 
<Entries>
 
<Entries>
<!-- contains all entries -->
+
...
 
</Entries>
 
</Entries>
 
</ReadCatalogResult>
 
</ReadCatalogResult>

Versie van 30 nov 2017 08:26

De CatalogService webservice binnen ECK-DT gaat over de metadata van de catalogus onderdelen, maar ook het transport daarvan.

Entry

Een entry bevat metadata van een leermiddel. Hieronder een voorbeeld van een simpele entry.

<Entry>
    <ProductId>123581321</ProductId>
    <Publisher>Fibonacci Uitgevers</Publisher>
    <Title>Rekenen met patronen</Title>
</Entry>

Voorbeelden

Transport

Op de SOAP webservice kan een verzoek gedaan worden voor metadata in de catalogus. Specifieke opties voor het ophalen van dagelijkse updates, en het gepagineerd ophalen van updates zijn beschikbaar.

Paginering

Met behulp van de firstEntry en Amount velden kunnen entries gepagineerd worden opgehaald. Bijvoorbeeld voor een initieel verzoek voor 50 records:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:eckcs="http://dt2.eck.nl/schema/catalogservice/v2.1.1">
   <soapenv:Header>
   ...
   </soapenv:Header>
   <soapenv:Body>
      <eckcs:ReadCatalog>
         <eckcs:firstEntry>1</eckcs:firstEntry>
         <eckcs:Amount>50</eckcs:Amount>
      </eckcs:ReadCatalog>
   </soapenv:Body>
</soapenv:Envelope>

Waarop de service 50 records teruggeeft met daarin het teruggegeven aantal en de firstEntry waarde van het eerste record in deze pagina.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.w3.org/2005/08/addressing">
   <soapenv:Header>
   ...
   </soapenv:Header>
    <soapenv:Body>
        <ReadCatalogResult xmlns="http://dt2.eck.nl/schema/catalogservice/v2.1.1">
            <firstEntry>1</firstEntry>
            <numEntries>50</numEntries>
            <Entries>
            ...
            </Entries>
        </ReadCatalogResult>
    </soapenv:Body>
</soapenv:Envelope>

De laatste pagina is bereikt als de response numEntries < dan request Amount.