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:ApplicationDeliveryPreferencesType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 8 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 8 elements, elem. wildcard
Used:
at 2 locations
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:ApplicationURL?, ns:ApplicationEnable?, ns:AlertEmail?, ns:AlertEnable?, ns:NotificationPayloadType?, ns:DeviceType?, ns:PayloadVersion?, ns:DeliveryURLDetails*, {any}*
</...>
All Direct / Indirect Based Elements (2):
ns:ApplicationDeliveryPreferences (in ns:GetNotificationPreferencesResponse),
ns:ApplicationDeliveryPreferences (in ns:SetNotificationPreferencesRequest)
Known Usage Locations
Annotation
Type used by the ApplicationDeliveryPreferences container to control/indicate where and how Platform Notifications and/or Client Alerts are delivered to a user application, server, and/or email address.
XML Source (w/o annotations (9); see within schema source)
<xs:complexType name="ApplicationDeliveryPreferencesType">
<xs:sequence>
<xs:element minOccurs="0" name="ApplicationURL" type="xs:anyURI"/>
<xs:element minOccurs="0" name="ApplicationEnable" type="ns:EnableCodeType"/>
<xs:element minOccurs="0" name="AlertEmail" type="xs:anyURI"/>
<xs:element minOccurs="0" name="AlertEnable" type="ns:EnableCodeType"/>
<!-- this element is deprecated -->
<xs:element minOccurs="0" name="NotificationPayloadType" type="ns:NotificationPayloadTypeCodeType"/>
<!-- end of deprecated element -->
<xs:element minOccurs="0" name="DeviceType" type="ns:DeviceTypeCodeType"/>
<xs:element minOccurs="0" name="PayloadVersion" type="xs:string"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="DeliveryURLDetails" type="ns:DeliveryURLDetailType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 9/9)
ns:AlertEmail
Type:
xs:anyURI, predefined, simple content
The email address to which eBay sends all application markup and markdown event notifications. When setting the email address, input must be in the format "mailto://youremailaddress@yoursite.com". Note that the AlertEnable field must be set to Enable for alert emails to be sent.
XML Representation Summary
<ns:AlertEmail>
   
Content: 
{ xs:anyURI }
</ns:AlertEmail>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AlertEmail" type="xs:anyURI"/>
ns:AlertEnable
Type:
ns:EnableCodeType, simple content
For SetNotificationPreferences: include and set AlertEnable to Enable to receive application markup and markdown alerts, or set to Disable to disable the alerts. If not included, the AlertEnable defaults to its current value.

For GetNotificationPreferences: this field's value indicates whether application markup and markdown alerts are enabled or disabled.
XML Representation Summary
<ns:AlertEnable>
   
Content: 
{ enumeration of xs:token }
</ns:AlertEnable>
Simple Content
Enumeration:
"Enable"
 - 
This enumeration value indicates that an application/URL/device is enabled to receive notifications, or to indicate that a specific notification event is enabled.
"Disable"
 - 
This enumeration value indicates that an application/URL/device is disabled, or being blocked from receiving notifications, or to indicate that a specific notification event is disabled.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AlertEnable" type="ns:EnableCodeType"/>
ns:ApplicationEnable
Type:
ns:EnableCodeType, simple content
This field allows the user to enable or disable Platform Notifications and Client Alerts. Notice that disabling Platform Notifications and Client Alerts will not affect others preferences set in this container.
XML Representation Summary
<ns:ApplicationEnable>
   
Content: 
{ enumeration of xs:token }
</ns:ApplicationEnable>
Simple Content
Enumeration:
"Enable"
 - 
This enumeration value indicates that an application/URL/device is enabled to receive notifications, or to indicate that a specific notification event is enabled.
"Disable"
 - 
This enumeration value indicates that an application/URL/device is disabled, or being blocked from receiving notifications, or to indicate that a specific notification event is disabled.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ApplicationEnable" type="ns:EnableCodeType"/>
ns:ApplicationURL
Type:
xs:anyURI, predefined, simple content
The URL to which eBay delivers all Platform Notifications and Client Alerts sent to the application. For delivery to a server, the URL must begin with "https://" and must be well formed.
XML Representation Summary
<ns:ApplicationURL>
   
Content: 
{ xs:anyURI }
</ns:ApplicationURL>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ApplicationURL" type="xs:anyURI"/>
ns:DeliveryURLDetails
Type:
ns:DeliveryURLDetailType, complex content
Defines settings for notification URLs (including the URL name in DeliveryURLName). You define settings for up to 25 notification URLs (including the URL name in DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with notification URLs by using the token in a SetNotificationPreferences request that specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use comma-separated format to specify multiple URL names in SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable.
Component Diagram
XML Representation Summary
<ns:DeliveryURLDetails>
   
Content: 
ns:DeliveryURLName?, ns:DeliveryURL?, ns:Status?, {any}*
</ns:DeliveryURLDetails>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="DeliveryURLDetails" type="ns:DeliveryURLDetailType"/>
ns:DeviceType
Type:
ns:DeviceTypeCodeType, simple content
The means of receipt of notification. In most cases, it is Platform (typical API calls and web interaction), so this is the default, if not specified. For wireless applications, use SMS. Do not test Client Alerts in production if you are currently using Platform Notifications.
XML Representation Summary
<ns:DeviceType>
   
Content: 
{ enumeration of xs:token }
</ns:DeviceType>
Simple Content
Enumeration:
"Platform"
 - 
This enumeration value indicates that buyer/seller notifications will be delivered through the Platform Notifications system.
"SMS"
 - 
This enumeration value indicates that buyer/seller notifications will be delivered through the SMS system to a wireless device.
"ClientAlerts"
 - 
This enumeration value indicates that buyer/seller notifications will be delivered through the Client Alerts system.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DeviceType" type="ns:DeviceTypeCodeType"/>
ns:NotificationPayloadType
Type:
ns:NotificationPayloadTypeCodeType, simple content
This field is deprecated and should no longer be used.
XML Representation Summary
<ns:NotificationPayloadType>
   
Content: 
{ enumeration of xs:token }
</ns:NotificationPayloadType>
Simple Content
Enumeration:
"eBLSchemaSOAP"
 - 
New Schema format (used by the new schema XML API and SOAP API).
"CustomCode"
 - 
Reserved for internal or future use
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="NotificationPayloadType" type="ns:NotificationPayloadTypeCodeType"/>
ns:PayloadVersion
Type:
xs:string, predefined, simple content
Use this field to specify the API version for all notifications for the calling application. If you do not specify PayloadVersion in SetNotificationPreferences, the API version for notifications will be based on the API version specified in your SetNotificationPreferences call.
XML Representation Summary
<ns:PayloadVersion>
   
Content: 
{ xs:string }
</ns:PayloadVersion>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PayloadVersion" type="xs:string"/>
{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.