StartSynchronization

Starts a synchronization session

Usage

Initiates a synchronization between Luminate Online and a remote system.

Allows the caller to specify an optional time period for the synchronization. If a start time is not specified, the system defaults to the start time of the last successful synchronization. If an end time is not specified, the system defaults to the current time.

Requires a partition ID that specifies which set of constituents to synchronize. Partitions are managed through the Luminate Online administration interface. You can use the Query operation to retrieve a list of available partition IDs:

				select PartitionId, Name from Partition

Synchronizations are associated with both a partition ID and the currently authenticated user. Each user can only have one active synchronization per partition at a time.

Returns a SyncId that uniquely identifies this synchronization for auditing purposes. This ID can be used to retrieve an audit log of the synchronization for up to 90 days after it occurs (See GetSynchronizationRequestLog).

Throws a SynchronizationFault if there is an existing active synchronization for the same user and partition that has not been explicitly ended by a call to the EndSynchronization operation. There are three possible reasons for this:

Another sync session is currently in progress.
The client is not performing the expected sequence of operations by calling EndSynchronization at the end of each sync session
An error happened during the last sync session that prevents the client from ending the session successfully.

To force the system to start a new session even if a previous session is already active, set the Forceparameter totrue. In this case the last active synchronization will be left open for auditing purposes. Note that it is not advisable to use the Force parameter unless you have determined why the active sync already exists.

Request Parameters

PartitionId: nonNegativeInteger; A value is required; The system-generated unique identifier of a constituent partition
Force: boolean; Specifytrueto override synchronization collisions. Default is false.
Start: dateTime; The start time for the current synchronization window
End: dateTime; The end time for the current synchronization window

Response Parameters

PartitionId: nonNegativeInteger; A value is required; The system-generated unique identifier of a constituent partition
Start: dateTime; A value is required; The start time for the current synchronization window
End: dateTime; A value is required; The end time for the current synchronization window
SyncId: nonNegativeInteger; A value is required; The system-generated unique identifier for the synchronization session

Faults

Example SOAP request

<?xml version='1.0' encoding='UTF-8' ?>
<soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'>
  <soap:Header>
    <Session xmlns='urn:soap.convio.com'>
      <SessionId>9b35f8351f300a7c11a5ce232c9ce82ed6240aa1:JSESSIONID=abc0IZk5Fzfq8gdboKT4r:10000100:2008-12-12T23:38:36.362Z</SessionId>
    </Session>
  </soap:Header>
  <soap:Body>
    <StartSynchronization xmlns='urn:soap.convio.com'>
      <PartitionId>10000103</PartitionId>
      <Start>2008-12-11T00:00:00+0000</Start>
      <End>2008-12-12T00:00:00+0000</End>
    </StartSynchronization>
  </soap:Body>
</soap:Envelope>

Example SOAP response

<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <StartSynchronizationResponse xmlns="urn:soap.convio.com">
      <Result>
        <PartitionId>10000103</PartitionId>
        <Start>2008-12-11T00:00:00Z</Start>
        <End>2008-12-12T00:00:00Z</End>
        <SyncId>183</SyncId>
      </Result>
    </StartSynchronizationResponse>
  </soap:Body>
</soap:Envelope>

Related reference

StartSynchronization operation

SynchronizationFault

Luminate Online