complexType "ns:StoreCustomPageType"

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:StoreCustomPageType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 9 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 9 elements, elem. wildcard
Used:	at 3 locations

Component Diagram

XML Representation Summary

<...>

Content:

ns:Name?, ns:PageID?, ns:URLPath?, ns:URL?, ns:Status?, ns:Content?, ns:LeftNav?, ns:PreviewEnabled?, ns:Order?, {any}*

</...>

All Direct / Indirect Based Elements (3):

ns:CustomPage (in ns:CustomPageArray),

ns:CustomPage (in ns:SetStoreCustomPageRequest),

ns:CustomPage (in ns:SetStoreCustomPageResponse)

Known Usage Locations

As direct type of elements (3):

ns:CustomPage (in ns:CustomPageArray),

ns:CustomPage (in ns:SetStoreCustomPageRequest),

ns:CustomPage (in ns:SetStoreCustomPageResponse)

XML Source (w/o annotations (10); see within schema source)

<xs:complexType name="StoreCustomPageType">

<xs:sequence>

<xs:element minOccurs="0" name="Name" type="xs:string"/>

<xs:element minOccurs="0" name="PageID" type="xs:long"/>

<xs:element minOccurs="0" name="URLPath" type="xs:string"/>

<xs:element minOccurs="0" name="URL" type="xs:anyURI"/>

<xs:element minOccurs="0" name="Status" type="ns:StoreCustomPageStatusCodeType"/>

<xs:element minOccurs="0" name="Content" type="xs:string"/>

<xs:element minOccurs="0" name="LeftNav" type="xs:boolean"/>

<xs:element minOccurs="0" name="PreviewEnabled" type="xs:boolean"/>

<xs:element minOccurs="0" name="Order" type="xs:int"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 10/10)

ns:Content

Type:

xs:string, predefined, simple content

The HTML content of the eBay Store custom page. This field has a maximum size of 96 kilobytes. If the PreviewEnabled field is set to 'true', then this field is required in a SetStoreCustomPage call. Otherwise, it is optional.

The Content field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.

XML Representation Summary

<ns:Content>

Content:

{ xs:string }

</ns:Content>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Content" type="xs:string"/>

ns:LeftNav

Type:

xs:boolean, predefined, simple content

This flag controls whether or not the left navigation bar is included in the eBay Store custom page. To include the left navigation bar in a custom page, the seller will include the LeftNav field in the SetStoreCustomPage request and set it to 'true'.

The LeftNav field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.

XML Representation Summary

<ns:LeftNav>

Content:

{ xs:boolean }

</ns:LeftNav>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="LeftNav" type="xs:boolean"/>

ns:Name

Type:

xs:string, predefined, simple content

Name of the eBay Store custom page. This value is required if you are creating a new page (and omitting a PageID value). Note that you must include a name for the page even if you are using the PreviewEnabled flag. However, since using the preview functionality means that the page will not be persisted, you can enter a dummy value for this field if you have not decided on a name for the page. The Name value is used in links to the page.

XML Representation Summary

<ns:Name>

Content:

{ xs:string }

</ns:Name>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Name" type="xs:string"/>

ns:Order

Type:

xs:int, predefined, simple content

This integer value controls the order in which the corresponding eBay Store custom page is displayed in the list of custom pages. To make the corresponding custom page appear first in the list of custom pages, the seller would include the Order field and set its value to '1'.

The Order value is always returned in the GetStoreCustomPage response.

XML Representation Summary

<ns:Order>

Content:

{ xs:int }

</ns:Order>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Order" type="xs:int"/>

ns:PageID

Type:

xs:long, predefined, simple content

Unique identifier for an eBay Store custom page. If you specify a valid PageID value in a SetStoreCustomPage call, the existing custom page is updated. If you do not specify a PageID value, you are creating a new custom page.

The PageID field is always returned in GetStoreCustomPage.

XML Representation Summary

<ns:PageID>

Content:

{ xs:long }

</ns:PageID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PageID" type="xs:long"/>

ns:PreviewEnabled

Type:

xs:boolean, predefined, simple content

This flag controls whether or not a custom page preview is enabled. To enable the a custom page preview, the seller will include the PreviewEnabled field in the SetStoreCustomPage request and set it to 'true'.

The PreviewEnabled field is only returned in the GetStoreCustomPage response if a PageID value is included in the request.

XML Representation Summary

<ns:PreviewEnabled>

Content:

{ xs:boolean }

</ns:PreviewEnabled>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PreviewEnabled" type="xs:boolean"/>

ns:Status

Type:

ns:StoreCustomPageStatusCodeType, simple content

This value indicates the status of the eBay custom page. In a SetStoreCustomPage call, the seller uses the optional Status field to make an inactive custom page active, to make an active custom page inactive, or to delete an active or inactive custom page. To change the status (including delete) of a custom page, a PageID value must be included to identify the custom page to modify.

The Status value is always returned in the GetStoreCustomPage response.

XML Representation Summary

<ns:Status>

Content:

{ enumeration of xs:token }

</ns:Status>

Simple Content

Enumeration:

"Active"	-	The page is visible.
"Delete"	-	The page is to be deleted.
"Inactive"	-	The page is not visible.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Status" type="ns:StoreCustomPageStatusCodeType"/>

ns:URL

Type:

xs:anyURI, predefined, simple content

The full URL of the eBay Store custom page, which is generally derived from the CustomPage.Name value. The exception to this rule is if the seller specified a custom URL using the CustomPage.URLPath field in a SetStoreCustomPage call.

The URL is only returned in the GetStoreCustomPage response if a PageID value is included in the request.

XML Representation Summary

<ns:URL>

Content:

{ xs:anyURI }

</ns:URL>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="URL" type="xs:anyURI"/>

ns:URLPath

Type:

xs:string, predefined, simple content

The URL path of the eBay Store custom page. This field is only required if you are using Chinese characters in the Name field. The URL path of the eBay Store custom page is normally derived from the Name field, but the URL path cannot be derived from the name of the custom page if it contains Chinese characters because URLs cannot contain Chinese characters.

The URLPath is only returned in the GetStoreCustomPage response if it is defined for the eBay Store custom page, and if a PageID value is included in the request.

XML Representation Summary

<ns:URLPath>

Content:

{ xs:string }

</ns:URLPath>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="URLPath" 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.