Class ErrorType

class 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.

Defined in com/ebay/shoppingservice/ErrorType.js

Property Summary
ErrorClassificationCodeType errorClassification
API errors are divided between two classes: system errors and request errors.
token errorCode
A unique code that identifies the particular error condition that occurred.
Array errorParameters
Some warning and error messages return one or more variables that contain contextual information about the error.
String longMessage
A more detailed description of the condition that raised the error.
SeverityCodeType severityCode
Indicates whether the error caused the request to fail.

If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request.
String shortMessage
A brief description of the condition that raised the error.
Boolean userDisplayHint
This field is not currently in use for eBay Shopping Web Services.

Constructor Summary
ErrorType(Object props)

Property Details

property ErrorClassificationCodeType errorClassification

API errors are divided between two classes: system errors and request errors.

property token errorCode

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.

property Array errorParameters

Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page.

property String longMessage

A more detailed description of the condition that raised the error.

property SeverityCodeType severityCode

Indicates whether the error caused the request to fail.

If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.

If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

property String shortMessage

A brief description of the condition that raised the error.

property Boolean userDisplayHint

This field is not currently in use for eBay Shopping Web Services. 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.

Constructor Details

constructor ErrorType

ErrorType(Object props)

Parameters:
props