complexType "ns:UploadSiteHostedPicturesRequestType"

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

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

Component Diagram

XML Representation Summary

<...>

Content:

ns:DetailLevel*, ns:ErrorLanguage?, ns:MessageID?, ns:Version?, ns:EndUserIP?, ns:ErrorHandling?, ns:InvocationID?, ns:OutputSelector*, ns:WarningLevel?, ns:BotBlock?, {any}*, ns:PictureName?, ns:PictureSystemVersion?, ns:PictureSet?, ns:PictureData?, ns:PictureUploadPolicy?, ns:ExternalPictureURL*, ns:PictureWatermark*, ns:ExtensionInDays?

</...>

All Direct / Indirect Based Elements (1):

ns:UploadSiteHostedPicturesRequest

Known Usage Locations

As direct type of elements (1):

ns:UploadSiteHostedPicturesRequest

Annotation

Uploads a picture to the eBay Picture Service and returns a URL of the picture. You will use this URL when creating, revising, or relisting an item with the Trading API.

Type Definition Detail

Type Derivation Tree

ns:AbstractRequestType (extension)

ns:UploadSiteHostedPicturesRequestType

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

<xs:complexType name="UploadSiteHostedPicturesRequestType">

<xs:complexContent>

<xs:extension base="ns:AbstractRequestType">

<xs:sequence>

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

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

<xs:element minOccurs="0" name="PictureSet" type="ns:PictureSetCodeType"/>

<xs:element minOccurs="0" name="PictureData" type="ns:Base64BinaryType"/>

<xs:element minOccurs="0" name="PictureUploadPolicy" type="ns:PictureUploadPolicyCodeType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="ExternalPictureURL" type="xs:anyURI"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="PictureWatermark" type="ns:PictureWatermarkCodeType"/>

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

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

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

ns:ExtensionInDays

Type:

xs:int, predefined, simple content

By default, an unpublished picture will be hosted on the EPS server for five days before being purged. However, the seller has the option of using this field to set an expiration date further into the future (up to 30 days). Similarly, when a listing ends or expires, the images associated with the listing remain on the EPS server for an additional 90 days. The value in this field will add on to those 90 days.

Note: This call is restricted to applications that have been granted permission. Contact the eBay Developers Program to request permission.

XML Representation Summary

<ns:ExtensionInDays>

Content:

{ xs:int }

</ns:ExtensionInDays>

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

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

ns:ExternalPictureURL

Type:

xs:anyURI, predefined, simple content

This field is used if the seller wishes to upload a picture to the EPS server that is currently on another external site. The URL of the picture you want to upload is passed in this field. Both http:// and https:// servers are supported. You can include only one ExternalPictureURL field per call.

The eBay server uses the information in this field to retrieve a picture from an external web server. Once retrieved, the picture will be copied to eBay Picture Services and retained for 30 days if not associated with a listing. When associated with a listing, the duration is the length of the listing plus 90 days.

Note: Although both the HTTP and HTTPS protocols are currently supported, in the near future, eBay will no longer allow the hosting or transfer of images on a server using the the HTTP protocol.

XML Representation Summary

<ns:ExternalPictureURL>

Content:

{ xs:anyURI }

</ns:ExternalPictureURL>

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

<xs:element maxOccurs="unbounded" minOccurs="0" name="ExternalPictureURL" type="xs:anyURI"/>

ns:PictureData

Type:

ns:Base64BinaryType, simple content

An optional reference ID to the binary attachment.

The PictureData field does not contain the binary attachment. The binary attachment is image data, including the headers, from a JPG, GIF, PNG, BMP, or TIF format image file. The binary attachment must be sent as a MIME attachment, in your POST request, after the XML input.

Note: This field is not applicable for eBay Large Merchant Services. Use the ExternalPictureURL field instead.

Component Diagram

XML Representation Summary

<ns:PictureData

contentType

xs:string

Content:

{ xs:base64Binary }

</ns:PictureData>

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

<xs:element minOccurs="0" name="PictureData" type="ns:Base64BinaryType"/>

ns:PictureName

Type:

xs:string, predefined, simple content

A seller-defined name for the picture. This field is optional, but can make it easier for a seller to track than an arbitrary, eBay-assigned URL.

XML Representation Summary

<ns:PictureName>

Content:

{ xs:string }

</ns:PictureName>

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

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

ns:PictureSet

Type:

ns:PictureSetCodeType, simple content

This enumeration value indicates the size of the picture that will be generated.

IMPORTANT: To get the standard website image sizing with Zoom, set this field to Supersize.

XML Representation Summary

<ns:PictureSet>

Content:

{ enumeration of xs:token }

</ns:PictureSet>

Simple Content

Enumeration:

"Standard"	-	Indicates to generate the "Standard" set of images, which is a set of 7 images of various sizes, for each ExternalPictureURL submitted in the request. This is the default. Note: This field is used only for images that will be used in a listing.
"Supersize"	-	Indicates to generate the "Standard" set plus a super-sized image for each ExternalPictureURL submitted in the request. In order to include the super-sized image in the Add Item calls, you must also specify Item.PictureDetails.PhotoDisplay.Supersize or Item.PictureDetails.PhotoDisplay.PicturePack. Note: This field is used only for images that will be used in a listing.
"Large"	-	This field is no longer returned.
"CustomCode"	-	Reserved for internal use only.

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

<xs:element minOccurs="0" name="PictureSet" type="ns:PictureSetCodeType"/>

ns:PictureSystemVersion

Type:

xs:int, predefined, simple content

Specifies the picture system version. Only version 2 is valid. Available to support future changes in the picture system version.

XML Representation Summary

<ns:PictureSystemVersion>

Content:

{ xs:int }

</ns:PictureSystemVersion>

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

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

ns:PictureUploadPolicy

Type:

ns:PictureUploadPolicyCodeType, simple content

Determines if the uploaded picture is to replace all the pictures or to be added to the pictures currently available to a seller on the eBay site. The picture is available to the seller on the My Picture Uploads tab within the Sell Your Item pages.

The picture you upload (and its URL) is stored for a period of time on the EPS server. If, within that time, the picture is associated with an item, then the picture persists on the eBay site for the same time length as other pictures uploaded using the UploadSiteHostedPictures call.

The expiration date of the picture is returned in the SiteHostedPictureDetails.UseByDate field in the response.

XML Representation Summary

<ns:PictureUploadPolicy>

Content:

{ enumeration of xs:token }

</ns:PictureUploadPolicy>

Simple Content

Enumeration:

"Add"	-	Specifies that an uploaded picture is added to the pictures available to a seller on the eBay site.
"ClearAndAdd"	-	Specifies, first, that all pictures available to a seller on the eBay site are removed, and then second, that the currently uploaded picture is made available to the seller.
"CustomCode"	-	Reserved for internal use ONLY.

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

<xs:element minOccurs="0" name="PictureUploadPolicy" type="ns:PictureUploadPolicyCodeType"/>

ns:PictureWatermark

Type:

ns:PictureWatermarkCodeType, simple content

This field is deprecated.

XML Representation Summary

<ns:PictureWatermark>

Content:

{ enumeration of xs:token }

</ns:PictureWatermark>

Simple Content

Enumeration:

"User"	-	This value is not used.
"Icon"	-	This value is not used.
"CustomCode"	-	This value is not used.

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

<xs:element maxOccurs="unbounded" minOccurs="0" name="PictureWatermark" type="ns:PictureWatermarkCodeType"/>

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.