WWM:Synchroniseren met IMSCP bestanden

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen

Wikiwijs Maken-symbol.png Wikiwijs Maken: Synchroniseren met IMSCP bestanden

inleiding

De gepubliceerde Wikiwijs Maken arrangementen worden gedeeld met Edurep. Via deze zoekmachine kunnen middels API calls specifieke subsets van de Wikiwijs Maken collectie worden bevraagd. Bijvoorbeeld, alle arrangementen van VO-Content, of alle arrangement voor het vak aardrijkskunde.

Het is daarmee mogelijk om via de Edurep interface geautomatiseerd op de hoogte te blijven van nieuwe en gewijzigde IMSCP bestanden van arrangementen.

Hoe dit precies werkt, wordt toegelicht op deze pagina.

Edurep interface

De details van de Edurep interface worden primair uitgelegd op de wiki pagina van Edurep. Voor het gemak geven we hier voor deze use case een aantal uitgewerkte voorbeelden.

Wikiwijs Maken is de enige repository in Edurep waarbij alle records voorzien zijn van IMSCP records.

/edurep/sruns: query=about.repository=wikiwijsmaken

Binnen deze repository kan gezocht worden op verschillende subsets van informatie. Voor meer informatie zie de Edurep Veldenlijst.

/edurep/sruns: query=about.repository=wikiwijsmaken AND lom.lifecycle.contribute.publisher="VO-content"
/edurep/sruns: query=about.repository=wikiwijsmaken AND smbAggregatedData.averageNormalizedRating>3

IMSCP data

Met de bovenstaande queries wordt er allemaal data opgehaald. Specifiek voor deze use case blijft dan nog de vraag, waar staat de IMSCP data? In elk Wikiwijs Maken LOM record die terugkomt uit Edurep staan een aantal relation elementen met daarin links naar de verschillende bestandsformaten van een arrangement (pdf, epub en imscp). Voor meer informatie bekijk de NL LOM relation pagina op deze developer wiki.

<relation>
  <kind>
    <source>
      <langstring xml:lang="x-none">http://purl.edustandaard.nl/relation_kind_nllom_20131211</langstring>
    </source>
    <value>
      <langstring xml:lang="x-none">hasformat</langstring>
    </value>
  </kind>
  <resource>
    <description>
      <langsting xml:lang="x-none">application/x-imscp+zip</langstring>
    </description>
    <catalogentry>
      <catalog>URI</catalog>
      <entry>
        <langstring xml:lang="x-none">https://maken.wikiwijs.nl/57060/Cirkel_vmbo_kgt12?p=imscp</langstring>
      </entry>
    </catalogentry>
  </resource>
</relation>
Info.gif Voor nu zou inderdaad afgeleid kunnen worden dat de technical location van de metadata met worden gepostfixed met ''?p=imscp'', maar dat is geen garantie dat dit verband altijd blijft werken.

download stream

Edurep geeft bij een query standaard maar 10 resultaten terug, maar biedt wel de mogelijkheid om gepagineerd door een resultatenset te zoeken. Bijvoorbeeld met een pagesize van 20:

/edurep/sruns: query=about.repository=wikiwijsmaken&maximumRecords=20
/edurep/sruns: query=about.repository=wikiwijsmaken&maximumRecords=20&startRecord=21
/edurep/sruns: query=about.repository=wikiwijsmaken&maximumRecords=20&startRecord=41

etc.

De resultatenset van Edurep wordt gelimiteerd tot 1000. Speciaal voor partijen die de IMSCP-sync functionaliteit willen gebruiken boven dit aantal, is er de mogelijkheid om een uitzondering te maken. Neem hiervoor contact op met de servicedesk.

nieuwe records

Na een initiele harvest worden er natuurlijk ook nieuwe arrangementen gepubliceerd. Om deze binnen te halen kan worden gezocht op de publicatiedatum vanaf de laatste harvest. De volgende statement moet worden toegevoegd aan de query om de laatste nieuwe arrangementen binnen te halen.

/edurep/sruns: query=about.repository=wikiwijsmaken AND lom.lifecycle.contribute.publisherdate>2018-01-01T00:00:00Z

update records

Het is nu niet mogelijk om in Edurep te zoeken naar de laatste wijzigingen van de gebruikte subset van arrangementen. Het kan ook voorkomen dat het formaat van het IMSCP record wijzigt. Hiervoor wordt nu ook geen mechanisme aangeboden die laat weten wanneer dit is veranderd.

Het advies is dan ook om periodiek (elke maand/half jaar) een volledige nieuwe download te doen van alle arrangementen.