restError

Namespace:	(default namespace)
XML Schema:	vcac-identity-rest-schema.xsd

This class is used to capture information about any exception on the server side that will be sent to the REST API consumer as part of the body message in addition to the HTTP Status code in the header response.

XML

Attributes

name	type	description
code	int	The code property is an error code in addition to the http status code. It is something that conveys information very specific to a particular problem domain.
moreInfoUrl	string	The moreInfo property specifies a URL for which target web page should describe the error condition fully, as well as potential solutions (KBs) to help resolve the error condition.

Elements

name (type)	min/max occurs	description
source (string)	0/1	Identifies the specific object that is the subject of the error. E.g. a specific mandatory field within a form for which no value has been specified. The format of this property is defined as part of the contract with the server.
message (string)	0/1	The message property is a nice human readable and localized error message that can potentially be shown directly to an application end user. It should be friendly and easy to understand and convey a concise reason as to why the error occurred. It should probably not contain technical information. Technical information should be in the systemMessage property instead.
systemMessage (string)	0/1	The sytemMessage provides technical system information that might be useful during development, debugging and troubleshooting. It could be a bit more verbose, not localized language description of the problem with as much as possible hints of what might be the actual technical system problem. Usually, this could be populated with the same information that goes to the error log (e.getMessage() without a stack trace).

JSON

property	type	description
code	int	The code property is an error code in addition to the http status code. It is something that conveys information very specific to a particular problem domain.
moreInfoUrl	string	The moreInfo property specifies a URL for which target web page should describe the error condition fully, as well as potential solutions (KBs) to help resolve the error condition.
source	source (string)	Identifies the specific object that is the subject of the error. E.g. a specific mandatory field within a form for which no value has been specified. The format of this property is defined as part of the contract with the server.
message	message (string)	The message property is a nice human readable and localized error message that can potentially be shown directly to an application end user. It should be friendly and easy to understand and convey a concise reason as to why the error occurred. It should probably not contain technical information. Technical information should be in the systemMessage property instead.
systemMessage	systemMessage (string)	The sytemMessage provides technical system information that might be useful during development, debugging and troubleshooting. It could be a bit more verbose, not localized language description of the problem with as much as possible hints of what might be the actual technical system problem. Usually, this could be populated with the same information that goes to the error log (e.getMessage() without a stack trace).