ErrorData
This type is used to show any errors or warnings that were triggered by the request.
Type that uses ErrorData:
Call that uses ErrorData:
Fields
longMessage ( string )
parameter ( array of ErrorParameter )
category ( ErrorCategory ) [0..?]
The category type for this error or warning.
The value returned in this field will be one of the values defined in the ErrorCategory type, and these values are discussed below.
The value returned in this field will be one of the values defined in the ErrorCategory type, and these values are discussed below.
See the Field Index to learn which calls use category.
Name of the domain, primary system or service, or application where the error occurred.
See the Field Index to learn which calls use domain.
A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Error messages and their corresponding IDs can be found on the Errors by Number page.
Error messages and their corresponding IDs can be found on the Errors by Number page.
See the Field Index to learn which calls use errorId.
The HTTP status code that resulted from the request.
See the Field Index to learn which calls use httpStatusCode.
A more detailed explanation of the error than given in the
message error field.
See the Field Index to learn which calls use longMessage.
Information on how to correct the problem, where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the locale of the request.
See the Field Index to learn which calls use message.
parameter ( array of ErrorParameter ) [0..?]
This optional list of name/value pairs that contain context-specific
ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.
See the Field Index to learn which calls use parameter.
severity ( ErrorSeverity ) [0..?]
The severity can be either a WARNING or an ERROR, where a warning does not stop the processing of the request while an error does.
While you must fix errors before the service will process your request, you should also fix all warnings to ensure your application runs as designed.
While you must fix errors before the service will process your request, you should also fix all warnings to ensure your application runs as designed.
See the Field Index to learn which calls use severity.