GMMG API documentatie

  1. Home
  2. Api onderdelen
  3. API - selecties
Laatste mutatie: 13-01-2014 om 12:43

API - selecties

De uitgelicht selectie lijsten kunnen opgevraagd worden via het url-commando: '/selection'. De uitgelicht selectie kan worden opgehaald aan de hand van het unieke ID.

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
id Identificatie sleutel van de aangemaakte selectie. Ja
output JSON / XML (standaard waarde is ingesteld binnen applicatie) Nee
filter_id Geselecteerde filter. Nee
event Optie om producten als evenementen terug te krijgen. Mogelijk waardes zijn "true" of "false".

Standaard is de waarde false.		 Nee
sort Sorteer veld van de data set. Nee
sortdir Sorteer richting van de data set. Waarde is ASC (oplopend) of DESC (aflopend). Nee

Extra velden voor evenementen

In de middleware zijn producten op te vragen als evenementen. Een evenement heeft extra velden voor het tonen van de momenten waarop een evenement plaatsvindt. Het is mogelijk om de producten in een uitgelicht selection op te vragen als evenementen. Hiervoor is een extra parameter nodig: event. Zodra de parameter de waarde true bevat krijgen de producten de extra velden. Er worden alleen toekomstige evenementen meegestuurd, evenementen uit het verleden komen op deze manier niet mee.

De uitgelicht selectie geeft standaard de items terug in de volgorde zoals deze is ingesteld. Voor evenementen is het mogelijk om dit te beïnvloeden met de parameters sort en sortdir.

Resultaat onderdelen

id
ID van de huidige uitgelicht selectie.
name
Naam van de uitgelicht selectie zoals ingesteld in de middleware.
type
G!DS onderdeel (product, organisatie of hyperlink).
items
De handmatig gekozen items, volgens de weergave van het standaard filter, of hey via de url opgegeven filter.
Voorbeeld:
http://services.gm.rijnbrinkgroep.nl/api/v1/selection?apikey=01cb0aa172e0fd414342&id=12&output=xml
Resultaat:
    <?xml version="1.0" encoding="UTF-8" ?>
    <selection>
        <id>12</id>
        <name>Test selectie</name>
        <type>product</type>
        <items>
            <item>
                <productId>6185335</productId>
                <id>6185335</id>
                <productSoortId>98307</productSoortId>
                <productSoortNaam>Tentoonstelling, expositie (kunstwerken)</productSoortNaam>
                <productSoortVersie>48</productSoortVersie>
                <gmlVersie>2</gmlVersie>
                <publieksNaam>(Re)Source; over authenticiteit en manipulatie</publieksNaam>
                <beschrijving>Voorbeeld beschrijving...</beschrijving>
            </item>

            ... meerdere items ...

        </items>
    </selection>

© Appsoftware 2013-2020