Type |
Description |
Required Keys |
Optional Keys |
success |
All went well, and (usually) some data was returned. |
status , payload |
|
fail |
There was a problem with the data submitted, or some pre-condition of the API call wasn't satisfied |
status , payload |
|
error |
An error occurred in processing the request, i.e. an exception was thrown |
status , message |
code , payload |
{
"status": "success",
"payload": {
"members": [
{ "id": 1, "name": "Eugene" },
{ "id": 2, "name": "Alex" }
],
"meta": {
"totalPages": 3,
"totalItems": 5,
"perPage": 2,
"currentPage": 1
}
}
}
{
"status": "fail",
"payload": {
"title": "Title is required"
}
}