Feed voorbeelden
Contents |
Inleiding
Hieronder worden een aantal voorbeelden gegegeven van "aanroepen" die kunnen worden gedaan voor het opvragen van data uit de NUB Publishing Server. Om informatie uit de publishing server te halen, moeten er vragen aan de server gesteld worden. De vragen worden opgebouwd met behulp van een REST interface, in ons geval aangevuld met een key. Het principe van REST is om de vragen in de url balk te stellen, op een dermate gestrucuteerde manier zodat deze door de server geinterpreteerd kunnen worden. Hieronder staat stap voor stap beschreven hoe je een vraag kunt stellen aan het systeem. kijk voor uitgebreide vragen bij Geavanceerde vragen
Voorbeeld: Opvragen evenementen voor bepaalde periode
Het opvragen van Evenementen (Activiteiten) voor een bepaalde periode is een twee-traps-raket. Eerst dienen de Activiteiten opgevraagd te worden, daarna per Activiteiten een Productie en Locatie.
Stap 1 Opvragen Activiteiten voor bepaalde periode
In onderstaande voorbeeld vragen we alle activiteiten op voor 26 mei 2009. We gebruiken bij de aanroep de volgende parameters:
- key: ed79e27aedbe4a5824f70aaf5b2e9836
- datum-vanaf: 2009-05-26T00:00:00.0Z (LET OP: de datum heeft het xs:dateTime formaat)
- datum-tot: 2009-05-26T00:00:00.0Z (LET OP: de datum heeft het xs:dateTime formaat)
- regio: 10 (Nijmegen)
http://feeds.uitburo.nl/1.0/activiteiten?key=ed79e27aedbe4a5824f70aaf5b2e9836&datum-vanaf=2009-05-26T00:00:00.0Z&datum-tot=2009-05-26T00:00:00.0Z®io=10
Bovenstaande aanroep resulteert in de volgende response:
<activiteiten hits="2" rows="10" start="0" self="http://feeds.uitburo.nl/1.0/activiteiten"> <activiteit cidn="2008-A-073-0001781" ref="http://feeds.uitburo.nl/1.0/activiteiten/2008-A-073-0001781"/> <activiteit cidn="2008-A-073-0001651" ref="http://feeds.uitburo.nl/1.0/activiteiten/2008-A-073-0001651"/> </activiteiten>
Stap 2 Opvragen Activiteit uit de lijst met Activiteiten
Met de onderstaande aanroepen kunnen de detail gegevens van een Activiteit worden opgevraagd:
http://feeds.uitburo.nl/1.0/activiteiten/2008-A-073-0001781?key=ed79e27aedbe4a5824f70aaf5b2e9836 http://feeds.uitburo.nl/1.0/activiteiten/2008-A-073-0001651?key=ed79e27aedbe4a5824f70aaf5b2e9836
In de detail gegevens van Activiteit staan verwijzingen naar een Productie en een Locatie. Deze kunnen vervolgens ook weer opgevraagd worden.
Voorbeeld: Overzicht van producties
De vraag:
- Geef mij alle producties.
LET OP: De verplichte key wordt er achter geplakt met ?key=ed....
http://feeds.uitburo.nl/1.0/producties?key=ed79e27aedbe4a5824f70aaf5b2e9836
Het resultaat van de producties ziet er zo uit:
<producties hits="8238" rows="10" start="0" self="http://feeds.uitburo.nl/1.0/producties"> <productie cidn="2007-P-068-0001808" ref="http://feeds.uitburo.nl/1.0/producties/2007-P-068-0001808"/> <productie cidn="2009-P-003-0007568" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-003-0007568"/> <productie cidn="2009-P-013-0000011" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-013-0000011"/> <productie cidn="2000-P-001-0002231" ref="http://feeds.uitburo.nl/1.0/producties/2000-P-001-0002231"/> <productie cidn="2006-P-001-0042272" ref="http://feeds.uitburo.nl/1.0/producties/2006-P-001-0042272"/> <productie cidn="2009-P-001-0061431" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-001-0061431"/> <productie cidn="2009-P-003-0007572" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-003-0007572"/> <productie cidn="2009-P-047-0013223" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-047-0013223"/> <productie cidn="2009-P-064-0002475" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-064-0002475"/> <productie cidn="2009-P-003-0007567" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-003-0007567"/> </producties>
In de browser verschijnt het resultaat in de vorm van een XML.
Het ziet er wat 'HTMLerig' uit, maar dat lossen we straks op.
Er zijn 2000 producties, getoond worden 10 stuks, te beginnen met 0. (default instelling Publishing server).
Opmerking: voeg aan het einde van de URL, dus achter de key '&rows=100' toe. Dan krijg je de eerste honderd producties te zien.
Voorbeeld 2: Detailgegevens productie
De vraag:
- Geef mij de detailgegevens van de productie met CIDN nummer 2007-P-068-0001808.
LET OP: De verplichte key wordt er achter geplakt met ?key=ed....
http://feeds.uitburo.nl/1.0/producties/2007-P-068-0001808?key=ed79e27aedbe4a5824f70aaf5b2e9836
Het resultaat van deze specifieke productie ziet er ongeveer zo uit:
<productie cidn="2007-P-068-0001808" self="http://feeds.uitburo.nl/1.0/producties/2007-P-068-0001808"> <datum-aanmaak>2007-02-23T11:43:37.0Z</datum-aanmaak> <datum-wijziging>2009-02-10T16:27:43.003Z</datum-wijziging> <titel>Asterix en de Vikingen</titel> <subtitel> In het favoriete dorp van Gallië is iets bijzonders gebeurd. Hippi ... </subtitel> <taal id="1">nederlands</taal> <text type="samenvatting"> Een perfecte, spannende en in een vloeiende stijl gemaakte animatiefilm. Door een Deens bedrijf op 'ouderwetse' wijze met de hand hebben getekend. </text> <text type="inhoud"> In het favoriete dorp van Gallië is iets bijzonders gebeurd. Hippix, het stoere neefje van de baas, is net aangekomen uit de grote stad Parisium. Asterix en Obelix hebben de onmogelijke taak gekregen van hem een echte man te maken, maar in Hippix schuilt een enorme lafaard en de harde training die hij krijgt, verandert hier weinig aan. Intussen zijn de Vikingen aan land gekomen in Gallië, vastbesloten om deze kampioen van angst te vinden. Deze zal hen namelijk, zoals voorspeld door hun helderziende, leren vliegen. </text> <hoofdgenre id="1">Film</hoofdgenre> <genres> <genre id="2">Film</genre> </genres> <gezelschappen> <gezelschap/> </gezelschappen> <medewerkers/> <impresariaten> <impresariaat/> </impresariaten> <urls/> <seizoen/> <trefwoorden/> <uitburo ref="http://www.uitburo.nl/dsp_productie.cfm?prodid=EE32C1C6-9AF1-F913-66BE51D1EDD3EC4D"/> </productie>
Voorbeeld 3: Producties met text filter
De vraag:
- Geef mij de producties met de woorden die beginnen met 'pop' en waar bovendien het woord 'leuk' in voorkomt.
LET OP: De verplichte key wordt er achter geplakt met ?key=ed....
http://feeds.uitburo.nl/1.0/producties?text=pop*ANDleuk&key=ed79e27aedbe4a5824f70aaf5b2e9836
Dit resulteerd in een lijst met producties waarin het woordje pop en leuk voorkomt:
<producties hits="11" rows="10" start="0" self="http://feeds.uitburo.nl/1.0/producties"> <productie cidn="2008-P-001-0058631" ref="http://feeds.uitburo.nl/1.0/producties/2008-P-001-0058631"/> <productie cidn="2008-P-077-0001334" ref="http://feeds.uitburo.nl/1.0/producties/2008-P-077-0001334"/> <productie cidn="2008-P-041-0067299" ref="http://feeds.uitburo.nl/1.0/producties/2008-P-041-0067299"/> <productie cidn="2007-P-041-0001214" ref="http://feeds.uitburo.nl/1.0/producties/2007-P-041-0001214"/> <productie cidn="2009-P-041-0076046" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-041-0076046"/> <productie cidn="2008-P-041-0074679" ref="http://feeds.uitburo.nl/1.0/producties/2008-P-041-0074679"/> <productie cidn="2009-P-003-0007625" ref="http://feeds.uitburo.nl/1.0/producties/2009-P-003-0007625"/> <productie cidn="2008-P-041-0074683" ref="http://feeds.uitburo.nl/1.0/producties/2008-P-041-0074683"/> <productie cidn="2008-P-041-0062305" ref="http://feeds.uitburo.nl/1.0/producties/2008-P-041-0062305"/> <productie cidn="2005-P-064-0000429" ref="http://feeds.uitburo.nl/1.0/producties/2005-P-064-0000429"/> </producties>
Om te controleren of de woorden ook daadwerkelijk in de productie voorkomen bekijken we een willekeurig resultaat.
http://feeds.uitburo.nl/1.0/producties/2008-P-077-0001334?key=ed79e27aedbe4a5824f70aaf5b2e9836
Het resultaat bevat beide woorden.
<productie cidn="2008-P-077-0001334" self="http://feeds.uitburo.nl/1.0/producties/2008-P-077-0001334"> <datum-aanmaak>2008-11-26T16:32:40.003Z</datum-aanmaak> <datum-wijziging>2009-02-03T16:10:45.997Z</datum-wijziging> <titel>Winterbal 4 </titel> <subtitel>Ballroom met live muziek en act</subtitel> <taal id="1">nederlands</taal> <text type="samenvatting"> Ballroom met live muziek en verassende openingsact! </text> <text type="inhoud"> Dat ook de winter zijn charmes heeft ervaar je op het Winterbal! We beginnen het Winterbal met een verrassende openingsact, een leuke opwarmer voordat je zelf de dansvloer op kan. Onder leiding van Lex van Wel speelt tijdens het Winterbal het 10 mans orkest Lex van Wel and his Swing Orchestra. Van Motown tot softjazz, van popmuziek tot evergreens. Je wordt omhult met sfeervolle klanken, die je eindeloos meevoeren in een aangename warme atmosfeer.... Zowel voor de geoefende als voor de roestige heupen! </text> <hoofdgenre id="1">Dans</hoofdgenre> <genres> <genre id="2">Dans</genre> </genres> <gezelschappen> <gezelschap/> </gezelschappen> <medewerkers/> <impresariaten> <impresariaat/> </impresariaten> <media type="afbeelding" ref="http://uitbase.aub.nl/gfx/content/lexvanwel1.jpg"> <uitgave>uitburo.nl</uitgave> <alt/> <bron/> <beschrijving/> </media> <urls/> <seizoen/> <trefwoorden/> <uitburo ref="http://www.uitburo.nl/dsp_productie.cfm?prodid=D96C1903-9E5B-2481-2100FCAE44CCF48B"/> </productie>
Voorbeeld 4: Geen geldige key opgegeven
Ik heb een lijst met de eerste 10 producties (het eindresultaat van het eerste voorbeeld). "Geef mij de detailgegevens van de eerste productie uit de lijst." Eigenlijk is de vraag: "Geef mij de deltailgegevens van productie met CIDN 2000-P-001-0002231"
http://feeds.uitburo.nl/1.0/producties/2000-P-001-0002231
Het resultaat is 'HTTP error 403'. Access denied, oftewel toegang geweigerd.
Achter deze vraag moet de key weer geplakt worden:
http://feeds.uitburo.nl/1.0/producties/2000-P-001-0002231?key=ed79e27aedbe4a5824f70aaf5b2e9836
Indien meerdere parameters worden meegegeven is deze van de vorm
&key=ed79e27aedbe4a5824f70aaf5b2e9836
Als het de enige parameter is, wordt de "&" vervangen door een "?"
?key=ed79e27aedbe4a5824f70aaf5b2e9836
deze voorbeelden geven een snel inzicht in hoe de Publishingserver werkt. Klik op een van de onderstaande links.
Het resultaat is een XML met daarin het resultaat van de gestelde vraag (boven in de adresbalk van de browser is de gestelde vraag te zien). Default worden maximaal 10 resultaten getoond. Het enige wat er dan nog gebeuren moet is het vertalen van de XML in een lijst met resultaten in een mooie opmaak. Een voorbeeld van hoe die opmaak te creeren is te vinden onder "code"
