Centrale Databank API

Centrale Databank API Documentatieset API Versie 1.2.x

© Multimove webworks Datum: Auteur: Versie:

21-1-2014 Sander Beck 1.2.19

Inhoudsopgave 1

2

Inleiding ........................................................................................................................................... 2 1.1

Beschikbaarheid ...................................................................................................................... 2

1.2

Technische details ................................................................................................................... 2

Authenticatie ................................................................................................................................... 3 2.1

3

Rechten en levels .................................................................................................................... 3

API acties ......................................................................................................................................... 4 3.1

Resultaten ............................................................................................................................... 4

3.2

URL Overzicht .......................................................................................................................... 5

4

Resultaatcodes .............................................................................................................................. 36

5

Voorbeeldcode PHP....................................................................................................................... 37

6

API changes ................................................................................................................................... 38

Bijlage 1: Participant categories icons ................................................................................................... 40 Bijlage 2: Participant facility icons ......................................................................................................... 42 Bijlage 3: Participant category group icons ........................................................................................... 43 Bijlage 4: Event categories icons ........................................................................................................... 44 Bijlage 5: Image handler parameters .................................................................................................... 45 Bijlage 6: Schematische weergave gegevensstromen........................................................................... 46

Multimove webworks

CDB API 1.2

Pagina 1 van 46

1

Inleiding

Dit document beschrijft de werking van de Centrale Databank API, vanaf nu te noemen CDB API of kortweg API. Deze API geeft aan externe partijen de mogelijkheid om gegevens op te halen, aan te maken of te beheren. De beschikbare mogelijkheden zijn afhankelijk van de rechten van de gebruiker. De API geeft de mogelijkheid om één-op-één toevoegingen, wijzigingen of verwijderingen in de CDB uit te voeren. Bij het uitvoeren van een dergelijke opdracht wordt ook direct een response teruggegeven of de verwerking geslaagd is.

1.1

Beschikbaarheid

De API is beschikbaar via de volgende URL(s): Omgeving Productie Staging Acceptatie

URL (root) Niet beschikbaar Niet beschikbaar http://rbtonline.nl/api/v1

Om gebruik te kunnen maken van de API dient u te beschikken over een ‘x-apiauthenticationkey’. Hiervoor kunt u contact opnemen met Multimove Webworks, via [email protected]

1.2

Technische details

