GMMG API documentatie

Laatste mutatie: 13-01-2014 om 12:43

Algemene uitleg

Een applicatie kan gebruik maken van verschillende soorten informatie vanuit de middleware. De nadruk ligt vanzelfsprekend op content vanuit G!DS. Hierop kan uitgebreid gezocht worden en er is de mogelijkheid voor facetten. Het is mogelijk om individuele items te raadplegen, of een lijst te maken met handmatige geselecteerde items. Een handmatige lijst kan op basis van de aanwezige items in de middleware.

Bestanden zoals afbeeldingen of documenten die gekoppeld zijn in G!DS kunnen natuurlijk ook geraadpleegd worden met behulp van de middleware omgeving. Voor de afbeeldingen zijn extra opties met betrekking tot afmetingen beschikbaar.

Naast G!DS content is het ook mogelijk om aanvullende content als die beschikbaar is op te vragen. De redactie van een applicatie kan teksten en bestanden koppelen aan de applicatie. Door middel van de API kan deze extra content worden opgevraagd en gebruikt in een app.

Met behulp van de 'apikey' kan de informatie worden opgehaald.

Zoeken binnen de middleware is de voornaamste functie, de mogelijkheden hiervoor kunnen hier gevonden worden.

Een overzicht van de extra content van een applicatie kan opgehaald worden met behulp van de 'index'

Url samenstelling

De API is beschikbaar via een speciale url. Van de API is op dit moment de eerste versie beschikbaar, in de url is dit terug te vinden "/api/v1/". Zodra er nieuwe functionaliteiten worden toegevoegd zal dit gebeuren door middel van een nieuwe versie, zodat de huidige applicaties die gebruik maken van een bepaalde versie niet aangepast hoeven worden

API url:
http://service.gmmg.bartcms.nl/api/v1/[ACTIE]

Zoals hierboven te zien is komt na de versie van de API de actie. Er zijn een aantal acties beschikbaar:

index
Lijst ophalen met alle extra content. Meer informatie
selection
Lijst ophalen met handmatig geselecteerde items. Meer informatie
products/overview
Zoeken/opvragen van G!DS producten. Meer informatie
product/detail
Ophalen van 1 specifiek product uit G!DS. Meer informatie
events/overview
Zoeken/opvragen van G!DS evenementen. Meer informatie
event/detail
Ophalen van 1 specifiek evenement uit G!DS. Meer informatie
organisations/overview
Zoeken/opvragen van G!DS organisaties. Meer informatie
organisation/detail
Ophalen van 1 specifieke organisatie uit G!DS. Meer informatie
searchfacets
Lijst met alle actieve facetten. Meer informatie
content
Aanvullend content item (tekst/bestand) ophalen. Meer informatie
file
Dit biedt toegang tot de bestanden van een G!DS item. Meer informatie

Onderscheid tussen product & event

In G!DS bestaat geen onderscheid tussen producten en evenementen. Alle productsoorten in G!DS die gebruikt kunnen worden als evenement hebben periode of agenda velden. In de middleware gebruiken we de waarden in deze velden om evenementen te vinden. De uitvoer van evenementen wordt aangevuld met extra velden. Deze velden zijn te gebruiken bij het samenstellen van componenten om op activiteiten te zoeken.

De extra velden voor evenementen zijn:

Naam Beschrijving
Agendadatum Datum van deze instantie van de agenda. Ieder evenement wordt meerdere malen in de index geplaatst met een individuele agenda. De notatie is volgens het UTC. Een voorbeeld is: 2014-03-19T20:30:00Z.
AgendadatumString Leesbare notatie van een ingevulde agenda, direct te tonen bij een evenement.
PeriodeString Leesbare notatie van een ingevulde periode, direct te tonen bij een evenement.
Aantal.uitvoeringen Dit veld bevat het aantal x dat een evenement plaatsvindt. Hierbij wordt voor een periode het aantal dagen geteld. Bij een ingevulde agenda worden het aantal agenda-items geteld. Dit veld kan gebruikt worden om aan te geven of het een eenmalig evenement betrefd, of een vaker terugkerend evenement.

G!DS afbeeldingen

Afbeeldingen vanuit G!DS hebben een eigen commando file. Dit commando mag zelf worden samengesteld, maar het is van te voren niet te zeggen welke bestanden aan een G!DS item zijn toegekend. Daarvoor worden de bestanden van een G!DS item door de middleware al bewerkt. Hiervoor worden specifieke velden toegevoegd aan het item vanuit G!DS.