GMMG API documentatie

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

API - index

Voor het bekijken van alle actieve content is een speciaal commando gemaakt. Alle aangemaakte content is hier op te vragen. De content krijgt direct de urls mee die gebruikt kunnen worden om de content op te vragen.

De index kan gebruikt worden binnen de applicatie om de uitgelicht selecties of de statische content te verzamelen.

Parameters

Naam Beschrijving Verplicht
apikey Unieke identificatiesleutel van de applicatie, wordt gebruikt voor het ophalen van de juiste data en het bijhouden van het gebruik van de applicatie. Ja
output JSON / XML (standaard waarde is ingesteld binnen applicatie) Nee

Onderdelen van 'index'

Zoekfacetten
Biedt de ingang naar de lijst met alle geactiveerde zoekfacetten. Dit commando geeft zowel een lijst met de beschrijving, als een lijst met de actieve aantallen.

Er kunnen verschillende zoekfacetten beschikbaar zijn voor zowel 'product', 'organisatie' als 'hyperlink'.
Selecties
Per aangemaakte selectie wordt deze toegevoegd aan de 'index'.
Bestanden
Dit item maakt het mogelijk om de toegevoegde bestanden te raadplegen. Afbeeldingen kunnen in meerdere afmetingen worden opgevraagd. De overige bestanden kunnen aangeboden worden ter download.
Text content
De 'statische' teksten die beschikbaar zijn binnen de applicatie worden allen hier toegevoegd. Via de url kunnen ze worden opgevraagd, zowel als HTML als binnen een XML/JSON wrapper
Voorbeeld:
http://service.gmmg.bartcms.nl/api/v1/index?apikey=01cb0aa172e0fd414342&output=xml
Resultaat:
    <appIndex>
        <contentIndex>
            <appId>8</appId>
            <numberOfItems>1</numberOfItems>
            <items>
                <item>
                    <type>selection</type>
                    <uri>http://service.gmmg.bartcms.nl/api/v1/selection?
                    apikey=01cb0aa172e0fd414342&id=12&output=xml</uri>
                </item>
            </items>
        </contentIndex>
    </appIndex>