Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

getBackgroundTaskStatus


The getBackgroundTaskStatus() method returns status information about a background task that was started with one of the <MethodName>Background() methods. The information returned includes the current status of the task (running, completed, or failed); the starting timestamp of the task; the ending timestamp (if any) of the task, and the percent complete (in cases where this information is available).
Once a task has a status of ‘completed’ (or ‘failed’) the corresponding fetch<MethodName>BackgroundResult() method can be called to retrieve the result (or fault) of the method call, respectively. The return value of the fetch<MethodName>BackgroundResult will be the datatype that is documented for the <MethodName> function.

Input

[vrtypens:getBackgroundTaskStatusArgs]

session_id [xsd:string] (required)
Your API session id.
background_task_id [xsd:int]

Examples

Perl

$vrapi->getBackgroundTaskStatus( {
    session_id => $sid,
    background_task_id => $bg_id
} );

PHP

$vrapi->getBackgroundTaskStatus( array(
    'session_id' => $sid,
    'background_task_id'  => $bg_id
) );

Ruby

vr.getBackgroundTaskStatus({
    'session_id' => sid,
    'background_task_id'  => bg_id,
})

C#.NET

getBackgroundTaskStatusArgs objGetBGStatus = new getBackgroundTaskStatusArgs();
objGetBGStatus.session_id = _sSessionId;
objGetBGStatus.background_task_id = iBackgroundTaskId;

BackgroundTaskStatus objTaskStatus = objVR.getBackgroundTaskStatus(objGetBGStatus);