De API is gebaseerd op het REST-principe waarbij met verschillende URL`S en HTTP methods objecten kunnen worden aangemaakt, verwijderd, opgevraagd en aangepast. De parameters worden in de URL opgenomen en de benodigde data kan via een POST aan de HTTP-request meegegeven worden. De data opslag werkt m.b.v. de ISO-8859-1 karakterset, data moet ook in deze karakterset aan de API aangeboden worden. Indien de aangeboden data speciale karakters bevat worden deze mogelijkerwijs omgezet naar HTML-karakters. De output van de API zal in het geval van de JSON uitvoer speciale karakters als HTML-encoded strings terug geven. In het geval van XML uitvoer zal de output als UTF-8 string teruggegeven worden, met uitzonderen van in XML zijnde "predefined entities” (", &, ', < en >) welke wel als HTML entities worden teruggegeven. Zie ook: http://nl.wikipedia.org/wiki/ISO_8859-1

Multimove webworks

CDB API 1.2

Pagina 2 van 46

2

Authenticatie

Voor de authenticatie moet een header parameter aan de request meegegeven worden, de ‘x-apiauthenticationkey’. Deze unieke key is partner gebonden en kan worden verkregen via Multimove. Het is niet toegestaan deze key aan derden te verstrekken. Via de key worden gebruiksstatistieken opgeslagen.

2.1

Rechten en levels

Doormiddel van de ‘x-apiauthenticationkey’ header worden de rechten bepaald. Per API-key wordt ingesteld welke methodes beschikbaar zijn (GET, POST, DELETE). Ook heeft elke gebruiker zijn eigen user-level en wordt per regio ingesteld of er bewerk-rechten zijn. Met maximaal aantal aanvragen per uur is eveneens gekoppeld aan de authenticationkey. De volgende user levels zijn beschikbaar: Level 0 1 2

Omschrijving Gebruiker (bv. Externe export) Hoofdgebruiker (bv. Vechtdal Overijssel) Administrator (bv. Multimove)

De volgende regio selecties zijn beschikbaar: ID 2

Regio/site IJsseldelta

Domein ontdekdeijsseldelta.nl

3 4 16 21

Vechtdal Waterreijk Hengelo Salland

vechtdaloverijssel.nl waterreijk.nl bureauhengelo.nl sallandnatuurlijkgastvrij.nl

22 24

Deventer Reestdal

vvvdeventer.nl

Multimove webworks

Opmerking Bevat ook deelnemers en evenementen afkomstig van zwolletouristinfo.nl (import)

Bevat ook evenementen afkomstig van vvvhellendoorn.nl en toerismerh.nl (import) Fictieve site, toont deels gegevens van Vechtdal. Voor export doeleinden.

CDB API 1.2

Pagina 3 van 46

3

API acties

De API bevat methoden om deelnemers/ondernemers en evenementen toe te voegen, aan te passen en te verwijderen. Het toevoegen of verwijderen van meerdere items in bulk is via de API niet mogelijk. De services worden hieronder beschreven aan de hand van de pad-definitie in hun resource adres. Het resource adres is het http adres waarop de service bereikbaar is, meer bepaald de URL. De pad definitie is het gedeelte achter de “prefix” die aan alle aan te roepen methodes voorafgaat.

3.1

Resultaten

Achter elke URL aanroep dient het gewenste resultaatformaat opgegeven te worden, op dit moment is er de keuze tusssen .xml of .json De resultaten worden altijd in een vaste opbouw teruggegeven. Basis opbouw XML

Basis opbouw JSON

{resultaatcode} <{data_name}> <{veldnaam}>{Inhoud} <{veldnaam}>{Inhoud} … …

{ "code":{resultaatcode}, "data":{ "{data_name}":[ { "{veldnaam}":{Inhoud}, "{veldnaam}":{Inhoud}, … } … } }

De naamgeving van het in bovenstaande tabel genoemde ‘data_name’ element wordt automatisch bepaald, afhankelijk van de request. Worden er bijvoorbeeld categorieën opgevraagd zal dit element de naam ‘categories’ krijgen, worden er afbeeldingen opgevraagd zal dit element de naam ‘images’ krijgen etc. Het is mogelijk de naamgeving van het element ‘data_name’ aan te passen. Gebruik hiervoor de queryparameter data_name. Let er op dat de naamgeving alleen mag bestaan uit letters, cijfers een liggend streepje (-) of een underscore (_). Bij resultsets met meerdere resultaten (items) zijn aanvullende query paramaters beschikbaar: order sort, count, page en offset. Indien bij sort de waarde ‘rand’ wordt meegegeven worden de resultaten in random volgorde teruggegeven, de random sortering wisselt per sessie (indien beschikbaar). Bij enkele aanroepen zijn nog meer aanvullende query paramaters beschikbaar, deze worden per onderdeel behandeld.

Multimove webworks

CDB API 1.2

Pagina 4 van 46

3.2

URL Overzicht

De API geeft de mogelijkheid om deelnemers en evenementen te beheren. In dit hoofdstuk worden alle mogelijke URL aanvragen uiteengezet. 1

2

1

In de URL overzichten kan bij de methode een of staan. Deze waardes slaan op de API user levels. Een 2 betekend dat de methode toegankelijk is voor API users met level-1 (hoofdgebruiker) of hoger, een geeft aan dat de methode toegankelijk is voor users met level-2 (administrator) of hoger. 1

2

A

B

A

Naast de of kan ook een of in het overzicht staan. Een betekend dat de actie alleen toegestaan is als de API user bewerk rechten heeft tot de betreffende site. Het laatste is alleen van toepassing op deelnemers en aanverwante onderdelen. De meeste aanroepen worden voorafgegaan door een taalselectie, dit staat in onderstaande URL aanroepen gespecificeerd als {LANG}. Hier dient de gewenste taal-code ingevoerd te worden. De volgende talen/codes zijn beschikbaar: Code NL DE EN

ID 1 3 2

Omschrijving Nederlands Duits Engels

NOTE: deelnemers (participants) ondersteunen op dit moment alleen Nederlands.

Multimove webworks

CDB API 1.2

Pagina 5 van 46

3.2.1 Sites interface Sites zijn de aan de centrale databank gekoppelde websites/regios. Elke website heeft een eigen domeinnaam en regionaam. Deelnemers en evenementen kunnen op meerdere sites zichtbaar worden gemaakt. Er kunnen via de API geen nieuwe sites aangemaakt worden. Bijvoorbeeld: vvvzwolle.nl , vvvdeventer.nl, sallandnatuurlijkgastvrij.nl, etc. Method GET GET GET

URL /sites /sites/{site_id} /{lang}/events/{event_id}/sites

GET

/{lang}/participants/{participant_id}/sites

POST

1A

1A

DELETE

POST-data

/{lang}/participants/{participant_id}/sites/{sit e_id} /{lang}/participants/{participant_id}/sites/{sit e_id}

Multimove webworks

CDB API 1.2

Actie Opvragen sites Opvragen site Opvragen sites waaraan evenement is gekoppeld Opvragen sites waaraan deelnemer is gekoppeld Site toevoegen aan deelnemer Site verwijderen van deelnemer

Pagina 6 van 46

3.2.2 Places interface De beschikbare plaatsnamen in de databank. Een plaats heeft een naam, gemeente, provincie en land. Er zijn binnen de databank enkele plaatsen in Duitsland aanwezig. Deelnemers en evenementen zijn aan een plaats (ID) gekoppeld. Plaatsen kunnen via de API niet toegevoegd worden. Bijvoorbeeld: Slagharen, Twello, Zwolle, etc. Method GET GET

URL /places /places/{place_id}

Multimove webworks

POST-data

CDB API 1.2

Actie Opvragen plaatsen Opvragen plaats

Pagina 7 van 46

3.2.3 Participant categories interface De categorieën waaraan een deelnemer kan worden toegekend, een deelnemer kan aan meerdere categorieën gekoppeld worden. Bijvoorbeeld: Hotels, Cafés, Musea, etc. Method GET

URL /{lang}/participant-categories

GET GET

/{lang}/participant-categories/{category_id} /{lang}/participants/{participant_id}/categori es /sites/{site_id}/{lang}/participantgroups/{group_id}/categories /{lang}/participant-categories

GET POST

2

POST

2

POST-data

/{lang}/participant-categories/{category_id} 2

DELETE 1A POST

1A

DELETE

Actie Opvragen categorieën

Opvragen categorie Opvragen categorieën deelnemer Opvragen categorieën binnen categorie-groep Aanmaken categorie

name desc icon name desc icon

Bewerken categorie

/{lang}/participant-categories/{category_id} /{lang}/participants/{participant_id}/categori es/{category_id} /{lang}/participants/{participant_id}/categori es/{category_id}

Parameter name desc icon

Multimove webworks

Description Naam Omschrijving Icoon ID range 0-68 (zie bijlage)

CDB API 1.2

Verwijderen categorie Categorie toevoegen aan deelnemer Categorie verwijderen van deelnemer

Type string string integer

Verplicht nee nee nee

Default

0

Pagina 8 van 46

3.2.4 Participant category images interface Afbeeldingen van categorieën, in range 0-0 (image_number). Als resultaat wordt de rechtstreekste URL naar de afbeelding teruggegeven evenals een URL waarmee de afbeelding realtime kan worden geschaald/bewerkt (zie bijlage). Er is maximaal 1 afbeeldingen per categorie toegestaan, de afbeeldingen zijn site specifiek. Bijvoorbeeld: http://www.rbtonline.nl/storage/participants/categories/1-42-0.jpg Method GET GET

POST

1A

1A

DELETE

URL /sites/{site_id}/{lang}/participantcategories/{category_id}/images /sites/{site_id}/{lang}/participantcategories/{category_id}/images/{image_nu mber} /sites/{site_id}/{lang}/participantcategories/{category_id}/images/{image_nu mber} /sites/{site_id}/{lang}/participantcategories/{category_id}/images/{image_nu mber}

Parameter image

Multimove webworks

Description Afbeelding (JPG of JPEG)

POST-data

Actie Opvragen afbeeldingen categorie Opvragen afbeelding categorie

image

Afbeelding aan categorie toevoegen, of overschrijven Afbeelding van categorie verwijderen

Type file

CDB API 1.2

Verplicht ja

Default

Pagina 9 van 46

3.2.5 Participant category groups interface Een categoriegroep is een samenvoeging van categorieën. Categoriegroepen zijn site specifiek en worden vooral gebruikt als selectie middel. Bijvoorbeeld: Slapen, Zien & Doen, Kunst & Cultuur etc. Method GET

URL /sites/{site_id}/{lang}/participant-groups

GET

/sites/{site_id}/{lang}/participantgroups/{group_id} /sites/{site_id}/{lang}/participant-groups

POST

1A

POST

1A

/sites/{site_id}/{lang}/participantgroups/{group_id} 1A

DELETE POST

1A

1A

DELETE

POST-data

Actie Opvragen categoriegroepen van site Opvragen categoriegroep Aanmaken categoriegroep

name desc on_map icon name desc on_map icon

Bewerken categoriegroep

Verwijderen categoriegroep Categorie toevoegen aan categorie-groep Categorie verwijderen uit categorie-groep

/sites/{site_id}/{lang}/participantgroups/{group_id} /sites/{site_id}/{lang}/participantgroups/{group_id}/categories/{categorie_id} /sites/{site_id}/{lang}/participantgroups/{group_id}/categories/{categorie_id}

Parameter name desc on_map

icon

Multimove webworks

Description Naam Omschrijving Geeft aan of de groep getoond moet worden op de interactieve kaart. 0: Nee 1: Ja Icoon ID range 0-0

CDB API 1.2

Type string string integer

Verplicht nee nee nee

Default

integer

nee

0

0

Pagina 10 van 46

3.2.6 Participant category group images interface Afbeeldingen van categoriegroepen, in range 0-0 (image_number). Als resultaat wordt de rechtstreekste URL naar de afbeelding teruggegeven evenals een URL waarmee de afbeelding realtime kan worden geschaald/bewerkt (zie bijlage). Er is maximaal 1 afbeeldingen per groep toegestaan, de afbeeldingen zijn net als categoriegroepen site specifiek. Bijvoorbeeld: http://www.rbtonline.nl/storage/participants/groups/1-42-0.jpg Method GET

URL /sites/{site_id}/{lang}/participantgroups/{group_id}/images

GET

/sites/{site_id}/{lang}/participantgroups/{group_id}/images/{image_number} /sites/{site_id}/{lang}/participantgroups/{group_id}/images/{image_number}

POST

1A

1A

DELETE

POST-data

Actie Opvragen afbeeldingen categoriegroep Opvragen afbeelding categoriegroep Afbeelding aan categoriegroep toevoegen, of overschrijven Afbeelding van categoriegroep verwijderen

image

/sites/{site_id}/{lang}/participantgroups/{group_id}/images/{image_number}

Parameter image

Multimove webworks

Description Afbeelding (JPG of JPEG)

Type file

CDB API 1.2

Verplicht ja

Default

Pagina 11 van 46

3.2.7 Participant locations interface De beschikbare locatie-types in de databank. Een deelnemer kan gekoppeld worden aan meerdere locaties. Bijvoorbeeld: Aan/bij zee, In centrum, Landelijk gelegen etc. Method GET GET GET

URL /{lang}/participant-locations /{lang}/participant-locations/{location_id} /{lang}/participants/{participant_id}/locations

POST-data

name desc name desc

POST

2

/{lang}/participant-locations

POST

2

/{lang}/participant-locations/{location_id} 2

DELETE POST

1A

Actie Opvragen locatie-types Opvragen locatie-type Opvragen locatietypes deelnemer Aanmaken locatie-type Bewerken locatie-type Verwijderen locatietype Locatie-type toevoegen aan deelnemer Locatie-type verwijderen van deelnemer

/{lang}/participant-locations/{location_id} /{lang}/participants/{participant_id}/locations /{location_id}

1A

DELETE

/{lang}/participants/{participant_id}/locations /{location_id}

Parameter name desc

Multimove webworks

Description Naam Omschrijving

Type string string

CDB API 1.2

Verplicht nee nee

Default

Pagina 12 van 46

3.2.8 Participant facilities interface De beschikbare faciliteit-types in de databank. Een deelnemer kan gekoppeld worden aan meerdere faciliteiten. Bijvoorbeeld: Lift, Fitness, Bar, etc. Method GET

URL /{lang}/participant-facilities

POST-data

GET

/{lang}/participant-facilities/{facility_id}

GET

/{lang}/participants/{participant_id}/facilities

POST

2

/{lang}/participant-facilities

POST

2

/{lang}/participant-facilities/{facility_id} 2

DELETE POST

1A

Actie Opvragen faciliteittypes Opvragen faciliteittype Opvragen faciliteittypes deelnemer Aanmaken faciliteittype

name desc icon name desc icon

Bewerken faciliteittype

/{lang}/participant-facilities/{facility_id}

Verwijderen faciliteittype Faciliteit-type toevoegen aan deelnemer Faciliteit-type verwijderen van deelnemer

/{lang}/participants/{participant_id}/facilities/ {facility_id} 1A

DELETE

/{lang}/participants/{participant_id}/facilities/ {facility_id}

Parameter name desc icon

Multimove webworks

Description Naam Omschrijving Icoon ID range 0-0 (zie bijlage)

CDB API 1.2

Type string string integer

Verplicht nee nee nee

Default

0

Pagina 13 van 46

3.2.9 Participant accessibilities interface De beschikbare toegankelijkheid-types in de databank, onder andere voor mensen met een visuele of auditieve beperking. De data wordt mede onderhouden door ongehinderd.nl. Een deelnemer kan gekoppeld worden aan meerdere toegankelijkheid-types. Bijvoorbeeld: Rolstoeltoegankelijk, Invalidentoilet, Toegankelijk terras, etc. Method GET

URL /{lang}/participant-accessibilities

GET

/{lang}/participantaccessibilities/{accessibility_id} /{lang}/participants/{participant_id}/ accessibilities

GET

POST

2

/{lang}/participant-accessibilities

POST

2

/{lang}/participantaccessibilities/{accessibility_id} /{lang}/participantaccessibilities/{accessibility_id} /{lang}/participants/{participant_id}/ accessibilities/{accessibility_id}

1A

/{lang}/participants/{participant_id}/ accessibilities/{accessibility_id}

1A

DELETE

Parameter name desc image_url

Multimove webworks

Actie Opvragen toegankelijkheid-types Opvragen toegankelijkheid-type Opvragen toegankelijkheid-types deelnemer Aanmaken toegankelijkheid-type

name desc image_url name desc image_url

2

DELETE POST

POST-data

Description Naam Omschrijving Link naar icoon (webadres)

Bewerken toegankelijkheid-type Verwijderen toegankelijkheid-type Toegankelijkheid-type toevoegen aan deelnemer Toegankelijkheid-type verwijderen van deelnemer

Type string string string

CDB API 1.2

Verplicht nee nee nee

Default

Pagina 14 van 46

3.2.10 Participant capacities interface De beschikbare capaciteit-types in de databank. Een deelnemer kan gekoppeld worden aan meerdere capaciteiten, bij het koppelen van een capaciteit dient er een numerieke waarde opgegeven te worden. Bijvoorbeeld: Aantal bedden, Aantal etages, Aantal vergaderzalen, etc. Method GET

URL /{lang}/participant-capacities

GET

/{lang}/participant-capacities /{capacity_id}

GET

/{lang}/participants/{participant_id}/capacitie s /{lang}/participant-capacities

POST

2

POST

2

/{lang}/participant-capacities /{capacity_id} 2

DELETE POST

POST-data

1A

1A

name desc name desc

/{lang}/participant-capacities /{capacity_id} /{lang}/participants/{participant_id}/capacitie s/{capacity_id}

DELETE

Actie Opvragen capaciteittypes Opvragen capaciteittype Opvragen capaciteittypes deelnemer Aanmaken capaciteittype Bewerken capaciteittype Verwijderen capaciteittype Capaciteit-type toevoegen aan deelnemer Capaciteit -type verwijderen van deelnemer

value

/{lang}/participants/{participant_id}/capacitie s/{capacity_id}

Parameter name desc value

Multimove webworks

Description Naam Omschrijving Aantal

Type string string integer

CDB API 1.2

Verplicht nee nee nee

Default

0

Pagina 15 van 46

3.2.11 Participant restaurants interface De beschikbare restaurant-types in de databank. Een deelnemer kan gekoppeld worden aan meerdere types. Bijvoorbeeld: Italiaans, Frans, Pannenkoek, etc. Method GET

URL /{lang}/participant-restaurants

GET

/{lang}/participant-restaurants /{restaurant_id} /{lang}/participants/{participant_id}/restaura nts /{lang}/participant-restaurants

GET POST

2

POST

2

2

DELETE POST

1A

1A

DELETE

POST-data

/{lang}/participant-restaurants /{restaurant_id} /{lang}/participant-restaurants /{restaurant_id} /{lang}/participants/{participant_id}/restaura nts/{restaurant_id}

Actie Opvragen restauranttypes Opvragen restauranttype Opvragen restauranttypes deelnemer Aanmaken restauranttype Bewerken restauranttype Verwijderen restaurant-type Restaurant-type toevoegen aan deelnemer Restaurant-type verwijderen van deelnemer

name desc name desc

/{lang}/participants/{participant_id}/restaura nts/{restaurant_id}

Parameter name desc

Multimove webworks

Description Naam Omschrijving

Type string string

CDB API 1.2

Verplicht nee nee

Default

Pagina 16 van 46

3.2.12 Participant diets interface De beschikbare dieet-types in de databank. Een deelnemer kan gekoppeld worden aan meerdere types. Bijvoorbeeld: Glutenvrij, Halal, Lactosevrij, etc. Method GET GET GET

URL /{lang}/participant-diets /{lang}/participant-diets/{diet_id} /{lang}/participants/{participant_id}/diets

POST-data

name desc name desc

POST

2

/{lang}/participant-diets

POST

2

/{lang}/participant-diets/{diet_id} 2

DELETE 1A POST

1A

DELETE

Actie Opvragen dieet-types Opvragen dieet-type Opvragen dieet-types deelnemer Aanmaken dieet-type Bewerken dieet-type

/{lang}/participant-diets/{diet_id} /{lang}/participants/{participant_id}/diets/{di ets_id} /{lang}/participants/{participant_id}/diets/{di et_id}

Parameter name desc

Multimove webworks

Description Naam Omschrijving

Verwijderen diet-type Diet-type toevoegen aan deelnemer Dieet-type verwijderen van deelnemer

Type string string

CDB API 1.2

Verplicht nee nee

Default

Pagina 17 van 46

3.2.13 Participant rights interface De beschikbare recht-types per deelnemer. De rechten zijn alleen van invloed op de beheers omgeving van de desbetreffende deelnemer, de ingestelde rechten worden niet gecontroleerd bij het gebruik van deze API. Bijvoorbeeld: Arrangementen, Locaties, Kamers, etc. Method GET GET GET POST

1A

URL /participant-rights /participant-rights /{right_id} /{lang}/participants/{participant_id}/rights /{lang}/participants/{participant_id}/rights/{ri ght_id}

1A

DELETE

/{lang}/participants/{participant_id}/rights/{ri ght_id}

Multimove webworks

CDB API 1.2

POST-data

Actie Opvragen recht-types Opvragen recht-type Opvragen recht-types deelnemer Rechten-type toevoegen aan deelnemer Rechten-type verwijderen van deelnemer

Pagina 18 van 46

3.2.14 Participants interface De deelnemers in de databank, een deelnemer kan aan meerdere sites gekoppeld worden. Nadat een deelnemer is aangemaakt moet deze nog aan een categorie gekoppeld worden, ook moeten de sites waarop de deelnemer zichtbaar moet worden nog toegekend worden. Zonder een gekoppelde categorie en site wordt een deelnemer niet zichtbaar. Bijvoorbeeld: Attractiepark slagharen, Theater de Voorveghter, Foto Theo, etc. Multiple URL requests Bij het opvragen van (meerdere) deelnemers kunnen ‘categorie_id’, ‘site_id’ en ‘place_id’ in de URL meerdere waardes bevatten, deze dienen gescheiden te worden door een komma. Bijvoorbeeld: /nl/participants/categories/1,2,4.xml In dit geval zullen alle deelnemer met categorie 1, 2 én 4 worden opgehaald. Aanvullende query parameters Om te zoeken binnen deelnemers kan een aanvullende ‘search’ variabele worden meegegeven aan de URL. Bijvoorbeeld: /nl/participants.xml?search=hotel In dit geval zullen de deelnemers van site 2 worden opgehaald, mits ergens in de content het woorddeel ‘hotel’ voorkomt. Met de paramaters highlight_level1 en highlight_level2 kunnen deelnemers opgehaald worden die uitgelicht moeten worden. Bijvoorbeeld: /nl/participants.xml?highlight_level1=1 of /nl/participants/categories/28.xml?highlight_level2=1 In dit geval worden alle deelnemers opgehaald welke op het hoofdniveau uitgelicht worden. Het tweede voorbeeld haalt alle deelnemers op die binnen de categorie ‘appartementen’ (=28) uitgelicht worden. Met de since_id paramater worden alleen items opgehaald die nieuwer zijn dan het opgegeven ID (integer), hoe hoger het ID hoe nieuwer. De parameter import_id maakt het mogelijk items op te halen met dit import_id, dit kan bijvoorbeeld nodig zijn om te controleren of een item reeds is toegevoegd, gebruik dit dan i.c.m. de paramater source. Met de paramater source kunnen evenementen opgehaald worden die afkomstig zijn vanaf een bepaalde import. Method GET GET GET

URL /{lang}/participants /{lang}/participants/{participant_id} /{lang}/participants/categories/{categorie_id}

GET

/sites/{site_id}/{lang}/participants

GET

/sites/{site_id}/{lang}/participants/categories /{categorie_id}

GET

/sites/{site_id}/places/{place_id}/{lang}/partic ipants/categories/{category_id}

GET

/sites/{site_id}/places/{place_id}/{lang}/partic ipants

Multimove webworks

CDB API 1.2

POST-data

Actie Opvragen deelnemers Opvragen deelnemer Opvragen deelnemers met categorie Opvragen deelnemers van site Opvragen deelnemers binnen een site en met categorie Opvragen deelnemers binnen een site in plaats met categorie Opvragen deelnemers binnen site en in plaats

Pagina 19 van 46

GET GET

/places/{place_id}/{lang}/participants /places/{place_id}/{lang}/participants/categor ies/{category_id}

GET

/{lang}/events/{event_id}/participants

GET

/sites/{site_id}/{lang}/participants/groups/{gr oup_id} /{lang}/participants

POST

1A

POST

1A

/{lang}/participants/{participant_id}

Multimove webworks

CDB API 1.2

name street postal place_id latitude longitude phone fax www calltoaction virtualtour email keywords desc quality password reviewgadget opening source owner highlight_level1 highlight_level2 score_manual lifestyle_score1 lifestyle_score2 lifestyle_score3 lifestyle_score4 lifestyle_score5 lifestyle_score6 lifestyle_score7 relevance star_rating import_id name street postal place_id latitude longitude phone fax www calltoaction virtualtour email keywords desc quality password

Deelnemers in plaats Opvragen deelnemers in plaats en met categorie Deelnemers gekoppeld aan evenement Deelnemers in groep binnen een site Aanmaken deelnemer

Bewerken deelnemer

Pagina 20 van 46

reviewgadget opening source owner highlight_level1 highlight_level2 score_manual lifestyle_score1 lifestyle_score2 lifestyle_score3 lifestyle_score4 lifestyle_score5 lifestyle_score6 lifestyle_score7 relevance star_rating import_id 1A

DELETE

/{lang}/participants/{participant_id}

Parameter name street postal place_id latitude longitude phone fax www calltoaction virtualtour email keywords desc quality password reviewgadget opening source owner highlight_level1

highlight_level2

score_manual lifestyle_score1 lifestyle_score2 Multimove webworks

Verwijderen deelnemer

Description Naam Straat + huisnummer Postcode Plaats ID Breedtegraad Lengtegraad Telefoonnummer Fax Website adres (zonder http://) Website adres voor Call to Action (zonder http://) Webadres virtuele tour (zonder http://) E-mailadres Keywords Omschrijving Kwaliteitsaanduiding. Bv: ‘Vier tulpen genomineerd’ Wachtwoord Plaats hier HTML code voor de reviewgadget Bijvoorbeeld van Zoover. Openingstijden Bron Eigenaar van deelnemer (regio ID) Deelnemer uitlichten op de hoofd niveau 0: nee 1: ja Deelnemer uitlichten op de categorie niveau 0: nee 1: ja Handmatige score Uitbundig geel range 0-10 Gezellig lime CDB API 1.2

Type string string string integer string string string string string string string string string string string

Verplicht nee nee nee ja nee nee nee nee nee nee nee nee nee nee nee

Default

string string

nee nee

*****

string string integer integer

nee nee ja nee

0

integer

nee

0

integer integer

nee nee

0 0

integer

nee

0 Pagina 21 van 46

lifestyle_score3 lifestyle_score4 lifestyle_score5 lifestyle_score6 lifestyle_score7 relevance

star_rating

import_id

Multimove webworks

range 0-10 Avontuurlijk paars range 0-10 Ingetogen aqua range 0-10 Rustig groen range 0-10 Stijlvol & Luxe Blauw range 0-10 Creatief & Inspirerend rood range 0-10 Geeft de relevantie/allure aan van een deelnemer 0: Lokaal 1: Regionaal 2: Nationaal 3: Internationaal 0: Geen classificatie 1: * sterren 2: ** sterren 3: *** sterren 4: **** sterren 5: ***** sterren ID afkomstig van een eventuele import. In geval van import moet deze waarde uniek zijn in combinatie met ‘source’

CDB API 1.2

integer

nee

0

integer

nee

0

integer

nee

0

integer

nee

0

integer

nee

0

integer

nee

1

integer

nee

0

integer

nee

0

Pagina 22 van 46

3.2.15 Participant rooms interface Kamers van een deelnemer. Bijvoorbeeld: 1-persoonskamer, bruidssuite etc. Method GET

URL /{lang}/participants/{participant_id}/rooms

GET

/{lang}/participants/{participant_id}/rooms/{r oom_id} /{lang}/participants/{participant_id}/rooms

POST

1A

POST

1A

/{lang}/participants/{participant_id}/rooms/{r oom_id}

1A

DELETE

POST-data

name content price price_type addition_price count persons sequence name content price price_type addition_price count persons sequence

addition_price count persons sequence

Multimove webworks

Description Naam Omschrijving Prijs in formaat: 0.00 0 of 1 0 = Prijs per nacht 1= Prijs per persoon per nacht Prijs toevoeging in formaat: 0.00 Aantal kamer van dit type Aantal personen Volgorde van kamer (voor weergave)

CDB API 1.2

Bewerken kamer van deelnemer

Verwijderen kamer van deelnemer

/{lang}/participants/{participant_id}/rooms/{r oom_id}

Parameter name content price price_type

Actie Opvragen kamers deelnemer Opvragen kamer deelnemer Toevoegen kamer aan deelnemer

Type string string string integer

Verplicht nee nee nee nee

Default

string integer integer integer

nee Nee nee nee

0.00 0 0 0

0.00 0

Pagina 23 van 46

3.2.16 Participant arrangements interface Arrangementen van een deelnemer. Bijvoorbeeld: Pinksterarrangement, Gastronomisch Weekend Arrangement, etc. Method GET

URL /{lang}/participants/{participant_id}/arrange ments

GET

/{lang}/participants/{participant_id}/ arrangements /{ arrangement_id} /{lang}/participants/{participant_id}/ arrangements

POST

1A

POST

1A

/{lang}/participants/{participant_id}/ arrangements /{ arrangement_id}

1A

DELETE

POST-data

name days content start_date end_date person_price twoperson_price sequence name days content start_date end_date person_price twoperson_price sequence

Multimove webworks

Description Naam Aantal dagen Omschrijving Startdatum in formaat UNIX timestamp Einddatum in formaat UNIX timestamp Prijs per persoon in formaat 0.00 Prijs per twee personen in formaat 0.00 Volgorde van arrangement (voor weergave)

CDB API 1.2

Bewerken arrangement

Verwijderen arrangement van deelnemer

/{lang}/participants/{participant_id}/ arrangements /{arrangement_id}

Parameter name days content start_date end_date person_price twoperson_price sequence

Actie Opvragen arrangementen deelnemer Opvragen arrangement deelnemer Toevoegen arrangement aan deelnemer

Type string integer string integer integer string string integer

Verplicht nee nee nee nee nee nee nee nee

Default 0 0 0 0.00 0.00 0

Pagina 24 van 46

3.2.17 Participant images interface Afbeeldingen van een deelnemer, in range 0-5 (image_number). Als resultaat wordt de rechtstreekste URL naar de afbeelding teruggegeven evenals een URL waarmee de afbeelding realtime kan worden geschaald/bewerkt (zie bijlage). Er zijn maximaal 5 afbeeldingen per deelnemer toegestaan. Bijvoorbeeld: http://www.rbtonline.nl/storage/participants/images/1083-0.jpg Method GET

URL /{lang}/participants/{participant_id}/images

GET

/{lang}/participants/{participant_id}/images/{ image_number} /{lang}/participants/{participant_id}/images/{ image_number}

POST

1A

1A

DELETE POST

1A

/{lang}/participants/{participant_id}/logos/{i mage_number} /{lang}/participants/{participant_id}/imagesqueue/{image_number}

Parameter image url

Multimove webworks

POST-data

image

url

Description Afbeelding (JPG of JPEG) Rechtstreekste link naar afbeelding (JPG of JPEG)

CDB API 1.2

Actie Opvragen afbeeldingen deelnemer Opvragen afbeelding deelnemer Afbeelding aan deelnemer toevoegen, of overschrijven Afbeelding van deelnemer verwijderen Externe afbeelding inladen via cronjobqueue

Type file string

Verplicht ja ja

Default

Pagina 25 van 46

3.2.18 Participant logos interface Logo`s van een deelnemer, in range 0-0 (logo_number). Als resultaat wordt de rechtstreekste URL naar het logo teruggegeven evenals een URL waarmee het logo realtime kan worden geschaald/bewerkt (zie bijlage). Er is maximaal 1 logo per deelnemer toegestaan. Bijvoorbeeld: http://www.rbtonline.nl/storage/participants/logos/1192.jpg Method GET

