Metodin kutsuminen
POST vai GET, runko vai kyselymerkkijono ja mitä kenttien validointi odottaa.
Metodin nimi on osa URL-osoitetta. Jokainen muu syöte, myös tunnus, on parametri: JSON-rungon kenttä
POST-kutsussa, kyselymerkkijonon parametri GET-kutsussa. Molemmat muodot tavoittavat saman metodin ja palauttavat
saman vastausrakenteen.
POST: JSON-runko
Tavallinen muoto kaikelle, jossa on enemmän kuin pari parametria tai sisäkkäinen objekti tai taulukko.
GET: kyselymerkkijono
Kätevä nopeaan tarkistukseen selaimen osoiterivistä tai curl-yksirivisestä. Palvelin jäsentää
kyselymerkkijonon samaksi rungoksi, jonka metodin käsittelijä näkee, joten alla olevat säännöt ovat tärkeämpiä täällä kuin
POST-kutsussa.
Kentän ilmoitettu tyyppi ratkaisee, miten sen kyselymerkkijonon arvo luetaan:
- string: käytetään sellaisenaan.
- number: ajetaan
Number(...)-funktion läpi. - boolean: vain merkkijono
trueluetaan arvoksitrue. Kaikki muu, mitä annat boolean-kentälleGET-kutsussa, myösfalse, muunnetaan tosi-arvoksi1. Jos boolean-arvolla on merkitystä, lähetä sePOST-kutsulla oikeana JSON-arvonatrue/false, tai jätä kyselyparametri pois, jolloin metodin oletus pysyy voimassa. - object / array: arvo ajetaan
JSON.parse(...)-funktion läpi, joten sisäkkäisen arvonGET-kutsussa on oltava yksi kyselyparametri, joka sisältää JSON-merkkijonon (filters=%7B%22status%22%3A%22open%22%7D), ei hakasulkutyylistä kyselysisäkkäisyyttä.
Pakolliset kentät ja tyyppivirheet
Metodin jokaisella kentällä on mandatory-lippu ja type. Pakollisen kentän puuttuminen tai väärän tyypin
lähettäminen POST-kutsussa (jossa mitään ei muunneta automaattisesti) palauttaa -1 ennen kuin
itse metodi ajetaan:
Interaktiivinen API-viite listaa jokaisen metodin kentät tyyppeineen ja pakollisuuslippuineen ja antaa ajaa kutsun selaimesta, jolloin näet sen rakentaman tarkan pyynnön.