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.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
success boolean element 1/1 required boolean Whether or not the operation was a success.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded   A list of constraint violations, if any, that this object has.

Example

<statusResponse>
  <success>...</success>
  <violations>
    <propertyName>...</propertyName>
    <failureMessage>...</failureMessage>
    <stackTrace>...</stackTrace>
  </violations>
</statusResponse>