URL /{lang}/participants/{participant_id}/logos

GET

/{lang}/participants/{participant_id}/logos/{lo go_number} /{lang}/participants/{participant_id}/logos/{lo go_number}

POST

1A

1A

DELETE

POST-data

Actie Opvragen logos deelnemer Opvragen logo deelnemer Logo aan deelnemer toevoegen, of overschrijven Logo van deelnemer verwijderen

logo

/{lang}/participants/{participant_id}/logos/{lo go_number}

Parameter logo

Multimove webworks

Description Afbeelding (JPG of JPEG)

Type file

CDB API 1.2

Verplicht ja

Default

Pagina 26 van 46

3.2.19 Event categories interface De categorieën waaraan een evenement kan worden toegekend, een evenement kan aan één categorie gekoppeld worden. Bijvoorbeeld: Sport & Spel, Muziek, Markten, etc. Method GET GET 2 POST

POST

2

URL /{lang}/event-categories /{lang}/event-categories/{category_id} /{lang}/event-categories

/{lang}/event-categories/{category_id} 2

DELETE

POST-data

Actie Opvragen categorieën Opvragen categorie Aanmaken categorie

name desc icon name desc icon

Bewerken categorie

Verwijderen categorie

/{lang}/event-categories/{category_id}

Parameter name desc icon

