Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:ErrorType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 7 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 7 elements, elem. wildcard
Used:
at 4 locations
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:ShortMessage?, ns:LongMessage?, ns:ErrorCode?, ns:UserDisplayHint?, ns:SeverityCode?, ns:ErrorParameters*, ns:ErrorClassification?, {any}*
</...>
All Direct / Indirect Based Elements (4):
ns:Errors (defined in ns:AbstractResponseType complexType),
ns:Errors (defined in ns:OrderArrayType complexType),
ns:Errors (in ns:AddItemResponseContainer),
ns:Errors (in ns:EndItemResponseContainer)
Known Usage Locations
Annotation
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.
XML Source (w/o annotations (8); see within schema source)
<xs:complexType name="ErrorType">
<xs:sequence>
<xs:element minOccurs="0" name="ShortMessage" type="xs:string"/>
<xs:element minOccurs="0" name="LongMessage" type="xs:string"/>
<xs:element minOccurs="0" name="ErrorCode" type="xs:token"/>
<xs:element minOccurs="0" name="UserDisplayHint" type="xs:boolean"/>
<xs:element minOccurs="0" name="SeverityCode" type="ns:SeverityCodeType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ErrorParameters" type="ns:ErrorParameterType"/>
<xs:element minOccurs="0" name="ErrorClassification" type="ns:ErrorClassificationCodeType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 8/8)
ns:ErrorClassification
Type:
ns:ErrorClassificationCodeType, simple content
API errors are divided between two classes: system errors and request errors.
XML Representation Summary
<ns:ErrorClassification>
   
Content: 
{ enumeration of xs:token }
</ns:ErrorClassification>
Simple Content
Enumeration:
"RequestError"
 - 
An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
"SystemError"
 - 
Indicates that an error has occurred on the eBay system side, such as a database or server down. An application 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.
"CustomCode"
 - 
(out) Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ErrorClassification" type="ns:ErrorClassificationCodeType"/>
ns:ErrorCode
Type:
xs:token, predefined, simple content
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 "Errors by Number" document.
XML Representation Summary
<ns:ErrorCode>
   
Content: 
{ xs:token }
</ns:ErrorCode>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ErrorCode" type="xs:token"/>
ns:ErrorParameters
Type:
ns:ErrorParameterType, complex content
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.
Component Diagram
XML Representation Summary
<ns:ErrorParameters
   
ParamID
 = 
xs:string
   
>
   
Content: 
ns:Value?, {any}*
</ns:ErrorParameters>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="ErrorParameters" type="ns:ErrorParameterType"/>
ns:LongMessage
Type:
xs:string, predefined, simple content
A more detailed description of the condition that raised the error.
XML Representation Summary
<ns:LongMessage>
   
Content: 
{ xs:string }
</ns:LongMessage>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="LongMessage" type="xs:string"/>
ns:SeverityCode
Type:
ns:SeverityCodeType, simple content
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.
XML Representation Summary
<ns:SeverityCode>
   
Content: 
{ enumeration of xs:token }
</ns:SeverityCode>
Simple Content
Enumeration:
see details at ns:SeverityCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SeverityCode" type="ns:SeverityCodeType"/>
ns:ShortMessage
Type:
xs:string, predefined, simple content
A brief description of the condition that raised the error.
XML Representation Summary
<ns:ShortMessage>
   
Content: 
{ xs:string }
</ns:ShortMessage>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShortMessage" type="xs:string"/>
ns:UserDisplayHint
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:UserDisplayHint>
   
Content: 
{ xs:boolean }
</ns:UserDisplayHint>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="UserDisplayHint" type="xs:boolean"/>
{any element from any namespace}
XML Source (see within schema source)
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.