Feeds
From NUBWiki
Contents |
Inleiding
De culturele data afslag gebeurt in de vorm van verschillende feeds. Het principe van een feed is niets meer dan het beschikbaar stellen van de data. Tecnhisch gebeurt dit door het publiekelijk (eventueel met authenticatie) beschikbaar stellen van een bestand met de betreffende data.
Logischerwijs zijn de feeds dus op te delen in Import feeds en Export feeds. Een partij die data aanbied spreekt dus over een Export feed, als diezelfde feed wordt opgehaald door een derde party dan spreken zij over een Import feed.
De publishing server biedt een feed aan middels het REST principe en wordt momenteel alleen nog aangeleverd in XML structuur. In de nabije toekomst zal de structuur uitgebreid worden naar RSS en eventuele andere structuren.
Om een feed te kunnen importeren moet men eerst eigenaar zijn van een key om toegang te krijgen tot actuele culturele informatie.
Beveiligingskey
De feedserver is beveiligd. Dat wil zeggen dat je alleen gegevens kunt ophalen als je een key hebt. In datalevering is te vinden hoe je een key kunt krijgen. Om gebruik te kunnen maken van de feedserver is het noodzakelijk een key mee te geven. Een key is persoons- of instantie-gebonden. Voor het testen van een feed is een publieke key vrijgegeven.
ed79e27aedbe4a5824f70aaf5b2e9836
Deze key resulteert in een agenda die in het verleden ligt, maar wel heel Nederland bevat.
Versiebeheer
De manier waarop het systeem te bevragen is staat precies beschreven in de technische pagina's. De vragen zijn gebaseerd op een bepaald datamodel. Dit model verandert in de loop der tijd. Om te voorkomen dat de feeds zelf ook iedere keer veranderen, wordt aan versie beheer gedaan. Als er een nieuwe versie komt blijven de oude geruime tijd beschikbaar. De te gebruiken versie moet worden meegegeven. Nu is dat /1.0/, dat meegegeven wordt in de vraag.
Data model
De publishing server beheert de data met behulp van het volgende model.
Series
Een serie is een verzameling van activiteiten. Deze verzameling is ongeacht de producties, locaties en kalenderitems. Dit houdt dus in dat een serie alle activiteiten van 2 producties kan bevatten, maar het kan ook alle activiteiten bevatten die een specifieke actie aangaan.
Activiteiten
Een activiteit is een verzameling van 1 specifieke productie, 1 specifieke locatie en 1 specifieke kalender item. Daarnaast bevat een activiteit meta informatie (bv. prijzen, kortingen). Een activiteit kan gekoppeld zijn aan meerder series.
Locaties
Een locatie is een verzameling van adres en contact gegevens. Daarnaast kan een locatie meta informatie bevatten (bv. rolstoel toegankelijkheid, bereikbaarheid)
Producties
Een productie is een verzameling van voorstelling gegevens. Denk hierbij aan titel van de voorstelling, omschrijving, afbeelding welke taal, etc.
Kalenderitem
Kalenderitem is een beschrijving van de tijdsspanne. In versie 1.0 is het kalenderitem gemodelleerd in de Activiteit. In Activiteit is een startdatum, einddatum en tijdstip opgenomen.