Multimove webworks

Description Naam Omschrijving Icoon nummer range 0-12

Type string string integer

CDB API 1.2

Verplicht nee nee nee

Default

0

Pagina 27 van 46

3.2.20 Event category images interface Afbeeldingen van categorieën, in range 0-0 (image_number). Als resultaat wordt de rechtstreekste URL naar de afbeelding teruggegeven evenals een URL waarmee de afbeelding realtime kan worden geschaald/bewerkt (zie bijlage). Er is maximaal 1 afbeeldingen per categorie toegestaan, de afbeeldingen zijn site specifiek. Bijvoorbeeld: http://www.rbtonline.nl/storage/agenda/categories/1-42-0.jpg Method GET GET

POST

1A

1A

DELETE

URL /sites/{site_id}/{lang}/eventcategories/{category_id}/images /sites/{site_id}/{lang}/eventcategories/{category_id}/images/{image_nu mber} /sites/{site_id}/{lang}/eventcategories/{category_id}/images/{image_nu mber} /sites/{site_id}/{lang}/eventcategories/{category_id}/images/{image_nu mber}

Parameter image

Multimove webworks

Description Afbeelding (JPG of JPEG)

POST-data

Actie Opvragen afbeeldingen categorie Opvragen afbeelding categorie

image

Afbeelding aan categorie toevoegen, of overschrijven Afbeelding van categorie verwijderen

