GetIncrementalDeletes

Returns all records of a particular type that were removed from the partition during the active synchronization period.

Usage

Use this operation to retrieve constituents that were inactivated in Luminate Online.

Note that a record may be removed from the partition without actually being deleted. This may happen if the constituent associated with the record no longer meets the criteria for belonging to the partition. For example, if a partition is limited to constituents with a mailing address, and a constituent updates her profile and deletes a previously entered mailing address, then her constituent record is removed from the partition, even though her record is still active.

When a constituent record is removed, associated financial transactions are implicitly removed from the partition as well, but they are not included in this operation. Only transactions that are explicitly deleted are removed.

Request Parameters

PartionId: Type nonNegativeInteger.
The system-generated unique identifier of a constituent partition.; A value is required.
RecordType: Type string.
The name of the record type for which information is requested.; A value is required.
Page: Type positiveInteger.
The index of the page of results to retrieve.; A value is required.
PageSize: Type positiveInteger.
The number of records to return per page.; A value is required.
Field: Type string.
The field or fields to return in the result set.; Multiple values allowed.; A value is required.

Response Parameters

The response may contain zero or more response elements.

Record: Record
A constituent record containing at least ConsId, MemberId, and PrimaryEmail for identification purposes.; Multiple values allowed.

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>
            c586ef5b6bb5409f0d8df56dd3645a36e1770631:JSESSIONID=213D6B11B7D068681890EAB3C6B4DB51:1001002:1:2021-11-16T13:50:51.961Z
         </SessionId>
      </Session>
   </soap:Header>
   <soap:Body>
      <Delete xmlns="urn:soap.convio.com">
         <Constituent>
            <ConsId>1001073</ConsId>
         </Constituent>
      </Delete>
   </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>
      <DeleteResponse xmlns="urn:soap.convio.com" xmlns:ens="urn:object.soap.convio.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <Result>
            <ResultCode>OK</ResultCode>
            <Message>User deleted.</Message>
            <Record xsi:type="ens:Constituent">
               <ens:ConsId>1001073</ens:ConsId>
               <ens:MemberId xsi:nil="true">
               <ens:PrimaryEmail>test.delete+devnull@convio.com</ens:PrimaryEmail>
            </ens:MemberId></Record>
         </Result>
      </DeleteResponse>
   </soap:Body>
</soap:Envelope>

Related references