Luminate Online

Usage

This operation is a specific type of Query for easily locating one or more records by Id (primary key).

Specify the RecordType to return.

Specify one or more Id values. Requesting multiple Id values will return one record for each valid value.

Specify one or more fields to return for each record in Field elements.

Request Parameters

RecordType: string; A value is required; The name of a synchronizable record type.
Field: string; A value is required; Multiple values allowed; The field or fields to return in the result set
Id: nonNegativeInteger; A value is required; Multiple values allowed; One or more instances of IDs (primary key values) for the requested record type

Response Parameters

The response may contain zero or more response elements

Record: Record; Multiple values allowed; The record or records returned by the query

Faults

Example SOAP request


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:urn="urn:soap.convio.com">
  <soapenv:Header>
    <urn:Session>
      <urn:SessionId>
      eb00584da96a24e3d78d70e70fb19b0b0c688851:JServSessionIdr005=1bzmoymcx1.app8007:1001021:318:2010-03-09T20:53:55.538Z
      </urn:SessionId>
    </urn:Session>
  </soapenv:Header>
  <soapenv:Body>
    <urn:Find>
      <urn:RecordType>Constituent</urn:RecordType>
      <urn:Id>1001081</urn:Id>
      <urn:Field>ConsName</urn:Field>
      <urn:Field>PrimaryEmail</urn:Field>
      <urn:Field>HomeAddress</urn:Field>
    </urn:Find>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP response


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <FindResponse 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:ConsName>
               <ens:FirstName>Jim</ens:FirstName>
               <ens:LastName>CenterOne</ens:LastName>
            </ens:ConsName>
            <ens:PrimaryEmail>devnull+c1@convio.com</ens:PrimaryEmail>
            <ens:HomeAddress>
               <ens:Street1 xsi:nil="true"/>
               <ens:Street2 xsi:nil="true"/>
               <ens:City xsi:nil="true"/>
               <ens:State xsi:nil="true"/>
               <ens:Zip xsi:nil="true"/>
            </ens:HomeAddress>
         </Record>
      </FindResponse>
   </soap:Body>
</soap:Envelope>