Type file

CDB API 1.2

Verplicht ja

Default

Pagina 28 van 46

3.2.21 Events interface De evenementen in de databank, een evenement kan aan meerdere sites gekoppeld worden. Nadat een evenement is aangemaakt moet deze nog aan site gekoppeld worden. Zonder een gekoppelde site wordt een evenement niet zichtbaar. Multiple URL requests Bij het opvragen van (meerdere) evenementen kunnen ‘categorie_id’, ‘site_id’ en ‘place_id’ in de URL meerdere waardes bevatten, deze dienen gescheiden te worden door een komma. Bijvoorbeeld: http://rbtonline.nl/api/v1/nl/events/categories/1,2,4.xml In dit geval zullen alle evenementen met categorie 1, 2 én 4 worden opgehaald. Aanvullende query parameters Om te zoeken binnen evenementen kan een aanvullende search variabele worden meegegeven aan de URL. Bijvoorbeeld: http://rbtonline.nl/api/v1/sites/2/nl/events.xml?search=kerst In dit geval zullen de evenementen van site 2 worden opgehaald, mits ergens in de content het woorddeel ‘kerst’ voorkomt. Er wordt gezocht m.b.v. LIKE “%xxx%” formaat. Standaard worden alle evenementen opgehaald, ongeacht de status ervan. Met de aanvullende query parameter active kan worden aangegeven of alle actieve (=0) of alle niet-actieve (=1) items opgehaald moeten worden. Bijvoorbeeld: http://rbtonline.nl/api/v1/sites/2/nl/events.xml?active=0 Doormiddel van de query paramaters start_date en end_date kunnen evenementen worden opgehaald binnen een bepaalde datum-range. Aan beide parameters moet een UNIX timestamp worden meegegeven. Standaard worden alle evenementen opgehaald, ongeacht de begin- eind datum ervan. Met de paramaters highlight_level1 en highlight_level2 kunnen evenementen opgehaald worden die uitgelicht moeten worden. Bijvoorbeeld: /nl/events.xml?highlight_level1=1 of /nl/events/categories/2.xml?highlight_level2=1 In dit geval worden alle evenementen opgehaald welke op het hoofdniveau uitgelicht worden. Het tweede voorbeeld haalt alle evenementen op die binnen de categorie ‘Kunst & Cultuur’ (=2) uitgelicht worden. Met de since_id paramater worden alleen items opgehaald die nieuwer zijn dan het opgegeven ID (integer), hoe hoger het ID hoe nieuwer. De parameter import_id maakt het mogelijk items op te halen met dit import_id, dit kan bijvoorbeeld nodig zijn om te controleren of een item reeds is toegevoegd, gebruik dit dan i.c.m. de paramater source. Met de paramater source kunnen evenementen opgehaald worden die afkomstig zijn vanaf een bepaalde import.

