Response Fields:

  • "success" = A boolean value if request was a success (TRUE) or a failure (FALSE)
  • "result_data" = On object of returned data (this will depend on the method used).
  • "result_text" = An english sentence describing the result of the request. This can be an error message or success text that can logged or displayed to end user.

Example validation error response:

{
   "success": false,
   "result_data": {
      "errors": [
         "'create_time' is not a valid date"
      ]
   },
   "result_text": "Validation failed, see 'result_data' -> 'errors'"
}

 

Did this answer your question?