Å kalle en metode
POST eller GET, kropp mot spørrestreng, og hva feltvalidatoren forventer.
Et metodenavn er en del av URL-en. Alle andre inndata, også en id, er parametere: et JSON-kroppsfelt
ved POST, en spørrestrengparameter ved GET. Begge formene når samme metode og gir samme
konvolutt tilbake.
POST: en JSON-kropp
Den vanlige formen for alt med mer enn et par parametere, eller med et nestet objekt eller en matrise.
GET: en spørrestreng
Praktisk for en rask sjekk fra adressefeltet i en nettleser eller en curl-enlinjer. Serveren
tolker spørrestrengen til den samme kroppen metodebehandleren ser, så reglene nedenfor betyr mer
her enn ved POST.
Et felts deklarerte type avgjør hvordan spørrestrengverdien leses:
- string: brukes som den er.
- number: kjøres gjennom
Number(...). - boolean: bare den bokstavelige strengen
trueleses somtrue. Alt annet du sender for et boolean-felt vedGET, ogsåfalse, tvinges til en sann1. Hvis en boolean betyr noe, send den vedPOSTmed en ekte JSONtrue/false, eller utelat spørreparameteren for å la den stå på metodens standard. - object / array: verdien kjøres gjennom
JSON.parse(...), så en nestet verdi vedGETmå være én spørreparameter som inneholder en JSON-streng (filters=%7B%22status%22%3A%22open%22%7D), ikke nesting i parentesstil.
Obligatoriske felt og typefeil
Hvert felt i en metode har et mandatory-flagg og en type. Mangler et obligatorisk felt, eller
sender du feil type ved POST (der ingenting tvinges automatisk), får du en -1 tilbake før selve
metoden i det hele tatt kjører:
Den interaktive API-referansen lister hver metodes felt med typer og obligatoriske flagg, og lar deg kjøre et kall fra nettleseren for å se nøyaktig hvilken forespørsel den bygde.