launchDataSync

Launch a DataSync operation given an operation ID.

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=launchDataSync & 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 ] & operation_id =value

Usage Notes

Runs a DataSync operation based on the given operation_id. Returns a task_id for the operation's exchange task. The return value task_id can then be used to check the status of the launched DataSync operation by querying getDataSyncStatus.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

operation_id

Required. Operation ID

Type xsd:int.

Response

See topic HTTP Status Codes.

XML response 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<launchDataSyncResponse xmlns="http://convio.com/crm/v1.0">
    <taskId>
        <id>12345</id>
    </taskId>
</launchDataSyncResponse>
JSON response 
{"launchDataSyncResponse":{"taskId":{"id":"12345"}}}
Parent topic: DataSync Cross-Reference API
Previous topic: removeXref
Next topic: getDataSyncStatus

Leave a Comment

Nickname
Comment
Enter this word:
Change