getDataSyncStatus

Returns the status of a DataSync operation

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
None. SRDataSyncAPI GET, POST Yes.

Server API Syntax

https://secure2.convio.net/organization/site/SRDataSyncAPI?method=getDataSyncStatus & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & task_id =value

Usage Notes

Returns the task status ( 'queued' | 'running' | 'success' | 'failure' | 'stale' ) for the given task_id. When the task status is 'stale', a detailMessage is included to give more information about the task state. This method should be used with launchDataSync.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

task_id

Required. Task ID

Type xsd:int.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<getDataSyncStatusResponse xmlns="http://convio.com/crm/v1.0">
    <taskStatus>
        <status>queued</status>
        <detailMessage>detailed message if applicable...</detailMessage>
    </taskStatus>
</getDataSyncStatusResponse>


        
JSON response
{"getDataSyncStatusResponse":{"taskStatus":{"detailMessage":"detailed message if applicable...","status":"queued"}}}

        

Leave a Comment

Nickname
Comment
Enter this word: