Options
All
  • Public
  • Public/Protected
  • All
Menu

Basic API response shape provided by the API.

Each API response is typically composed, at minimum, of:

  • code or a number which points to a particular response type
  • message a human readable string which indicates the nature of the response

Hierarchy

Index

Properties

Properties

code

code: number

Custom response code returned by API.

The response codes first 3 digits, reflects the HTTP status. e.g. 2000 would accompany a 200 OK HTTP status.

We do not recommend performing > or < type comparison operations on code even though its type is number. This prohibits us from producing more than 10 response codes per HTTP status.

message

message: string

Human readable success or error message returned by API.