Zoeken
Je kan ook vrij zoeken indien je een lijst met gegevens opvraagt. Je kan slechts 1 zoekterm meegeven.
Geef de zoekterm op met de parameter ?search=. De zoekterm is niet hoofdlettergevoelig en je moet een URL-encoded doorgeven (om een spatie op te geven kunt u ‘+’ gebruiken).
Bvb. ?search=Gent
Filteren gegevens
Indien je een lijst met gegevens opvraagt, kan je deze lijst filteren door enkel items met specifieke gegevens op te nemen.
Geef een lijst door met de gewenste waarden langs de parameter ?filter=. Je kan enkel filteren op velden van het hoogste niveau (Dus niet van onderliggende niveau’s). Als eerste waarde geef je de naam van het veld door met hierna een vergelijkingsteken en daarna de eigenlijke waarde. De mogelijke vergelijkingstekens zijn =, !=, <=, >=, <, >, =~ (=bevat de tekst). Alle waarden moeten URL-encoded worden doorgegeven. Meerdere filters plaats je met een komma-teken na elkaar.
Bvb. ?filter=city%3DBrussel,name%3D%7ERestaurant
URL-encoderingen:
- Gelijk aan (=): %3D
- Verschillend van (!=): %21%3D
- Kleiner dan of gelijk (<=): %3C%3D
- Groter dan of gelijk (>=): %3E%3D
- Kleiner dan (<): %3C
- Groter dan (>): %3E
- bevat (=~): %3D%7E
- spatie (‘ ‘): +
Beperken teruggegeven velden
Indien jij een lijst met gegevens opvraagt, kan je zelf bepalen welke velden worden teruggegeven. Geeft je niets op dan worden alle velden teruggegeven.
Geef een lijst door met de gewenste velden met de parameter ?fields=. Je kan enkel velden van het hoogste niveau meegeven en dus niet van onderliggende niveau’s.
Bvb. ?fields=name,email_address
Sorteren
Indien je een lijst met gegevens opvraagt kan je deze lijst oplopend of aflopend sorteren op enkele velden.
Niet op alle velden kan je sorteren. Indien je een veld opgeeft waarop niet gesorteerd kan worden wordt er een foutmelding gegeven. Voor het domein ‘activities’ is er geen sortering mogelijk.
Geef een lijst door met de gewenste velden langs de parameter ?sort=. Meerdere velden kunt u met een ‘+’ scheiden (URL-encoded = %2B). Om een veld aflopend te sorteren plaats je er een min-teken voor.
Bvb. ?sort=status%2B-date
Paginering
Indien je een lijst met gegevens opvraagt kan je ook slechts een deel van deze lijst opvragen. Dit is handig om paginering mogelijk te maken.
Het is ten sterkste aan te raden om bij het ophalen van documenten (facturen, offertes, …) steeds maximaal 100 documenten per aanvraag op te halen.
Om gegevens over te slaan gebruik je de parameter ?skip= en om het aantal gegevens te beperken gebruikt u parameter ?take=.
Bvb. ?skip=30&take=10
Formattering
Teksten kunnen worden opgegeven in het Markdown formaat waardoor formattering wordt toegevoegd. Zie ook Hoe tekst formatteren?. Teksten teruggegeven langs de API bevatten de opgegeven formatterings-codes in Markdown-formaat, het is echter ook mogelijk om deze om te zetten naar de gepaste formattering in HTML.
Om teksten om te zetten gebruik je de parameter ?markup=markdown.