Metódus hívása
POST vagy GET, törzs és lekérdezési karakterlánc, és mit vár a mezőérvényesítő.
A metódus neve az URL része. Minden más bemenet, az azonosító is, paraméter: JSON-törzsmező POST esetén,
lekérdezési karakterlánc-paraméter GET esetén. Mindkét alak ugyanazt a metódust éri el, és ugyanazt a
burkolót adja vissza.
POST: JSON-törzs
A szokásos alak mindenhez, aminek néhánynál több paramétere van, vagy beágyazott objektuma vagy tömbje.
GET: lekérdezési karakterlánc
Kényelmes egy gyors ellenőrzéshez a böngésző címsorából vagy egy curl egysorosból. A szerver a lekérdezési
karakterláncot ugyanolyan törzsbe értelmezi, amilyet a metóduskezelő lát, ezért az alábbi szabályok itt
fontosabbak, mint POST esetén.
A mező deklarált típusa dönti el, hogyan olvasódik a lekérdezési karakterlánc értéke:
- string: változatlanul felhasználva.
- number: a
Number(...)függvényen megy át. - boolean: csak a szó szerinti
truekarakterlánc olvasódiktrueértékként. Bármi más, amitGETesetén egy boolean mezőnek ad, afalseis, igaz1értékre kényszerül. Ha egy boolean számít,POSTesetén küldje valódi JSONtrue/falseértékkel, vagy egyszerűen hagyja el a lekérdezési paramétert, hogy a metódus alapértelmezésén maradjon. - object / array: az érték a
JSON.parse(...)függvényen megy át, így a beágyazott értékGETesetén egy JSON-karakterláncot tartalmazó lekérdezési paraméter kell legyen (filters=%7B%22status%22%3A%22open%22%7D), nem zárójeles lekérdezésbeágyazás.
Kötelező mezők és típushibák
A metódus mezői mind hordoznak egy mandatory jelzőt és egy type értéket. A kötelező mező hiánya, vagy a
rossz típus küldése POST esetén (ahol semmi sem kényszerül automatikusan), -1 választ ad, mielőtt maga a
metódus egyáltalán lefutna:
Az interaktív API-referencia minden metódus mezőit listázza a típusaikkal és kötelező jelzőikkel, és lehetővé teszi, hogy a böngészőből futtasson egy hívást, hogy lássa az általa összeállított pontos kérést.