Each API call returns either a JSON Object with requested information or an object with a pair of Name/Value reflecting a state of the requested operation, which may also contain an error message with description.

First name/value reflects if the call was executed properly:

  • “Success”: true –  In case the request was correct (accepted) and executed properly.
  • “Success”: false – Error has occurred.

Second name/value brings short descriptive text on any result:

  • “Result”: “OK” – In case the request was correct (accepted) and executed properly.
  • “ErrorDescription”: “text error description” – If an error has occurred.
Success Response Example:

{
“Success”: true,
“Result”: “Filter 1110 has been updated”
}

Error Response Examples:

{
“Success”: false,
“ErrorDescription”: [
“Login Failed! Check your User Name or Password”
] }

{ “Success”: false, “ErrorDescription”: “Invalid History ID” }