Vastausrakenne

Vastaukset sisältävät aina kentän status, joka voi olla joko success tai failed riippuen pyynnön onnistumisesta. Lisäksi mukana on aina liittyvä vastaus kohdassa message, josta voi lukea tarkempia tietoja onnistuneesta tai epäonnistuneesta pyynnöstä. Mikäli pyyntö epäonnistuu, voit lukea lisää virheilmoituksista.

Onnistunut

Esimerkki onnistuneen pyynnön vastausrakenteesta:

{
  "status": "success",
  "message": "Käyttäjä luotu onnistuneesti",
  "user": 80
}

Tässä onnistuneen pyynnön vastauksessa status on success, message kertoo lyhyesti onnistumisesta ja user sisältää luodun käyttäjän tunnisteen.

Virheellinen

Virheellisen pyynnön vastausrakenne esimerkki:

{
  "status": "failed",
  "message": "Sähköposti on jo käytössä",
}

Virheellisen pyynnön vastauksessa status on failed, ja message-kohdassa annetaan kuvaus virheestä tai ongelmasta.