Calling a method
POST alebo GET, telo oproti reťazcu dopytu a čo očakáva validátor polí.
Názov metódy je súčasťou adresy URL. Každý ďalší vstup, aj id, je parameter: pole v tele JSON pri
POST, parameter reťazca dopytu pri GET. Obe podoby dosiahnu tú istú metódu a vrátia tú istú
obálku.
POST: telo JSON
Bežný tvar pre všetko s viac než niekoľkými parametrami alebo s vnoreným objektom či poľom.
GET: reťazec dopytu
Praktický na rýchlu kontrolu z adresného riadka prehliadača alebo jednoriadkový curl. Server
spracuje reťazec dopytu do rovnakého tela, aké vidí obsluha metódy, takže nižšie uvedené pravidlá
sú tu dôležitejšie než pri POST.
O tom, ako sa hodnota reťazca dopytu číta, rozhoduje deklarovaný typ poľa:
- string: použije sa tak, ako je.
- number: prejde cez
Number(...). - boolean: len doslovný reťazec
truesa číta akotrue. Čokoľvek iné, čo priGETzadáte do poľa boolean, vrátanefalse, sa pretypuje na pravdivé1. Ak na hodnote boolean záleží, pošlite ju cezPOSTso skutočným JSONtrue/false, alebo parameter dopytu jednoducho vynechajte, aby zostal na predvolenej hodnote metódy. - object / array: hodnota prejde cez
JSON.parse(...), takže vnorená hodnota priGETmusí byť jeden parameter dopytu s reťazcom JSON (filters=%7B%22status%22%3A%22open%22%7D), nie vnorenie v štýle zátvoriek.
Povinné polia a chyby typu
Polia metódy majú každé príznak mandatory a type. Chýbajúce povinné pole alebo odoslanie
nesprávneho typu pri POST (kde sa nič automaticky nepretypúva) vám vráti -1 skôr, než sa
samotná metóda vôbec spustí:
Interaktívna API reference uvádza polia každej metódy s ich typmi a príznakmi povinnosti a umožňuje spustiť volanie z prehliadača, aby ste videli presnú požiadavku, ktorú zostavilo.