Luminate Online

Usage

This operation provides extended metadata about a Record type defined in the Luminate Online WSDL.

The SupportedOperations elements list the operations supported for the specified record type. For example, the Constituent record type supports synchronization in both directions as well as query; the Donation record type supports only "download" synchronization from Luminate Online to remote systems as well as query; and the DonationCampaign record type supports only query.

The Field elements provide information about the type's fields. Field properties may include:

Element	Description
Name	The name of the field
Writable	Whether or not the field may be modified on Create or Update operations
Custom	Whether or not the field name is an alias for a custom field in the Luminate Online database
Nillable	Whether or not the field value may be Null
Multiple	Whether or not the field may return multiple instances
Type	The field's data type (may be either a simple type or another CWS schema type)
MaxLength	The maximum number of characters supported for text fields (longer values will be truncated)
IsCriterion	Not used (Deprecated)
IsWildcard	Whether or not the field is returned to a query that does not specifically request it when the parent type is requested
Option	One of a list of valid values for an enumeration type

Request Parameters

RecordType: normalizedString; A value is required; The name of the record type for which information is requested
ParentType: normalizedString; The name of the record's parent type, if the record type is a sub-type
ParentField: normalizedString; The field name of the type in the parent record

Response Parameters

Name: string; The name of the requested record type
SupportedOperations: SupportedOperations; The list of operations supported for the record type
Field: Field; Multiple values allowed; The names of one or more fields to include in the response

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>
    <DescribeRecordType xmlns='urn:soap.convio.com'>
      <RecordType>Constituent</RecordType>
    </DescribeRecordType>
  </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>
    <DescribeRecordTypeResponse xmlns="urn:soap.convio.com">
      <Result>
        <Name>Constituent</Name>
        <SupportedOperations>
          <Create>true</Create>
          <Update>true</Update>
          <Delete>true</Delete>
          <GetIncrementalInserts>true</GetIncrementalInserts>
          <GetIncrementalUpdates>true</GetIncrementalUpdates>
          <GetIncrementalDeletes>true</GetIncrementalDeletes>
          <Query>true</Query>
        </SupportedOperations>
        <Field>
          <Name>ConsId</Name>
          <Writable>false</Writable>
          <Custom>false</Custom>
          <Nillable>true</Nillable>
          <Multiple>false</Multiple>
          <Type>nonNegativeInteger</Type>
          <IsCriterion>true</IsCriterion>
        </Field>
        <Field>
          <Name>SiteId</Name>
          <Writable>false</Writable>
          <Custom>false</Custom>
          <Nillable>true</Nillable>
          <Multiple>false</Multiple>
          <Type>nonNegativeInteger</Type>
          <IsCriterion>false</IsCriterion>
        </Field>
        <Field>

		       . . .
	  
      </Result>
    </DescribeRecordTypeResponse>
  </soap:Body>
</soap:Envelope>

DescribeRecordType