ErrorType
These are request errors (as opposed to system errors) that occur due to problems with business-level data (e.g., an invalid combination of arguments) that the application passed in.
Types that use ErrorType:
Calls that use ErrorType:
Fields
LongMessage ( string )
ShortMessage ( string )
ErrorClassification ( ErrorClassificationCodeType ) [0..1]
API errors are divided between two classes: system errors and request errors.
See the Field Index to learn which calls use ErrorClassification.
A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
See the Field Index to learn which calls use ErrorCode.
ErrorParameters ( ErrorParameterType ) [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
See the Field Index to learn which calls use ErrorParameters.
A more detailed description of the condition that raised the error.
See the Field Index to learn which calls use LongMessage.
SeverityCode ( SeverityCodeType ) [0..1]
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
See the Field Index to learn which calls use SeverityCode.
A brief description of the condition that raised the error.
See the Field Index to learn which calls use ShortMessage.
Not used by any call.
Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Only applicable to Item Specifics errors and warnings returned from listing requests.
Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Only applicable to Item Specifics errors and warnings returned from listing requests.
See the Field Index to learn which calls use UserDisplayHint.