StatusResponse Data Type

A generic status response to use as a response when other datatypes may feel inappropriate. As in deletion endpoints, where all you need is a success status. Created by nick on 11/22/17.

Properties
name data type constraints description
success boolean required boolean Whether or not the operation was a success.
Properties inherited from BaseEntity
violations array of SimpleViolation   A list of constraint violations, if any, that this object has.

Example

{
  "success" : true,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}