Responses

All the responses, success or insuccess, have the same Object properties.

Field

Type

Description

data

Array, Object

Response main data

meta

Object

Response metadata (messages and/or error description)

status

Boolean

Response status

Meta response examples

// Example - Success
{
  "data": {
    ...
  },
  "meta": {
    "message": "..."
  },
  "status": true
}

// Example - Error
{
  "data": {},
  "meta": {
    "message": "...",
    "code": "BIOFSGB001" // Detailed code for the error
  },
  "status": false
}

Last updated

Was this helpful?