Component 
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API

complexType "ns:ReviseMyMessagesFoldersRequestType"
Namespace:
Content:
complex, 13 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 3 elements
Used:
Component Diagram
XML Representation Summary
<...>
   
Content: 
</...>
All Direct / Indirect Based Elements (1):
Known Usage Locations
Annotation
This call can be used to add, remove, or rename a custom folder in My eBay Messages. Note that the Inbox and Sent folders cannot be removed or renamed in My eBay Messages.

A user can have up to 10 custom folders in My eBay Messages, and it is possible to add, remove, or rename up to 10 custom folders with one ReviseMyMessagesFolders call
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:ReviseMyMessagesFoldersRequestType
XML Source (w/o annotations (4); see within schema source)
<xs:complexType name="ReviseMyMessagesFoldersRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element minOccurs="0" name="Operation" type="ns:MyMessagesFolderOperationCodeType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="FolderID" type="xs:long"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="FolderName" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 3/14)
ns:FolderID
Type:
xs:long, predefined, simple content
The eBay-generated unique identifier for a custom folder in My eBay Messages. The FolderID value is required for the 'Rename' and 'Remove' operations, but not for the 'Display' (add) operation. FolderID values can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or the FolderID value for a My eBay Messages folder can be seen at the end of the browser's URL field when you navigate to that folder in My eBay Messages.

Note: If multiple folders will be renamed with one call, the user must pay close attention to the order of the FolderID and FolderName fields, as eBay will process these requests in order according to the placement of the the FolderID and FolderName fields. So, the existing folder identified by the first FolderID field in the request payload will get renamed to the folder name passed into the first FolderName field in the request payload, and so on.
XML Representation Summary
<ns:FolderID>
   
Content: 
{ xs:long }
</ns:FolderID>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="FolderID" type="xs:long"/>

ns:FolderName
Type:
xs:string, predefined, simple content
The user-specified name of the My eBay Messages folder. The FolderName value is required for the 'Display' (add) and 'Rename' operations, but not for the 'Remove' operation. In a 'Display' (add) operation, the name passed into the FolderName field is the name of the new folder. In a 'Rename' operation, the name passed into the FolderName field will be the new name of the existing folder that is specified through the corresponding FolderID field.

FolderName values can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or the FolderName value for a My eBay Messages folder can be seen when you navigate to My eBay Messages.

Note: If multiple folders will be renamed with one call, the user must pay close attention to the order of the FolderID and FolderName fields, as eBay will process these requests in order according to the placement of the the FolderID and FolderName fields. So, the existing folder identified by the first FolderID field in the request payload will get renamed to the folder name passed into the first FolderName field in the request payload, and so on.
XML Representation Summary
<ns:FolderName>
   
Content: 
{ xs:string }
</ns:FolderName>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="FolderName" type="xs:string"/>

ns:Operation
Type:
This required field is used to indicate the type of operation to perform (add, remove, or rename a folder). See the enumeration descriptions below for more information on the usage, requirements, and limitations on each operation.
XML Representation Summary
<ns:Operation>
   
Content: 
{ enumeration of xs:token }
</ns:Operation>
Simple Content
Enumeration:
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Operation" type="ns:MyMessagesFolderOperationCodeType"/>

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