Method GET

URL /{lang}/events

GET GET

/{lang}/events/{event_id} /{lang}/events/categories/{category_id}

GET

/sites/{site_id}/{lang}/events

GET

/sites/{site_id}/{lang}/events/categories/{cat egory_id}

GET

/sites/{site_id}/places/{place_id}/{lang}/event

Multimove webworks

POST-data

CDB API 1.2

Actie Opvragen evenementen Opvragen evenement Opvragen evenementen met categorie Opvragen evenementen van site Opvragen evenementen binnen een site met categorie Opvragen Pagina 29 van 46

s/ categories/{category_id}

GET

/sites/{site_id}/places/{place_id}/{lang}/event s

GET GET

/places/{place_id}/{lang}/events /places/{place_id}/{lang}/events/categories/{ category_id}

GET

/{lang}/participants/{participant_id}/events

POST

/{lang}/events

POST

/{lang}/events/{event_id}

Multimove webworks

title short_content content start_date end_date opening_exception active category_id street postal place_id latitude longitude contactperson source sourceemail website location price reservation show_short_content export_long_term export_exposition openingtype highlight_level1 highlight_level2 relevance import_id title short_content content start_date end_date opening_exception active category_id street postal place_id latitude longitude contactperson source sourceemail CDB API 1.2

evenementen binnen een site in plaats met categorie Opvragen evenementen binnen site en in plaats Evenementen in plaats Opvragen evenementen in plaats met categorie Evenementen gekoppeld aan deelnemer Aanmaken evenement

Bewerken evenement

Pagina 30 van 46

website location price reservation show_short_content export_long_term export_exposition openingtype highlight_level1 highlight_level2 relevance import_id DELETE POST

1

1

DELETE

POST

1

Verwijderen evenement Deelnemer toevoegen aan evenement Deelnemer verwijderen van evenement Site toevoegen aan evenement Site verwijderen van evenement

/{lang}/events/{event_id} /{lang}/events/{ event_id}/participants/{participant_id} /{lang}/events/{ event_id}/participants/{participant_id} /{lang}/events/{ event_id}/sites/{site_id}

1

DELETE

/{lang}/events/{event_id}/sites/{site_id}

Parameter title short_content content start_date end_date opening_exception active category_id street postal place_id latitude longitude contactperson source sourceemail location website price reservation

reservation_explan ation show_short_conte nt export_long_term

Multimove webworks

Description Titel Korte omschrijving Lange omschrijving Startdatum in formaat UNIX timestamp Eindddatum in formaat UNIX timestamp Uitzondering op de openingstijden 0: actief 1: niet-actief Categorie ID Straat + huisnummer Postcode Plaats ID Breedtegraad Lengtegraad Contactpersoon Bron Bron e-mail Locatie Website adres (zonder http://) Prijs Reserveren verplicht 0: nee 1: ja Toelichting op reserveren

Type string string string integer integer string integer

Verplicht nee nee nee nee nee nee nee

integer string string integer string string string string string string string string integer

ja nee nee ja nee nee nee nee nee nee

string

nee

Tonen op website 0: nee 1: ja Exporteren als lang lopend 0: nee

integer

nee

0

integer

nee

0

CDB API 1.2

nee nee

Default

0 0 0

0.00 0

Pagina 31 van 46

export_exposition

openingtype

highlight_level1

highlight_level2

relevance

import_id

Multimove webworks

1: ja Exporteren als exposities & tentoonstelling 0: nee 1: ja Openingstype 0: Dagelijks geopend op vaste tijden 1: Openingsdagen en/of tijden verschillend Item uitlichten op de hoofd niveau 0: nee 1: ja Item uitlichten op de categorie niveau 0: nee 1: ja Geeft de relevantie/allure aan van een evenement 0: Lokaal 1: Regionaal 2: Nationaal 3: Internationaal ID afkomstig vanaf een eventuele import. In geval van import moet deze waarde uniek zijn in combinatie met ‘source’

CDB API 1.2

integer

Nee

0

integer

nee

0

integer

nee

0

integer

nee

0

interger

Nee

1

integer

nee

0

Pagina 32 van 46

3.2.22 Event visiting hours interface Indien bij een evenement het ´openingtype´ op ´openingsdagen en/of tijden verschillend´ (1) is ingesteld kunnen per evenement de openingstijden per dag opgehaald of ingesteld worden. Het openingday_id moet vallen binnen de range 1-7, waarbij 1 staat voor maandag, 2 voor dinsdag, etc.

Method GET

URL /{lang}/events/{event_id}/open

GET

/{lang}/events/{event_id}/open/{openingday _id}

POST

1

POST-data

/{lang}/events/{event_id}/open/{openingday _id} 1

DELETE

openingday_starttime openingday_endtime

/{lang}/events/{event_id}/open/{openingday _id}

Parameter openingday_startti me openingday_endti me

Multimove webworks

Actie Opvragen openingstijden evenement Opvragen openingstijden evenement per dag Toevoegen of bewerken openingstijden evenement Verwijderen openingstijden per dag

Description Open vanaf in formaat: 00:00

Type string

Verplicht nee

Default 00:00

Open tot in formaat: 00:00

string

nee

23:59

CDB API 1.2

Pagina 33 van 46

3.2.23 Event images interface Afbeeldingen van een evenement, in range 0-0 ( image_number). Als resultaat wordt de rechtstreekste URL naar de afbeelding teruggegeven evenals een URL waarmee de afbeelding realtime kan worden geschaald/bewerkt (zie bijlage). Er is maximaal 1 afbeelding per evenement toegestaan. Bijvoorbeeld: http://www.rbtonline.nl/storage/agenda/images/10120-0.jpg Method GET

URL /{lang}/events/{event_id}/images

GET

/{lang}/events/{event_id}/images/{image_nu mber} /{lang}/events/{event_id}/images/{image_nu mber}

POST

1

1

DELETE

POST

1

POST-data

Actie Ophalen afbeeldingen evenement Ophalen afbeelding evenement Afbeelding aan evenement toevoegen, of overschrijven Afbeelding van evenement verwijderen Externe afbeelding inladen via cronjobqueue

image

/{lang}/events/{event_id}/images/{image_nu mber} /{lang}/events/{ event_id}/images-queue/{ image_number}

Parameter image url

Multimove webworks

url

Description Afbeelding (JPG of JPEG) Rechtstreekste link naar afbeelding (JPG of JPEG)

CDB API 1.2

Type file string

Verplicht ja ja

Default

Pagina 34 van 46

3.2.24 Cronjob queue interface Doormiddel van de cronjob queue kunnen (belastende) taken in de wachtrij gezet worden. De taken in de queue wordt automatisch uitgevoerd, dit gebeurt in volgorde van toevoeging. Gemiddeld wordt er elke 2 minuten een batch van 5 taken gestart. Method 1 GET 1 GET 1 POST POST

1

URL /cronjob-queues /cronjob-queues/{queue_id} /cronjob-queues

POST-data

type data type data

/cronjob-queues/{queue_id} 1

DELETE

Actie Ophalen alle taken Ophalen taak Taak toevoegen Taak bewerken

/cronjob-queues/{queue_id}

Parameter type Data

Multimove webworks

Taak verwijderen

Description Image: Voor het ophalen van een externe afbeelding. Benodigde data: ‘url’ JSON string met aanvullende gegevens voor het type

CDB API 1.2

Type string

Verplicht ja

string

nee

Default

Pagina 35 van 46

4

Resultaatcodes

Volgende resultaatcodes zijn mogelijk: Code The request has succeeded. The request requires user authentication. The server understood the request, but is refusing to fulfill it. The server has not found anything matching the Request-URI. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. Content type missing or invalid. Server or request error. HTTP method not supported.

Multimove webworks

CDB API 1.2

HTTP Code 200 / OK 401 / Unauthorized 403 / Forbidden 404 / Not found 405 / Not allowed 406 / Not acceptable 500 / Error 501 / Not Implemented

Pagina 36 van 46

5

Voorbeeldcode PHP

Voor het gebruik van de API is de volgende voorbeeldcode in PHP beschikbaar (opvragen gegevens deelnemer): data->participant->opening)); } // Close the curl session curl_close($requestSession); ?>

