Reference for RimuHosting's Data Structures (as used in our REST-ful APIs)

Name: IErrorInfo

An interface that describes an error. Used in some of our JAXRS responses.

XML Example:
<IErrorInfo>
  <error_class>xsd:string</error_class>
  <error_title>xsd:string</error_title>
  <field_name>xsd:string</field_name>
  <full_error_message>xsd:string</full_error_message>
  <human_readable_message>xsd:string</human_readable_message>
</IErrorInfo>
JSON Example:
{"IErrorInfo":
 {
   "error_class": String,
   "error_title": String,
   "field_name": String,
   "full_error_message": String,
   "human_readable_message": String,
 }
}

Elements
NameTypeRequiredNillableDefault ValueDescription
error_classxsd:stringfalsefalseName of the Java class triggering the error.
error_titlexsd:stringfalsefalseA 'title' for the error.
field_namexsd:stringfalsefalseIf the error is a validation error, this will include the field's name.
full_error_messagexsd:stringfalsefalseIn most cases the text you need is in the human_readable_message.
human_readable_messagexsd:stringfalsefalseTypically this is the message you want to display to an end user.