Kald en metode
POST eller GET, krop versus query string, og hvad feltvalidatoren forventer.
Et metodenavn er en del af URL'en. Alt andet input, også et id, er en parameter: et felt i JSON-kroppen ved
POST, en query string-parameter ved GET. Begge former når den samme metode og returnerer den samme
konvolut.
POST: en JSON-krop
Den normale form til alt med mere end et par parametre eller med et indlejret objekt eller et array.
GET: en query string
Praktisk til et hurtigt tjek fra browserens adresselinje eller en curl-enlinjer. Serveren tolker query
string'en til den samme krop, som metodehandleren ser, så reglerne nedenfor betyder mere her end ved POST.
Et felts erklærede type afgør, hvordan dets query string-værdi læses:
- string: bruges som den er.
- number: køres gennem
Number(...). - boolean: kun den bogstavelige streng
truelæses somtrue. Alt andet, du sender til et boolean-felt vedGET, ogsåfalse, konverteres til et sandt1. Hvis en boolean har betydning, så send den vedPOSTmed et rigtigt JSON-true/false, eller udelad blot query-parameteren for at lade den stå på metodens standard. - object / array: værdien køres gennem
JSON.parse(...), så en indlejret værdi vedGETskal være én query-parameter med en JSON-streng (filters=%7B%22status%22%3A%22open%22%7D), ikke indlejring i parentesstil.
Obligatoriske felter og typefejl
Hver af en metodes felter har et mandatory-flag og en type. Hvis et obligatorisk felt mangler, eller du
sender den forkerte type ved POST (hvor intet konverteres automatisk), får du et -1 tilbage, før selve
metoden overhovedet kører:
Den interaktive API-reference viser hver metodes felter med typer og obligatoriske flag og lader dig køre et kald fra browseren for at se den præcise anmodning, den byggede.