Multimove webworks

CDB API 1.2

Pagina 37 van 46

6

API changes

In onderstaande tabel is aangegeven wat de aanpassingen of toevoegingen zijn in de verschillende API releases: Versie API 1

Changes

API 1.1

Toegankelijk-types toegevoegd aan deelnemers.

API 1.2

Velden ‘highlight_level1’ en ‘highlight_level2’ toegevoegd aan participants en events.

Eerste release

Voor bovengenoemde zijn ook tevens nieuwe query-paramaters toegevoegd: ‘highlight_level1’ en ‘higlight_level2’. Doormiddel van deze parameters kunnen aanvullende selecties gemaakt worden binnen de deelnemers en evenementen. Participant category images interface toegevoegd. Per categorie kan een afbeelding worden meegegeven. Let op: deze afbeeldingen zijn site specifiek, de request bevat daardoor een site_id. Participant category group images interface toegevoegd. Per categoriegroep kan een afbeelding worden meegegeven. Deze afbeeldingen zijn net als de groepen zelf, site specifiek. Agenda category images interface toegevoegd. Per categorie kan een afbeelding worden meegegeven. Let op: deze afbeeldingen zijn site specifiek, de request bevat daardoor een site_id. ‘APIAuthenticationKey’ is vervangen door ‘X-APIAuthenticationKey’. De oude authenticatie methode blijft nog functioneren tot API 1.2.4 API 1.2.1

Bug fix: JSON output gaf in sommige gevallen integers als string terug. Inter Event visiting hours interface: event_id toegevoegd in output. Participant rooms interface: participant_id toegevoegd in output. Participant arrangements interface: participant_id toegevoegd in output.

API 1.2.2

Veld import_id toegevoegd aan events interface. Voor deze interface zijn ook twee n ieuwe query-paramaters beschibaar gekomen: ‘import_id’ en ‘source’s

API 1.2.3

Bug fix: XML output bevatte verkeerde geformatteerde data.

API 1.2.4

‘X-APIAuthenticationKey’ wordt vervangen door ‘x-apiauthenticationkey’, de oude authenticatie methode blijft nog functioneren. De oudere ‘APIAuthenticationKey’ header wordt niet meer ondersteund, graag de header aanpassen naar ‘x-apiauthenticationkey’

API 1.2.5

Parameter ‘data_name’ toegevoegd. Met behulp van deze query- parameter kan de

Multimove webworks

CDB API 1.2

Pagina 38 van 46

API 1.2.6 API 1.2.7 API 1.2.8 API 1.2.9

naamgeving van de response parent worden aangepast. De parameter is beschikbaar in alle requests . Agenda ‘price’ paramater kan vanaf nu ook een string bevatten, voorheen werd alleen het formaat 0.00 toegestaan. Relevantie toegevoegd voor deelnemers en evenementen. Keuze uit lokaal, regionaal, nationaal en internationaal. De volgende velden zijn toegevoegd aan een evenement: ‘street’, ‘postal’, ‘latitude’ en ‘longitude’. De volgende velden zijn toegevoegd aan een deelnemer: ‘lifestyle_score1’, ‘lifestyle_score2’, ‘lifestyle_score3’, ‘lifestyle_score4’ en ‘lifestyle_score5’. De scores hebben de volgende betekenissen:

API 1.2.10 API 1.2.11 API 1.2.12 API 1.2.13 API 1.2.14 API 1.2.15 API 1.2.16 API 1.2.17

lifestyle_score1: Uitbundig geel lifestyle_score2: Gezellig lime lifestyle_score3: Avontuurlijk paars lifestyle_score4: Ingetogen aqua lifestyle_score5: Rustig groen Call to Action veld toegevoegd bij deelnemers. Veld is standaard gevuld met het wwwadres. Het veld ‘restaurant_other’ is komen te vervallen. Veld star_rating toegevoegd aan deelnemer. Range 0-5 (sterren) Dieet-types toegevoegd. Optie ‘on_map’ toegevoegd aan Participant Category Groups Veld ‘import_id’ toegevoegd aan deelnemer Cronjob-queue interface toegevoegd Velden lifestyle_score6 en lifestyle_score7 toegevoegd aan deelnemer De scores hebben de volgende betekenissen:

API 1.2.18 API 1.2.19

lifestyle_score6: Stijlvol & Luxe blauw lifestyle_score7: Creatief & Inspirerend rood Velden icon toegevoegd aan Participant Category Groups Velden icon toegevoegd aan Particiapant Facilities Deelnemers, evenementen en site selecties Twente verwijderd.

Multimove webworks

CDB API 1.2

Pagina 39 van 46

Bijlage 1: Participant categories icons

ID

Standaard Icoon URL

0

http://www.rbtonline.nl/images/maps/marker-cafe-grijs-icoon.png

1

http://www.rbtonline.nl/images/maps/marker-galerieeen-grijs-icoon.png

2

http://www.rbtonline.nl/images/maps/marker-B&B-grijs-icoon.png

3

http://www.rbtonline.nl/images/maps/marker-bioscopen-grijs-icoon.png

4

http://www.rbtonline.nl/images/maps/marker-boerencampings-grijs-icoon.png

5

http://www.rbtonline.nl/images/maps/marker-bungalows-grijs-icoon.png

6

http://www.rbtonline.nl/images/maps/marker-cafe-grijs-icoon.png

7

http://www.rbtonline.nl/images/maps/marker-campings-grijs-icoon.png

8

http://www.rbtonline.nl/images/maps/marker-discotheken-grijs-icoon.png

9

http://www.rbtonline.nl/images/maps/marker-excursies-grijs-icoon.png

10

http://www.rbtonline.nl/images/maps/marker-fietsen-grijs-icoon.png

11

http://www.rbtonline.nl/images/maps/marker-gebouwen-grijs-icoon.png

12

http://www.rbtonline.nl/images/maps/marker-groepsaccomodaties-grijs-icoon.png

13

http://www.rbtonline.nl/images/maps/marker-hotels-grijs-icoon.png

14

http://www.rbtonline.nl/images/maps/marker-kerken-grijs-icoon.png

15

http://www.rbtonline.nl/images/maps/marker-lunchrooms-grijs-icoon.png

16

http://www.rbtonline.nl/images/maps/marker-molens-grijs-icoon.png

17

http://www.rbtonline.nl/images/maps/marker-musea-grijs-icoon.png

18

http://www.rbtonline.nl/images/maps/marker-outdoor-grijs-icoon.png

19

http://www.rbtonline.nl/images/maps/marker-partycentrum-grijs-icoon.png

20

http://www.rbtonline.nl/images/maps/marker-pensions-grijs-icoon.png

21

http://www.rbtonline.nl/images/maps/marker-restaurants-grijs-icoon.png

22

http://www.rbtonline.nl/images/maps/marker-rondleidingen-grijs-icoon.png

23

http://www.rbtonline.nl/images/maps/marker-theater-grijs-icoon.png

24

http://www.rbtonline.nl/images/maps/marker-varen-grijs-icoon.png

25

http://www.rbtonline.nl/images/maps/marker-vergaderen-grijs-icoon.png

26

