Standaarden:ECK-DT/CatalogService

Uit Kennisnet Developers Documentatie
< Standaarden:ECK-DT
Versie door Muskee01 (overleg | bijdragen) op 30 apr 2018 om 08:32 (→‎Voorbeelden: migrate file to gh)
Naar navigatie springen Naar zoeken springen

Standaarden: ECK-DT/CatalogService

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">
            <Entries>
            ...
            </Entries>
            <firstEntry>1</firstEntry>
            <numEntries>50</numEntries>
        </ReadCatalogResult>
    </soapenv:Body>
</soapenv:Envelope>

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