Anropa en metod
POST eller GET, kropp jämfört med frågesträng och vad fältvalideraren förväntar sig.
Ett metodnamn är en del av URL:en. All annan indata, även ett id, är en parameter: ett fält i
JSON-kroppen vid POST, en parameter i frågesträngen vid GET. Båda formerna når samma metod och
ger samma svarsformat.
POST: en JSON-kropp
Den vanliga formen för allt med fler än ett par parametrar, eller med ett nästlat objekt eller en array.
GET: en frågesträng
Praktiskt för en snabb kontroll från webbläsarens adressfält eller en curl-enradare. Servern
tolkar frågesträngen till samma kropp som metodhanteraren ser, så reglerna nedan spelar större
roll här än vid POST.
Ett fälts deklarerade typ avgör hur dess värde i frågesträngen läses:
- string: används som det är.
- number: körs genom
Number(...). - boolean: bara den bokstavliga strängen
trueläses somtrue. Allt annat du skickar för ett boolean-fält vidGET, ävenfalse, konverteras till ett sanningsvärde1. Om en boolean spelar roll, skicka den vidPOSTmed ett riktigt JSON-värdetrue/false, eller utelämna frågeparametern så att den får metodens standardvärde. - object / array: värdet körs genom
JSON.parse(...), så ett nästlat värde vidGETmåste vara en enda frågeparameter som innehåller en JSON-sträng (filters=%7B%22status%22%3A%22open%22%7D), inte nästling i klammerstil.
Obligatoriska fält och typfel
Varje fält i en metod har en flagga mandatory och en type. Om ett obligatoriskt fält saknas,
eller om fel typ skickas vid POST (där inget konverteras automatiskt), får du tillbaka en -1
innan själva metoden ens körs:
Den interaktiva API reference listar varje metods fält med deras typer och obligatoriska flaggor, och låter dig köra ett anrop från webbläsaren för att se exakt vilken förfrågan det byggde.