Usage

Downloads records of a particular type that were updated during the active synchronization period.

The result set only includes records that were part of the specified partition during the synchronization period. Records that were both added and subsequently updated during the synchronization period are treated as "inserts" and may be downloaded via the GetIncrementalInsertss operation. Records that were removed during the synchronization period are treated as "deletes" even if they were previously added and/or updated within the same period. Deletes may be downloaded via the GetIncrementalDeletes operation.

Request Parameters

PartitionId

nonNegativeInteger

A value is required

The system-generated unique identifier of a constituent partition

RecordType

string

A value is required

The name of a synchronizable record type.

Page

positiveInteger

A value is required

The index of the page of results to retrieve.

PageSize

positiveInteger

A value is required

The number of records to return per page

Field

string

A value is required

Multiple values allowed

The names of one or more fields to include in the response

Response Parameters

The response may contain zero or more response elements

Record

Record

Multiple values allowed

A constituent record containing at least ConsId, MemberId and PrimaryEmail for identification purposes.

Faults

• ServiceUnavailableFault
• ServerFault
• MalformedMessageFault
• InvalidMessageFault
• SessionFault

Example SOAP request

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <ns3:Session xmlns:ns3="urn:soap.convio.com" soapenv:mustUnderstand="0">
      <ns3:SessionId>3868cf8ebb49e046a024e18ad8420ea931fe8b64:JSESSIONID=abc_g9cmWx9L0_dZyWZ3r:10000101:2008-12-01T18:13:47.722Z</ns3:SessionId>
    </ns3:Session>
  </soapenv:Header>
  <soapenv:Body>
    <ns3:GetIncrementalUpdates xmlns:ns3="urn:soap.convio.com">
      <ns3:PartitionId>123</ns3:PartitionId>
      <ns3:RecordType>Constituent</ns3:RecordType>
      <ns3:Page>1</ns3:Page>
      <ns3:PageSize>3</ns3:PageSize>
      <ns3:Field>ConsId</ns3:Field>
      <ns3:Field>ConsName</ns3:Field>
      <ns3:Field>UserName</ns3:Field>
      <ns3:Field>PrimaryEmail</ns3:Field>
      <ns3:Field>HomeAddress</ns3:Field>
    </ns3:GetIncrementalUpdates>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP response

<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetIncrementalUpdatesResponse xmlns="urn:soap.convio.com"
    xmlns:ens="urn:object.soap.convio.com"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <Record xsi:type="ens:Constituent">
        <ens:ConsId>1001483</ens:ConsId>
        <ens:ConsName>
          <ens:FirstName>Harry</ens:FirstName>
          <ens:LastName>Potter</ens:LastName>
        </ens:ConsName>
        <ens:UserName>potter</ens:UserName>
        <ens:PrimaryEmail>potter@leakycauldron.com</ens:PrimaryEmail>
        <ens:HomeAddress>
          <ens:Street1>4 Privet Drive</ens:Street1>
          <ens:City>Little Whinging</ens:City>
          <ens:State>CA</ens:State>
          <ens:Zip>94705</ens:Zip>
          <ens:Country>USA</ens:Country>
        </ens:HomeAddress>
      </Record>
    </GetIncrementalUpdatesResponse>
  </soap:Body>
</soap:Envelope>