Een methode aanroepen
POST of GET, body versus querystring, en wat de veldvalidatie verwacht.
Een methodenaam is onderdeel van de URL. Elke andere invoer, ook een id, is een parameter: een
JSON-bodyveld bij POST, een queryparameter bij GET. Beide vormen bereiken dezelfde methode en
geven dezelfde envelop terug.
POST: een JSON-body
De normale vorm voor alles met meer dan een paar parameters, of met een geneste object of een array.
GET: een querystring
Handig voor een snelle check vanuit de adresbalk van een browser of een curl-oneliner. De
server parseert de querystring tot dezelfde body die de methodehandler ziet, dus de regels
hieronder zijn hier belangrijker dan bij POST.
Het gedeclareerde type van een veld bepaalt hoe de waarde in de querystring wordt gelezen:
- string: ongewijzigd gebruikt.
- number: door
Number(...)gehaald. - boolean: alleen de letterlijke string
truewordt gelezen alstrue. Al het andere wat je voor een booleanveld meegeeft bijGET, ookfalse, wordt omgezet naar een waarachtige1. Als een boolean ertoe doet, stuur hem dan bijPOSTmet een echte JSON-true/false, of laat de queryparameter weg om de standaardwaarde van de methode te houden. - object / array: de waarde wordt door
JSON.parse(...)gehaald, dus een geneste waarde bijGETmoet één queryparameter zijn met een JSON-string (filters=%7B%22status%22%3A%22open%22%7D), geen geneste query in haakjesstijl.
Verplichte velden en typefouten
De velden van een methode hebben elk een vlag mandatory en een type. Mist er een verplicht
veld, of stuur je bij POST (waar niets automatisch wordt omgezet) het verkeerde type, dan krijg
je een -1 terug voordat de methode zelf ooit draait:
De interactieve API-referentie toont de velden van elke methode met hun typen en vlaggen voor verplicht, en laat je een aanroep vanuit de browser uitvoeren om het exacte verzoek te zien dat is opgebouwd.