XML element IErrorInfo

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

These data structures are used in our REST-ful APIs.
These data structures and their fields are in beta and subject to change. If you need to rely on them being stable, please contact RimuHosting so we can advise.

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
Name	Type	Required	Nillable	Description
error_class	xsd:string	false	false	Name of the Java class triggering the error.
error_title	xsd:string	false	false	A 'title' for the error.
field_name	xsd:string	false	false	If the error is a validation error, this will include the field's name.
full_error_message	xsd:string	false	false	In most cases the text you need is in the human_readable_message.
human_readable_message	xsd:string	false	false	Typically this is the message you want to display to an end user.