http://www.rbtonline.nl/images/maps/marker-wandelen-grijs-icoon.png

27

http://www.rbtonline.nl/images/maps/marker-wellness-grijs-icoon.png

28

http://www.rbtonline.nl/images/maps/marker-winkelen-grijs-icoon.png

29

http://www.rbtonline.nl/images/maps/marker-workshops-grijs-icoon.png

30

http://www.rbtonline.nl/images/maps/marker-zwembaden-grijs-icoon.png

31

http://www.rbtonline.nl/images/maps/marker-appartementen-grijs-icoon.png

32

http://www.rbtonline.nl/images/maps/marker-vvv-grijs-icoon.png

33

http://www.rbtonline.nl/images/maps/marker-attracties-grijs-icoon.png

34

http://www.rbtonline.nl/images/maps/marker-doen!-grijs-icoon.png

35

http://www.rbtonline.nl/images/maps/marker-funpagina-grijs-icoon.png

36

http://www.rbtonline.nl/images/maps/marker-golfen-grijs-icoon.png

37

http://www.rbtonline.nl/images/maps/marker-lekkerweg-grijs-icoon.png

38

http://www.rbtonline.nl/images/maps/marker-bibliotheek-grijs-icoon.png

39

http://www.rbtonline.nl/images/maps/marker-winkels-grijs-icoon.png

Multimove webworks

CDB API 1.2

Pagina 40 van 46

40

http://www.rbtonline.nl/images/maps/marker-zeilen-grijs-icoon.png

41

http://www.rbtonline.nl/images/maps/marker-winkels-grijs-icoon.png

42

http://www.rbtonline.nl/images/maps/marker-paardrijden-grijs-icoon.png

43

http://www.rbtonline.nl/images/maps/marker-waterski-grijs-icoon.png

44

http://www.rbtonline.nl/images/maps/marker-badminton-grijs-icoon.png

45

http://www.rbtonline.nl/images/maps/marker-afhaalrestaurant-grijs-icoon.png

46

http://www.rbtonline.nl/images/maps/marker-bezoekerscentra-grijs-icoon.png

47

http://www.rbtonline.nl/images/maps/marker-bijzonderovernachten-grijs-icoon.png

48

http://www.rbtonline.nl/images/maps/marker-catering-grijs-icoon.png

49

http://www.rbtonline.nl/images/maps/marker-grandcafe-grijs-icoon.png

50

http://www.rbtonline.nl/images/maps/marker-kinderpret-grijs-icoon.png

51

http://www.rbtonline.nl/images/maps/marker-koffietheepunt-grijs-icoon.png

52

http://www.rbtonline.nl/images/maps/marker-landgoed-grijs-icoon.png

53

http://www.rbtonline.nl/images/maps/marker-natuurbeheer-grijs-icoon.png

54

http://www.rbtonline.nl/images/maps/marker-ov-grijs-icoon.png

55

http://www.rbtonline.nl/images/maps/marker-rustpunten-grijs-icoon.png

56

http://www.rbtonline.nl/images/maps/marker-rustpunthouder-grijs-icoon.png

57

http://www.rbtonline.nl/images/maps/marker-TOP-grijs-icoon.png

58

http://www.rbtonline.nl/images/maps/marker-vakantiewoning-grijs-icoon.png

59

http://www.rbtonline.nl/images/maps/marker-veerdiensten-grijs-icoon.png

60

http://www.rbtonline.nl/images/maps/marker-zakerlijkovernachten-grijs-icoon.png

61

http://www.rbtonline.nl/images/maps/marker-zorgboerderij-grijs-icoon.png

62

http://www.rbtonline.nl/images/maps/marker-cultureleinstellingen-grijs-icoon.png

63

http://www.rbtonline.nl/images/maps/marker-boeken-grijs-icoon.png

64

http://www.rbtonline.nl/images/maps/marker-bungalowparken-grijs-icoon.png

65

http://www.rbtonline.nl/images/maps/marker-overig-grijs-icoon.png

66

http://www.rbtonline.nl/images/maps/marker-fietsvriendelijkeondernermers-grijs-icoon.png

67

http://www.rbtonline.nl/images/maps/marker-camperplaatsen-grijs-icoon.png

68

http://www.rbtonline.nl/images/maps/marker-verhuur-grijs-icoon.png

69

http://www.rbtonline.nl/images/maps/marker-touristinfo-grijs-icoon.png

Multimove webworks

CDB API 1.2

Pagina 41 van 46

Bijlage 2: Participant facility icons

ID

Standaard Icoon URL

0

http://www.rbtonline.nl/images/icons/participants/facilities/facility-doen.png http://www.rbtonline.nl/images/icons/participants/facilities/facility-zien.png 2 http://www.rbtonline.nl/images/icons/participants/facilities/facility-actief.png 1

Multimove webworks

CDB API 1.2

Pagina 42 van 46

Bijlage 3: Participant category group icons

ID 0 1 2 3 4 5 6

Standaard Icoon URL

http://www.rbtonline.nl/images/icons/participants/groups/group-agenda.png http://www.rbtonline.nl/images/icons/participants/groups/group-eten_en_drinken.png http://www.rbtonline.nl/images/icons/participants/groups/group-info.png http://www.rbtonline.nl/images/icons/participants/groups/group-natuur.png http://www.rbtonline.nl/images/icons/participants/groups/group-slapen.png http://www.rbtonline.nl/images/icons/participants/groups/group-uitrusten.png http://www.rbtonline.nl/images/icons/participants/groups/group-zien_en_doen.png

Multimove webworks

CDB API 1.2

Pagina 43 van 46

Bijlage 4: Event categories icons

ID Standaard icoon URL 0 http://www.rbtonline.nl/images/icons/agenda/agenda-attracties.png 1 http://www.rbtonline.nl/images/icons/agenda/agenda-eten_drinken.png 2 http://www.rbtonline.nl/images/icons/agenda/agenda-fietsen_wandelen.png 3 http://www.rbtonline.nl/images/icons/agenda/agenda-Kunst_kultuur.png 4 http://www.rbtonline.nl/images/icons/agenda/agenda-muziek.png 5 http://www.rbtonline.nl/images/icons/agenda/agenda-sport_spel.png 6 http://www.rbtonline.nl/images/icons/agenda/agenda-stads_dorpswandeling.png 7 http://www.rbtonline.nl/images/icons/agenda/agenda-theatervoorstellingen.png 8 http://www.rbtonline.nl/images/icons/agenda/agenda-markten.png 9 http://www.rbtonline.nl/images/icons/agenda/agenda-diversen.png 10 http://www.rbtonline.nl/images/icons/agenda/agenda-films.png 11 http://www.rbtonline.nl/images/icons/agenda/agenda-kinderen.png 12 http://www.rbtonline.nl/images/icons/agenda/agenda-lezingen.png

Multimove webworks

CDB API 1.2

Pagina 44 van 46

Bijlage 5: Image handler parameters Met de ‘image handler’, kunnen afbeeldingen van deelnemers en evenementen worden getransformeerd naar een andere formaten (resoluties). Aan de handler kunnen diverse parameters worden toegevoegd, zie onderstaande tabel. Voorbeeld aanroep: http://www.rbtonline.nl/image.php?image=storage/participants/images/2-0.jpg&width=200&height=200 Parameter height width quality bw mode

st

Description Hoogte Waarde: integer Breedte Waarde: integer Kwaliteit Waarde: integer (range 1-100) Afbeelding naar grijswaarden transformeren (zwart/wit) Waarde: boolean Schaalmethode Waarde: fit of crop fit: opgegeven afbeelding past geheel binnen canvas, crop: afbeelding wordt uitgevuld op canvas, uitstekende delen worden gecropt. Afbeelding mag groter worden dan origineel (oprekken) Waarde: boolean

Multimove webworks

CDB API 1.2

Default Waarde origineel Waarde origineel 100 false crop

false

Pagina 45 van 46

Bijlage 6: Schematische weergave gegevensstromen

Multimove webworks

CDB API 1.2

Pagina 46 van 46