Universal API Responses

All calls to the API generate responses in JSON with the same basic formatting.

Name

Description

Type

IsSuccess

Will return true or false based on if the intended transaction was successful. In the case of an error, the value will be "false", and the error message will come through in the Message node

boolean

Message

The specific message that defines the outcome of the transaction. In the instance of an error, this is where the extended error message will be delivered.

string

Data

The cluster of data that acts as a response from the API corresponding to the transaction. This can be separated into subnodes, distinct based on what transaction was performed.

string


Did this page help you?