Standaarden:ECK-DT/CatalogService: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Paginering: 1->0)
k (Entry: format)
Regel 3: Regel 3:
   
 
== Entry ==
 
== Entry ==
Een entry bevat metadata van een leermiddel. Hieronder een voorbeeld van een simpele entry.
+
Een entry bevat '''metadata''' van een leermiddel. Hieronder een voorbeeld van een simpele entry.
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
 
<Entry>
 
<Entry>
Regel 13: Regel 13:
   
 
=== Voorbeelden ===
 
=== Voorbeelden ===
* [https://raw.githubusercontent.com/kennisnet/edurep-files/master/example/catalogservice-entry-2.1.1-verplicht.xml 2.1.1 verplicht]
+
* [https://raw.githubusercontent.com/kennisnet/edurep-files/master/example/catalogservice-entry-2.1.1-verplicht.xml Een voorbeeld van een entry met alleen verplichte velden] volgens [https://www.edustandaard.nl/app/uploads/2016/12/ECK-Distributie-en-Toegang-2.1.1-Servicebeschrijvingen.pdf versie 2.1.1] van de ECK-DT standaard.
  +
  +
=== Veldenlijst ===
  +
  +
[[CS:Veldenlijst|CatalogusService: Veldenlijst ]]
   
 
== Transport ==
 
== Transport ==

Versie van 16 mrt 2020 om 19:11

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

Veldenlijst

CatalogusService: Veldenlijst

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>0</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>0</firstEntry>
            <numEntries>50</numEntries>
        </ReadCatalogResult>
    </soapenv:Body>
</soapenv:Envelope>

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