Structure of system responses

The response to each request contains the following fields: status, status_code, message, result.

When the request is successfully processed, the value parameter “status” is always “true” and “status_code” is 0 in the response.

In other cases, the “status_code” field displays the reason why the request was processed incorrectly.

Field designation
Datatype
Description

status

bool

The field indicates whether the request was successfully processed

status_code

integer

Error code

message

string

Textual description of the error code

result

object

Result of the resource