Usage Notes

Given an application, this method returns the xref types assigned to that application.

Given an xref type ID, a list of name/value pairs of Luminate Online objects to which that xref type may apply can be generated using the listComObjectsForXrefType method.

The same can be done for foreign objects given xref type id and field number using the listForeignObjectsForXrefField method.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

application

Optional. COM application

Type crm:comApplication.

Options are:

• donation_classic
• donation_campaign
• donation_form
• teamraiser_campaign
• ticketed_event
• pf_campaign
• action_alert
• email_campaign
• designated_gift
• e_commerce_store
• event_ticket_class
• event_rsvp
• interest
• membership_type

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<listXrefTypesResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <xrefType>
    <id>100</id>
    <name>Sample XRef Type</name>
    <description>A sample xref type.</description>
    <xrefField>
      <number>0</number>
      <name>Sample field name</name>
      <required>false</required>
    </xrefField>
  </xrefType>
</listXrefTypesResponse>

        

{"listXrefTypesResponse":{"xrefType":{"id":"100","xrefField":{"name":"Sample field name","number":"0","required":"false"},"description":"A sample xref type.","name":"Sample XRef Type"}}}