V200611

Click here for a complete list of operations.

Retrieve

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/V200611.ASMX HTTP/1.1
Host: api.cvent.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.cvent.com/2006-11/Retrieve"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap:Header>
  <soap:Body>
    <Retrieve xmlns="http://api.cvent.com/2006-11">
      <ObjectType>Contact or Event or Invitee or Registration or Respondent or Response or Survey or Transaction or Travel or ContactGroup or EventEmailHistory or Budget or BudgetItem or User or UserGroup or UserRole or MeetingRequestUser or MeetingRequest or RFP or Proposal or SupplierRFP or SupplierProposal or RateHistory or EventQuestion or SurveyEmailHistory or Supplier or EventDetail or Guest or Campaign or DistributionList or EMarketingEmailHistory or Approver or SurveyQuestion or Appointment or AppointmentAttendee or Speaker or TableAssignment or ConversionRate or EventCards or Session or EntityCustomField or AdvancedLogic</ObjectType>
      <Ids xmlns="http://schemas.cvent.com/api/2006-11">
        <Id>string</Id>
        <Id>string</Id>
      </Ids>
    </Retrieve>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap:Header>
  <soap:Body>
    <RetrieveResponse xmlns="http://api.cvent.com/2006-11">
      <RetrieveResult xmlns="http://schemas.cvent.com/api/2006-11">
        <CvObject Id="string" MessageId="string" TransactionID="string" />
        <CvObject Id="string" MessageId="string" TransactionID="string" />
      </RetrieveResult>
    </RetrieveResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/V200611.ASMX HTTP/1.1
Host: api.cvent.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap12:Header>
  <soap12:Body>
    <Retrieve xmlns="http://api.cvent.com/2006-11">
      <ObjectType>Contact or Event or Invitee or Registration or Respondent or Response or Survey or Transaction or Travel or ContactGroup or EventEmailHistory or Budget or BudgetItem or User or UserGroup or UserRole or MeetingRequestUser or MeetingRequest or RFP or Proposal or SupplierRFP or SupplierProposal or RateHistory or EventQuestion or SurveyEmailHistory or Supplier or EventDetail or Guest or Campaign or DistributionList or EMarketingEmailHistory or Approver or SurveyQuestion or Appointment or AppointmentAttendee or Speaker or TableAssignment or ConversionRate or EventCards or Session or EntityCustomField or AdvancedLogic</ObjectType>
      <Ids xmlns="http://schemas.cvent.com/api/2006-11">
        <Id>string</Id>
        <Id>string</Id>
      </Ids>
    </Retrieve>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap12:Header>
  <soap12:Body>
    <RetrieveResponse xmlns="http://api.cvent.com/2006-11">
      <RetrieveResult xmlns="http://schemas.cvent.com/api/2006-11">
        <CvObject Id="string" MessageId="string" TransactionID="string" />
        <CvObject Id="string" MessageId="string" TransactionID="string" />
      </RetrieveResult>
    </RetrieveResponse>
  </soap12:Body>
</soap12:Envelope>