Responses

When a request is successful, a response body will typically be sent back in the form of a JSON object. An exception to this is when a DELETE request is processed, which will result in a successful HTTP 204 status and an empty response body.

Inside of this JSON object, all objects share the same key structure, ensuring consistency across the API responses. Each object will include the following keys: success, message, meta, errors, and result. This uniform structure allows for predictable parsing and handling of the API responses, making it easier to integrate and debug.

Response for a Single Object

{
    "result": {
        "name": "Fauzan Gifari"
    }
}

Response for an Object Collection

{
    "result": [
        {
            "name": "Fauzan Gifari"
        },
        {
            "name": "Rifan Fathoni"
        }
    ]
}

Response for a Single Object#

Response for an Object Collection#

Response for a Single Object

Response for an Object Collection