BatchExecute

Welcome, guest Sign In

My Projects
Tools & Services
APIs and Services
- Flickr
- Geo
- Mail
- Search
- Social
- Updates
- YAP
- YQL
Developer Tools
- Hadoop
- YUI
- YSlow
- View all »
Resources
- Blog
- YDN Theater
- Hack U

YDN BatchExecute

Prev — Chapter 3. Methods

CreateFolder — Next

BatchExecute

BatchExecute calls a series of specified API methods to be processed consecutively. Batch calls can be dependency chained using the BatchCall id and dependency tags. Source and destination data for the call to use can be specified by the BatchCall parameter tag.

Available to both premium and non-premium users.

Parameters

Name	Description
call	BatchCall. API methods to call.

Returns

Name	Description
response	BatchResponse

Examples

Request

Sample Request batch that calls FetchExternalMail and ListFolders.

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Body>
    <BatchExecuteResponse>
      <response>
        <FetchExternalMailResponse>
          <fetchResults>
            <status/>
            <numFetched>0</numFetched>
          </fetchResults>
        </FetchExternalMailResponse>
      </response>
      <response>
        <ListFoldersResponse>
          <numberOfFolders>6</numberOfFolders>
          <folder unread="1" total="35" size="223097" isSystem="true">
            <folderInfo fid="%40B%40Bulk" name="@B@Bulk"/>
          </folder>
          <folder unread="1" total="1" size="937" isSystem="true">
            <folderInfo fid="Draft" name="Draft"/>
          </folder>
          <folder unread="543" total="589" size="11322299" isSystem="true">
            <folderInfo fid="Inbox" name="Inbox"/>
          </folder>
          <folder unread="0" total="1" size="2521" isSystem="true">
            <folderInfo fid="Sent" name="Sent"/>
          </folder>
          <folder unread="0" total="0" size="0" isSystem="true">
            <folderInfo fid="Trash" name="Trash"/>
          </folder>
          <folder unread="0" total="0" size="0" isSystem="false">
            <folderInfo fid="test" name="test"/>
          </folder>
        </ListFoldersResponse>
      </response>
    </BatchExecuteResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelopee>

BatchExecute

Parameters

Returns

Examples

Request

Sample Response

Table of Contents