GMMG API documentatie

Laatste mutatie: 09-07-2014 om 15:45

API - zoeken/opvragen

De mogelijkheden van de zoekmachine voor de gekoppelde items in de middleware.

Algemene parameters (beschikbaar voor organisatie/product/event/link)

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
q (query) Zoekterm waarop gezocht moet worden in de content. Nee
start Startpunt van de data set. Nee
limit De lengte van de data set. Nee
sort Sorteer veld van de data set. Nee
sortdir Sorteer richting van de data set. Waarde is ASC (oplopend) of DESC (aflopend). Nee
filter_id Het GML filter dat gebruikt moet worden voor de uitvoer. Nee
output JSON / XML (standaard waarde is ingesteld binnen applicatie) Nee
include_facets Hiermee kan worden aangegeven of de facet-resultaten moeten worden meegestuurd met de zoekresultaten. Standaard is de waarde 'on' en worden de gegevens wel meegestuurd. Met de waarde 'off' wordt dit niet meegestuurd. Nee

Parameters specifiek voor event

startdate Start van de periode waarbinnen het evenement moet plaatsvinden.

De datumnotatie kan als volgt worden meegestuurd: "yyyy-mm-dd H:i:s", zoals bijvoorbeeld: "2013-12-09 13:00".
Nee
enddate Einde van de periode waarbinnen het evenement moet plaatsvinden.

De datumnotatie kan als volgt worden meegestuurd: "yyyy-mm-dd H:i:s", zoals bijvoorbeeld: "2013-12-09 16:15".
Nee
single_periode Als deze optie de waarde true heeft dan worden evenementen met een periode eenmaal opgenomen in de resultatenlijst. Als de optie false bevat dan wordt het evenement iedere dag opgenomen in de resultatenlijst.

Standaard is deze optie false.
Nee

Het is mogelijk om te zoeken met een van de geactiveerde zoekfacetten. Hiervoor moet de gewenste waarde van het zoekfacet meegestuurd worden aan de zoekopdracht. De naam van het veld is ingesteld in het zoekfacet. Het gaat hier om het de waarde in het veld "solr_field". Per zoekfacet kan deze opgevraagd worden via het commando 'Zoekfacetten', of geëxporteerd vanuit de beheeromgeving.

Extra 'facet'-informatie

Bij alle items worden de facetten die horen bij applicatie opgezocht. Ze worden opgeslagen bij het item en meegestuurd bij overzicht en detail aanvragen. Alles facetten die actief zijn worden meegestuurd, er kan dus meer dan 1 facet van toepassing zijn.

Bij de handmatige selectie is deze facet-informatie op dit moment nog niet beschikbaar.

Voorbeeld actieve facet:
<facets>
    <Genres>
        <item>Film</item>
    </Genres>
    <Organisaties>
        <item>Heerenstraat Theater</item>
    </Organisaties>
</facets>

Onderdelen van 'zoeken'

Er wordt een lijst met de gekozen items gestuurd. Daarnaast worden standaard de geactiveerde zoekfacetten meegestuurd met actuele aantallen.

Aanvullende meta-informatie bestaat uit de zoekvraag, het totaal aantal items dat beschikbaar is voor de zoekopdracht.

Voorbeeld (producten):
http://service.gmmg.bartcms.nl/api/v1/products/overview?apikey=01cb0aa172e0fd414342&output=xml
Resultaat:
<?xml version="1.0" encoding="UTF-8" ?>
<productOverview>
  <searchQuery>*:*</searchQuery>
  <start>0</start>
  <numFounds>10</numFounds>
  <totalRecords>170</totalRecords>
  <params/>
  <products>
    <product>
      <productId>6212002</productId>
      <id>6212002</id>
      <productSoortId>32770</productSoortId>
      <productSoortNaam>Theater-, toneelvoorstelling of musicalvoorstelling</productSoortNaam>
      <productSoortVersie>88</productSoortVersie>
      <gmlVersie>2</gmlVersie>
      <publieksNaam>'Een indiaan in huis', een voorstelling over autisme</publieksNaam>
      <beschrijving>...</beschrijving>

      ... overige velden en meer producten ...

    </Product>
  </products>
  <facets>
    <Organisaties>
      <Organisatie>
        <name> FlevoMeer Bibliotheek  hoofdkantoor</name>
        <count>0</count>
      </Organisatie>
      <Organisatie>
        <name> Jeugdgezondheidzorg 0-19 jaar</name>
        <count>0</count>
      </Organisatie>
    </Organisaties>
    <Genres>
      <Genre>
        <name>Concert</name>
        <count>34</count>
      </Genre>
      <Genre>
        <name>ans</name>
        <count>2</count>
      </Genre>
    </Genres>
</facets>
</productOverview>