Standaarden:ECK-DT/CatalogService: verschil tussen versies
Naar navigatie springen
Naar zoeken springen
(first for now) |
k (link voorbeelden full entry) |
||
| (7 tussenliggende versies door 2 gebruikers niet weergegeven) | |||
| Regel 1: | Regel 1: | ||
| + | __NOTOC__ |
||
De CatalogService webservice binnen ECK-DT gaat over de metadata van de catalogus onderdelen, maar ook het transport daarvan. |
De CatalogService webservice binnen ECK-DT gaat over de metadata van de catalogus onderdelen, maar ook het transport daarvan. |
||
== 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 10: | Regel 11: | ||
</Entry> |
</Entry> |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
| + | |||
| + | === Voorbeelden === |
||
| + | |||
| + | |||
| + | * [https://raw.githubusercontent.com/kennisnet/edurep-files/master/example/catalogservice-entry-2.3-full.xml Een voorbeeld van een full entry] volgens [https://www.edustandaard.nl/app/uploads/2020/02/ECK-Distributie-en-Toegang-2.3-Servicebeschrijvingen.pdf versie 2.3] van de ECK-DT standaard. |
||
| + | * [https://raw.githubusercontent.com/kennisnet/edurep-files/master/example/catalogservice-entry-2.2-full.xml Een voorbeeld van een full entry] volgens [https://www.edustandaard.nl/app/uploads/2019/01/ECK-Distributie-en-Toegang-2.2-Servicebeschrijvingen.pdf versie 2.2] van de ECK-DT standaard. |
||
| + | <br/> |
||
| + | * [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 == |
||
| Regel 18: | Regel 31: | ||
<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> |
||
| − | <eckcs:firstEntry> |
+ | <eckcs:firstEntry>0</eckcs:firstEntry> |
<eckcs:Amount>50</eckcs:Amount> |
<eckcs:Amount>50</eckcs:Amount> |
||
</eckcs:ReadCatalog> |
</eckcs:ReadCatalog> |
||
| Regel 31: | Regel 46: | ||
<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: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"> |
||
| ⚫ | |||
| ⚫ | |||
<Entries> |
<Entries> |
||
| − | + | ... |
|
</Entries> |
</Entries> |
||
| ⚫ | |||
| ⚫ | |||
</ReadCatalogResult> |
</ReadCatalogResult> |
||
</soapenv:Body> |
</soapenv:Body> |
||
Huidige versie van 24 mrt 2020 om 15:24
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
- Een voorbeeld van een full entry volgens versie 2.3 van de ECK-DT standaard.
- Een voorbeeld van een full entry volgens versie 2.2 van de ECK-DT standaard.
- Een voorbeeld van een entry met alleen verplichte velden volgens versie 2.1.1 van de ECK-DT standaard.
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.