Volání metody
POST nebo GET, tělo nebo řetězec dotazu a co očekává validátor polí.
Název metody je součástí URL. Každý další vstup, včetně id, je parametr: pole těla JSON u POST,
parametr řetězce dotazu u GET. Obě podoby míří na stejnou metodu a vrací stejnou obálku.
POST: tělo JSON
Běžný tvar pro cokoli, co má víc než pár parametrů nebo vnořený objekt či pole.
GET: řetězec dotazu
Šikovné pro rychlou kontrolu z adresního řádku prohlížeče nebo jednořádkový curl. Server
zpracuje řetězec dotazu do stejného těla, které vidí obsluha metody, takže pravidla níže tu
záleží víc než u POST.
O tom, jak se hodnota z řetězce dotazu přečte, rozhoduje deklarovaný typ pole:
- string: použije se tak, jak je.
- number: projde přes
Number(...). - boolean: jen doslovný řetězec
truese čte jakotrue. Cokoli jiného, co u pole boolean předáte přesGET, včetněfalse, se převede na pravdivé1. Pokud na hodnotě boolean záleží, pošlete ji přesPOSTse skutečným JSONtrue/false, nebo parametr dotazu prostě vynechte, aby zůstal na výchozí hodnotě metody. - object / array: hodnota projde přes
JSON.parse(...), takže vnořená hodnota uGETmusí být jeden parametr dotazu s řetězcem JSON (filters=%7B%22status%22%3A%22open%22%7D), ne vnořování v závorkách.
Povinná pole a chyby typu
Každé pole metody nese příznak mandatory a type. Chybějící povinné pole nebo špatný typ
poslaný přes POST (kde se nic automaticky nepřetypovává) vám vrátí -1 dřív, než se metoda
vůbec spustí:
Interaktivní reference API uvádí pole každé metody s jejich typy a příznaky povinnosti a umožňuje spustit volání z prohlížeče, abyste viděli přesný požadavek, který sestavilo.