Batch Inquire (Status Check)

From $1

    Table of contents
    1. 1. Method
    2. 2. Results
    Doc-Wiki-BannerHK.png

    (Click the banner to go to the related Docs.Code.ExactTarget.com page.)

    The Batch Inquire (Status Check) call requests an update on the status of a batch file export (bulk async) request. This call uses a batchID input, and it returns a status message and the name of the file found on your secure FTP site. The batch API returns the batchID when you make any batch file export call.

    Method

    To request an update on the status of a batch file export request, use the following syntax:

    <system>
        <system_name>batch</system_name>
        <action>inquire</action>
        <search_type>batchid</search_type>
        <search_value>119792</search_value>
    </system>

    The <search_value> XML tag represents the batchID of the request, received when you make the initial call for the status check request.

    Results

    The successful completion of this script will return a status message and filename.

    <?xml version="1.0"?>
        <exacttarget>
            <system>
                <Batch>
                    <batchid>979804</batchid>
                    <status>Complete</status>
                    <filename>bulkasync_68652290_20051005141044465_1.zip</filename>
                </Batch>
            </system>
        </exacttarget>

    Four possible statuses can be returned:

    1. Scheduled: The request to process your export request has been received and is waiting in the queue.

    2. Processing: The export is underway.

    3. Complete: The export is done. See Output for a Batch File Export (Bulk Async) Call for instructions on retrieving the export file.

    4. Error: An error has occurred. Contact ExactTarget Support for assistance.

    If an error occurs at the time that the XML command is submitted, the error code will be returned in XML format for the appropriate error trapping routine to be implemented.


    This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:25:44 GMT.

    If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:

     


    Was This Page Helpful?
    Suggestions or Comments:
    Name (optional):
    Email Address (optional):
    Enter 9635 backwards:
       
    Tags: (Edit tags)
    • No tags
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch 2010
    Admin