Minden a rendszerhez kapcsolódó API hívás egy azonos response schema -t követ, melynek alap elemei a result és a data. A result paraméter két kötelező elemmel rendelkezik, a code és a message.
Amennyiben sikeres a hívás úgy a data felveszi az adott API csatoló visszatérési értékeit, sikertelen hívás esetén NULL értéket kap.
A result paraméter code eleme 0 vagy 1 értéket vesz fel minden esetben, a hívás sikerességétől függően. A result paraméter message eleme pedig részletezi a visszatérési értéket, sikeres hívás esetén success egyéb esetben pedig a hibaüzeneteket.
A lenti példákat szemléltetésképp mutatjuk be, ezért nem tartalmazzák az egész API response-t!
Például:
a terméklista lekérdezése során az alábbi eredménnyel találkozhatunk:
method: GET
url: https://www.logzi.com/api/product/list
headers: Accept:application/json
{
"result": {
"code": 1,
"message": "success"
}
"data": { ... }
}
