Cvent web services api guide by Saad Ahmed Khan

Cvent Web Services API January 2015 Version V200611

Cvent, Inc. 1765 Greensboro Station Place, 7th Floor Tysons Corner, VA 22102 866.318.4357 www.cvent.com

Cvent Web Services API Version V200611 January 2015

Table of Contents 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.7.1 2.0 2.1 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.1.6 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8 2.2.9 2.2.10 2.2.11 2.2.12 2.2.13 2.2.14 2.3 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5 2.3.6 2.3.7 2.3.8 2.3.9 2.4 2.4.1 2.4.2 2.4.3 2.4.4 2.4.5 2.4.6 2.4.7 2.4.8 2.4.9 2.4.10 2.4.11 2.4.12 2.4.13 2.5 2.5.1

Framework Overview .......................................................................................................... 10 Overview ............................................................................................................................. 10 Compatible Development Platforms .................................................................................... 10 Supported Operations ......................................................................................................... 10 Available Objects ................................................................................................................ 10 Supported Editions .............................................................................................................. 11 Location............................................................................................................................... 11 Notes ................................................................................................................................... 11 Transaction Limitations .................................................................................................. 11 Call Definitions .................................................................................................................... 12 Overview ............................................................................................................................. 12 Login .............................................................................................................................. 13 Search ........................................................................................................................... 14 Retrieve ......................................................................................................................... 15 GetUpdated ................................................................................................................... 16 DescribeGlobal .............................................................................................................. 17 DescribeCvObject .......................................................................................................... 18 Administration ..................................................................................................................... 19 CreateUser .................................................................................................................... 19 UpdateUser ................................................................................................................... 21 DeleteUser..................................................................................................................... 22 CreateApprover ............................................................................................................. 23 DeleteApprover .............................................................................................................. 24 UpdateApprover ............................................................................................................ 25 CreateRateHistory ......................................................................................................... 26 DeleteRateHistory ......................................................................................................... 27 ManageUserGroup ........................................................................................................ 28 CreateConversionRate .................................................................................................. 30 DeleteConversionRate................................................................................................... 31 CreateCustomField Call................................................................................................. 32 UpdateCustomField Call ................................................................................................ 33 AddAdvancedLogic Call................................................................................................. 34 Contacts .............................................................................................................................. 35 CreateContact ............................................................................................................... 35 UpdateContact ............................................................................................................... 37 UpsertContact ................................................................................................................ 39 DeleteContact ................................................................................................................ 40 CreateContactGroup...................................................................................................... 41 ManageContactGroupMembers .................................................................................... 43 TransferInvitee ............................................................................................................... 45 ValidateInvitee ............................................................................................................... 46 SendEmail ..................................................................................................................... 47 Events ................................................................................................................................. 49 UpdateInviteeInternalInfo............................................................................................... 49 CreatePostEventFeedback ............................................................................................ 51 SimpleEventRegistration ............................................................................................... 53 SessionRegAction ......................................................................................................... 55 CheckIn ......................................................................................................................... 56 CreateNoRegEvent........................................................................................................ 57 CopyEvent ..................................................................................................................... 58 UpdateEventParameters ............................................................................................... 59 CreateSession ............................................................................................................... 60 UpdateSession .............................................................................................................. 61 CreateTransaction ......................................................................................................... 62 CreateBudgetItem ......................................................................................................... 63 DeleteBudgetItem .......................................................................................................... 64 Meeting Request Forms ...................................................................................................... 65 CreateMeetingRequest .................................................................................................. 65

Page 2 of 155

Cvent Web Services API Version V200611 January 2015

2.5.2 2.6 2.6.1 2.7 2.7.1 2.8 2.8.1 2.8.2 3.0 3.1 3.1.1 3.1.2 3.2 3.2.1 3.2.2 3.3 3.3.1 3.3.2 3.3.3 3.3.4 3.3.5 3.3.6 3.3.7 3.3.8 3.3.9 3.4 3.4.1 3.4.2 3.4.3 3.4.4 3.4.5 3.4.6 3.4.7 3.4.8 3.4.9 3.4.10 3.4.11 3.4.12 3.4.13 3.4.14 3.4.15 3.4.16 3.5 3.5.1 3.5.2 3.5.3 3.5.4 3.5.5 3.6 3.6.1 3.6.2 3.6.3 3.7 3.7.1 3.7.2 3.7.3 3.8 3.8.1 3.8.2 3.8.3 3.8.4

UpdateMeetingRequest ................................................................................................. 67 Survey ................................................................................................................................. 69 CreateSurveyAnswer ..................................................................................................... 69 Supplier Network ................................................................................................................. 71 CreateRFP..................................................................................................................... 71 eMarketing .......................................................................................................................... 72 CreateDistributionList .................................................................................................... 72 ManageDistributionListMembers ................................................................................... 73 Object Definitions ................................................................................................................ 74 Overview ............................................................................................................................. 74 API Core Objects ........................................................................................................... 74 Cvent Objects ................................................................................................................ 74 Contact Objects................................................................................................................... 76 Contact .......................................................................................................................... 76 ContactGroup ................................................................................................................ 78 Administration Objects ........................................................................................................ 79 User ............................................................................................................................... 79 MeetingRequestUser ..................................................................................................... 81 Approver ........................................................................................................................ 82 UserGroup ..................................................................................................................... 82 UserRole........................................................................................................................ 82 MeetingRequest ............................................................................................................ 83 ConversionRate ............................................................................................................. 86 CustomField Object ....................................................................................................... 87 AdvancedLogic .............................................................................................................. 87 Event ................................................................................................................................... 88 Event ............................................................................................................................. 88 EventParameters ........................................................................................................... 91 EventDetails .................................................................................................................. 93 Invitee ............................................................................................................................ 95 Registration ................................................................................................................... 96 Guest ............................................................................................................................. 99 EventEmailHistory ....................................................................................................... 100 Transaction .................................................................................................................. 100 Travel........................................................................................................................... 102 Budget ......................................................................................................................... 106 BudgetItem .................................................................................................................. 107 EventQuestion ............................................................................................................. 109 Appointment ................................................................................................................ 109 AppointmentAttendee .................................................................................................. 110 Speaker ....................................................................................................................... 110 TableAssignment ......................................................................................................... 111 Survey Objects .................................................................................................................. 112 Survey ......................................................................................................................... 112 Respondent ................................................................................................................. 113 Response .................................................................................................................... 114 SurveyEmailHistory ..................................................................................................... 115 SurveyQuestion ........................................................................................................... 116 eMarketing Objects ........................................................................................................... 117 Campaign .................................................................................................................... 117 Distribution List ............................................................................................................ 118 EMarketingEmailHistory .............................................................................................. 118 RFP Objects ...................................................................................................................... 119 RFP ............................................................................................................................. 119 Proposal ...................................................................................................................... 124 Supplier ....................................................................................................................... 130 Supplier Objects ................................................................................................................ 131 SupplierRFP ................................................................................................................ 131 SupplierProposal ......................................................................................................... 136 RFPParameters ........................................................................................................... 140 RateHistory .................................................................................................................. 141

Page 3 of 155

Cvent Web Services API Version V200611 January 2015

4.0 4.1 4.2 5.0 6.0

API Management .............................................................................................................. 142 Daily Call Graphs .............................................................................................................. 143 API User ............................................................................................................................ 143 Appendix A – Error Codes................................................................................................. 144 Appendix B – Sample Code .............................................................................................. 151

Page 4 of 155

Cvent Web Services API Version V200611 January 2015

What’s New The following items have been added to or updated in this document.

January 2015 

Added new objects – SessionDetail, CustomField, AdvancedLogic



Added new calls – UpdateEventParameters, CreateSession, UpdateSession, CreateCustomField, UpdateCustomField, AddAdvancedLogic, CreateMeetingRequest, UpdateMeetingRequest



Updated Invitee Object object – added VoucherCode



Updated EventParameter Object – added Language, Category, InternalNote, PublishDate, ArchiveDate, PlannerPrefix, PlannerCompany, PlannerTitle, StakeholderFirstName, StakeholderLastName, StakeholderEmailAddress, StakeholderTitle, StakeholderCompany, StakeholderWorkPhone, StakeholderHomePhone, StakeholderWorkFax, StakeholderMobilePhone, StakeholderAddress1, StakeholderAddress2, StakeholderAddress3, StakeholderCity, StakeholderState, StakeholderStateCode, StakeholderPostalCode, StakeholderCountry, StakeholderCountryCode



Updated Travel Object – added PlannerMemo, EarliestShoulderDate, LatestShoulderDate, HotelRoomRate, RoomTaxBillingExceptions, IncidentalBillingExceptions, HotelAddress1, HotelAddress2, HotelAddress3, HotelCity, HotelState, HotelPostalCode, HotelCountry

October 2014 

Updated BudgetItem object – added AssociatedRegistrants sub-array

November 2013 

Updated RFP object – added CityWideFlag, AcceptRebates, Rebate, RebateType o Added AlternateDates sub-array o Updated MeetingRoomDetail sub-array – added LocatedAtHostHotelOrConventionCenter, EndDate, DayNumber, CityWideFlag



Updated SupplierRFP object – added CityWideFlag, AcceptRebates, Rebate, RebateType o Added AlternateDates sub-array o Updated MeetingRoomDetail sub-array – added LocatedAtHostHotelOrConventionCenter,



Updated Proposal object o Added ConventionCenterInfo sub-array, EventSpace sub-array, AlternateSleepRoomAvailabilityDetails sub-array o Updated EventRequirementsInfo array – added RoomSizeUnitOfMeasure, CeilingHeightUnitOfMeasure



Updated SupplierProposal object – added IncludeRebates, Rebate, RebateType, RebatesIncentive, RoomRateConfirmed, ConfirmationContingencies, YearlyIncrease, RoomRateInfo, UnionInfo, ContractorInfo o Added EventSpace sub-array, AlternateSleepRoomAvailabilityDetails sub-array o Updated EventRequirementsInfo array – added RoomSizeUnitOfMeasure, CeilingHeightUnitOfMeasure



Updated Travel object o Updated HotelRequest sub-array – added ShareRoom, RoomateLeader, Gender, TotalAmount, CurrencyCode, RoomCharge, RoomTaxBillingInstructions, IncidentalBillingInstruction, LastModifiedBy, HotelLastModifiedDate o Updated CarRequest sub-array – added LastModifiedBy, CarLastModifiedDate o Updated AirRequest sub-array – added LastModifiedBy, AirRequestLastModifiedDate o Updated AirActual sub-array – added LastModifiedBy, AirActualLastModifiedDate



Updated Registration object – added ReferenceId

April 2013 

Added new objects – Speaker, TableAssignment, and ConversionRate

Page 5 of 155

Cvent Web Services API Version V200611 January 2015



Added new calls – CreatePostEventFeedback, CreateBudgetItem, DeleteBudgetItem, CreateConversionRate, and DeleteConversionRate



Updated Travel object – updated AirActual sub-array



Updated RFP object – added ReceivePackageRatesResponse, EmployeesRange, AverageAttendeesPerEventRange, AverageRoomNightsPerEventRange, TotalAttendeesPerYearRange, and TotalRoomNightsPerYearRange



Updated SupplierRFP object – added ReceivePackageRatesResponse, RFPRating, EmployeesRange, AverageAttendeesPerEventRange, AverageRoomNightsPerEventRange, TotalAttendeesPerYearRange, and TotalRoomNightsPerYearRange



Updated Supplier object – added ProfileCompleteness and ProposalDefaultCompleteness



Updated Response object – made Status searchable



Updated Proposal object – added ContractInfo sub-array



Updated Transaction object – added GLDescription



Updated EventDetails object – added GLDescription



Updated CheckIn call – added UndoCheckIn



Updated SimpleEventRegistration call – added AdmissionItemId

November 2013 

Updated TransferInvitee call – Added TargetedListId, Updated basic steps and general syntax



Added SessionRegAction call



Updated EventParameters object – Added PlannerEmailAddress, RSVPByDate



Updated Event object – Added TargetedListDetail array



Updated Survey object – Added TargetedListDetail array



Updated Invitee object – Added TargetedListId, TargetedListName



Updated Registration object – Added TargetedListId, TargetedListName



Updated Respondent object – Added TargetedListId, TargetedListName



Updated ContactGroup object – Added GroupType



Updated Travel object – Added RequesterSuffix to AirRequest array



Updated Proposal object – Added PackagePricing array



Updated SupplierProposal object – Added PackagePricing array



Added API Management section

June 2012 

Updated CreateSurveyAnswer call – Added QuestionIDs field to CvAnswers array, more available question types and formats



Organized all objects into separate categories – API Core, Contact, Administration, Event, Survey, eMarketing, RFP, Supplier



Added new objects – SurveyQuestion, Appointment, AppointmentAttendee



Updated CvObject – Added TransactionID



Updated Guest object – Added RegistrationID, Gender, DateOfBirth, SocialSecurityNumber, NationalIdentificationNumber, PassportNumber, PassportCountry,Status



Updated SupplierRFP object – CancelledDate, CancelReason, CancelReasonComments, LatestResponseDate



Updated SupplierProposal object – Moved ProposalEstimatedCostDetail and MeetingRoomAvailabilityDetail to EventRequirementsInfo array; Added CostAdditionalInformation



Updated RFP object – Added CancelReason, CancelReasonComments, LatestResponseDate



Updated Response object – Added QuestionNumber, TransactionID



Updated Respondent object – Added TransactionID

Page 6 of 155

Cvent Web Services API Version V200611 January 2015



Updated Event object – Added IsIncluded

January 2012 

Added new calls – ValidateInvitee, CreateDistributionList, ManageDistributionListMembers, CreateApprover, DeleteApprover, UpdateApprover



Added new objects – Campaign, DistributionList, EMarketingEmailHistory, Guest, Approver



Updated Contact object – Added Gender, DateofBirth, SocialSecurityNumber, NationalIdentificationNumber, PassportNumber, PassportCountry, PassportCountryCode, ActivityId, ParentContactId



Updated BudgetItem object – Added AllocationCategoryDetail and AllocationCategoryDetail sub-arrays.



Updated Travel object – Added AirRequest sub-array and RequesterId and RequesterType to CarRequest, HotelRequest, and AirActual sub-arrays.



Updated RFP and Supplier objects – Added StaffRoomQuantity



Updated Proposal and SupplierProposal objects – Added StaffRoomQuantity and StaffRoomRate



Updated RFP object – Added CustomFieldDetail sub-array



Updated EventDetails – Added Fees sub-array



Updated Contact object – Added DistributionListDetail sub-array



Updated Registration object – Added RegistrationTypeCode to Registration sub-array, added RegistrationTypeCode and MiddleName to GuestDetail

July 2011 

Added new calls – CreateSurveyAnswer, UpsertContact, CopyEvent, CreateRFP



Added new objects – EventDetails, MeetingRequest, RFP Parameters



Updated Event object – Added ArchiveDate, ExternalAuthentication, MeetingRequestId fields



Updated Contact object – Added SMTPCode, JoinDate, ExpirationDate, LastRenewalDate, FacebookURL, TwitterURL, and LinkedInURL fields



Updated Budget object – Removed Currency field



Updated BudgetItem object – Added Currency, CurrencyCode, ConversionRate, and VendorType fields, added Currency and CurrencyCode in BudgetPaymentDetail subarray



Updated Respondent object – Added ReferenceId



Updated Response object – Added ReferenceId



Updated RFP object – Added MultiAwarded



Updated Proposal object – Added NotesRecommendation field, added FAndBMinimumNote to EventRequirementsInfo subarray



Updated SupplierProposal object – Added FAndBMinimumNote to EventRequirementsInfo subarray



Updated Invitee object – Made FirstName, LastName, Company, and SourceID searchable



Updated Registration object – Made FirstName, LastName, EmailAddress, Company, and SourceID searchable

February 2011 

Added New Objects – EventQuestion, SurveyEmailHistory, and Supplier



Updated Survey object – Added CustomFieldDetail subarray



Updated BudgetItem object – Updated Amount field



Updated Contact object – Updated FieldValue field



Updated Event object – Added currency, removed SurveyDetail array, and updated field value



Updated EventParameter object – Added CustomFieldDetail subarray



Updated DescribeCvObject – Added CustomField output



Updated Transaction Object – Added ability to insert offline payments



Updated CheckIn Call – Added AttendeeType input and Product ID input

Page 7 of 155

Cvent Web Services API Version V200611 January 2015



Updated Invitee object – Changed SurveyDetail subarray to RegretSurveyDetail subarray, added OriginalResponseDate field, added LastModifiedDate field, and EmailAddress is now searchable



Updated Registration object – Added OriginalResponseDate field, updated GuestConfirmationNumber note, and updated AnswerText note



Updated RFP object – Added Archived field, added VenueID field, added Commissionable, added Preferred field, and added CommissionRate



Updated SupplierRFP object – Added Archive field, added CommissionRate field and VenueID field



Updated SupplierProposal object – Added Commissionable and CommissionRate

July 2010 

Added new objects – SupplierRFP, SupplierProposal, and RateHistory



Added new calls – CreateRateHistory, DeleteRateHistory, and UpdateInviteeInternalInfo



Updated Event object – added DocumentDetail subarray, added RSVPbyDate, and ClosedBy fields



Updated RFP object – added UserVisibilityDetail and UserGroupVisibilityDetail sub-arrays, added QuickRFP and FlexibleDates fields



Updated Contact object – added LastOptOutBy field



Updated Invitee object – added ConfirmationNumber and ReferenceID fields



Updated Response object – added QuestionCode field



Updated Proposal object – added VenueCode field



Updated Budget object – added Currency field and default tax type fields



Updated BudgetItem object – added ItemDate field and tax type fields

January 2010 

Updated SendEmail call – added SendEmailRequest.EmailName; added ApprovalDenied, ApprovalPending, CustomEmail to list of valid email templates; added SurveyCustomEmail to list of valid survey templates



Updated CreateNoRegEvent call – added notes about event-parameter fields



Updated CvSearchObject definition – added indicator and note for ValueArray



Updated Contact object – added OptedIn field



Updated Event object – added Capacity, Category fields; added Status and Capacity to ProductDetail array



Updated Travel object – added FullName, DateOfBirth, Gender fields



Updated RFP object – added Date, FoodAndBeverageSpend, EventHistoryNote to EventHistoryDetail array



Updated Proposal object – added SleepRoomNote to SleepRoomAvailabilityDetail array; added RoomName, CeilingHeight to MeetingRoomAvailabilityDetail array



Other minor updates

August 2009 

Added new calls – CreateUser, UpdateUser, DeleteUser, ManageUserGroup, CreateNoRegEvent



Added new objects – RFP, Proposal, User, MeetingRequestUser, UserGroup, UserRole, EventParameters



Updated BudgetItem object – added RFPId



Updated Travel object – added SurveyDetail to HotelRequest, CarRequest, AirRequest sub-arrays; added CurrencyCode, GDSRecordLocator, and GDSNote fields to AirActual sub-array



Other minor updates

April 2009 

Updated API and call specific limits



Updated Search call – added note for maximum number of search filters



Updated Contact object – added FieldType field

Page 8 of 155

Cvent Web Services API Version V200611 January 2015



Updated Event object – updated EventStatus field, added PlanningStatus and FieldType fields, added FieldType field in CustomFieldDetail array, updated depreciation note



Updated Invitee object – added SurveyDetail array, added note for LastModifiedDate used in GetUpdated call



Updated Registration object – updated SurveyDetail to use new question and answer fields, added OrderDetail and OrderDetailId in OrderDetail array



Added Budget and BudgetItem objects



Updated Response object – updated SurveyDetail to use new question and answer fields, including fields for export values and scoring



Other minor updates

October 2008 

Updated SimpleEventRegistration call – updated note about admission items



Updated Event object – added last modified date field, added ProductId field in ProductDetail, added CustomFieldDetail array in Event and ProductDetail, and added note about ClassificationDetail array



Updated Invitee object – added InternalInfoDetail array



Updated Registration object – added invitee ID field, added question ID and code fields in SurveyDetail array in Registration and GuestDetail, and added order number and product ID fields in OrderDetail array



Added EventEmailHistory object



Updated Transaction object – added product ID and order number fields in DistributionDetail array



Other minor updates

June 2008 

Updated Registration object – added ConfirmationNumber field in GuestDetail

February 2008 

Added SendEmail call



Updated Registration object – added discount fields



Updated Transaction object – added modified by and last modified date fields



Added additional error codes (Appendix A)



Other minor updates

November 2007 

Added CreateContactGroup call



Added ManageContactGroupMembers call



Updated Contact object – added CCEmailAddress field



Added ContactGroup object



Updated Registration object – added Participant field in OrderDetail



Updated Respondent object – added RespondentScore field



Updated Response object – added QuestionScore field in SurveyDetail



Added additional error codes (Appendix A)



Added sample code (Appendix B)



Other minor updates

Page 9 of 155

Cvent Web Services API Version V200611 January 2015

1.0

Framework Overview 1.1

Overview

Cvent’s Web services Application Programming Interface (API) is a backend interface that allows clients to retrieve their Cvent data over the Internet. The client uses calls and objects defined within the API to pull their Cvent data into their own system and update data within the Cvent system. The API allows for these operations, but the client’s interface must be programmed to perform these operations. This document describes how to perform the various operations and provides the details for each of these operations.

1.2

Compatible Development Platforms

The Cvent Web services API is implemented to comply with SOAP 1.1 (Simple Object Access Protocol), WSDL 1.1 (Web Service Description Language), and WS-I Basic Profile v1.1 specifications. The Cvent Web services API works with modern SOAP development environment. For more information about these platforms, see the following Web sites:  SOAP 1.1 – http://www.w3.org/TR/2000/NOTE-SOAP-20000508  WSDL 1.1 – http://www.w3.org/TR/wsdl  WS-I Basic Profile v1.1 – http://www.ws-i.org/Profiles/BasicProfile-1.1.html

1.3

Supported Operations

Using a Web service-enabled development environment, clients can construct Web service client applications that use standard Web service protocols to perform the following operations:     

Log in to the Cvent server Query/search your account data via Cvent Objects Create, update, and delete contact data via the Contact Object Transfer, create, check in, register, and email invitees Transfer, create, and email respondents

For each operation, the client applications submit a synchronous request to the Cvent Web service, wait for a response, and process the results. These operations, or calls, are defined in section 2.0 Call Definitions.

1.4

Available Objects

The Cvent Web services API interacts with client data via objects, which are programmatic representations of your account data. These objects are defined in section 3.0 Object Definitions.        

API Core Objects – CvSearch and CvObject Contact Objects – Contact and ContactGroup Administration Objects – User, MeetingRequestUser, Approver, UserGroup, UserRole, MeetingRequest Event Objects – Event, EventParameters, EventDetails, Invitee, Registration, Guest, EventEmailHistory, Transaction, Travel, Budget, BudgetItem, EventQuestion Survey Objects – Survey, Respondent, Response, SurveyEmailHistory, SurveyQuestion eMarketing Objects – Campaign, DistributionList, EMarketingEmailHistory Supplier Objects – RFP, Proposal, Supplier RFP Objects – SupplierRFP, SupplierProposal, RFPParameters, RateHistory

For example, an Event object represents events. An Event object has fields that represent the event title, event start date, location address, and so on.

Page 10 of 155

Cvent Web Services API Version V200611 January 2015

1.5

Supported Editions

Clients using any Cvent solutions will be able to purchase and use the Cvent Web Services API.

1.6

Location

The Cvent Web services API can be accessed at https://api.cvent.com/soap/V200611.ASMX The Cvent API WSDL file can be downloaded at https://api.cvent.com/soap/V200611.ASMX?WSDL

1.7

Notes

Please take into account the following notes when programming to the Cvent API service:  The API is a stateless Web services application. Therefore, it will not maintain the state, or status between calls. The calling application shall maintain its own state if it is needed.  The API can only be accessed via HTTPS. HTTPS uses Secure Sockets Layer (SSL) encryption. SSL uses certificates to verify the authenticity and ownership of a Web site. In this case, HTTPS is used to verify that the client is indeed interacting with cvent.com.  A valid user session will automatically expire one hour following ticket creation, if addition time is required by the client application a new ticket will need to be generated by making a second login call. Tickets are used for identification and authentication of the client.

1.7.1

Transaction Limitations

1.7.1.1

API Limits

To maintain optimum performance and ensure that the API is available to all of our customers, Cvent balances transaction loads by limiting the number of API requests (or calls) that any one client may execute concurrently or within any 24-hour period Eastern Time (ET). At this time, a maximum of 10,000 calls per organization may be made within a 24-hour period (midnight to midnight). Use the DescribeGlobal call to view API account data as well as verify your current API call count and limit.

1.7.1.2

Call Specific Limits

For the same reasons, Cvent also limits the number of objects or IDs that can be processed within a single call.  Search – 25,000 IDs  Retrieve – 200 Objects  CreateContact, UpdateContact, DeleteContact, CreateContactGroup, TransferInvitee, and SendEmail – 200 Objects, CreateSurveyAnswer  GetUpdated – 10,000 IDs

Page 11 of 155

Cvent Web Services API Version V200611 January 2015

2.0

Call Definitions 2.1

Overview

The following API calls are available: Call Type

Call Name

Description

Logs in to the Cvent server and starts a client session. The login session automatically expires after one hour.

Searches for objects based on keywords and object properties.

Retrieve

Retrieves one or more objects based on the specified IDs.

CreateContact

Adds one or more new contacts.

UpdateContact

Updates one or more existing contacts.

UpsertContact

Inserts or updates one or more contacts.

DeleteContact

Deletes one or more contacts.

CreateContactGroup

Adds one or more new contact groups.

ManageContactGroupMembers

Updates one or more existing contacts.

TransferInvitee

This call in conjunction with the contact level API calls can be used to replace the existing HTTP POST process. This process will either find an existing Invitee record or create a new Invitee record if the specified contact is not already associated with the activity (Event or Survey) in question.

ValidateInvitee

Checks whether an invitee is eligible to attend an event or session.

UpdateInviteeInternalInfo

Updates internal information answers for one or more invitee.

CheckIn

Marks one or more invitees as participants for an event.

SimpleEventRegistration

Updates a simple event registration status for one or more invitees.

CreateSurveyAnswer

Inserts one or more answers on behalf of your survey respondents.

CreateRFP

Creates a new RFP.

CopyEvent

Creates a new event by copying an existing one.

CreateNoRegEvent

Creates an event with no online registration.

CreateTransaction

Inserts offline payments for one or more registrants within an event.

CreateDistributionList

Adds one or more eMarketing distribution lists.

ManageDistributionListMembers

Manages distribution list members.

CreateUser

Adds one or more new users.

UpdateUser

Updates one or more existing users.

DeleteUser

Deletes one or more users.

CreateApprover

Adds one or more approvers.

DeleteApprover

Deletes one or more existing approvers.

UpdateApprover

Updates one or more existing approvers.

CreateRateHistory

Creates one or more rate history records.

DeleteRateHistory

Deletes one or more rate history records.

Search & Retrieve

Modify Data

ManageUserGroup

Updates one or more existing users.

SendEmail

Schedules emails to be sent to one or more invitees or respondents.

Data Replication

GetUpdated

Retrieves the IDs of individual objects that have been updated or created since the specified time for the specified object.

DescribeGlobal

Retrieves a list of available objects for your organization's data and important API limitations.

DescribeCvObject

Retrieves metadata (field list and object properties) for the specified object types.

Object Metadata

Page 12 of 155

Cvent Web Services API Version V200611 January 2015

2.1.1 Login Usage Use the Login call to log in to the Cvent server and start a client session. A client application must log in and obtain a CventSessionHeader and server URL before making any other API calls.

Basic Steps 1. 2.

When a client application invokes the Login call, it passes the Cvent account number, username, and password. Upon calling, the Web service authenticates the login, and verifies if the request is coming from any of predefined IP addresses. Call Cvent Client Services at 866-318-4357 to set up your list of allowed IP addresses. After successful authentication, the Login call returns the CventSessionHeader for the session and the URL that should be used to make all subsequent API calls for that session. Note: Sessions automatically expire after one hour from when the session was created. After logging in, a client application needs to: ď&#x201A;ˇ

Set the CventSessionHeader in the SOAP header so that the Cvent Web service can validate subsequent requests for this session.

ď&#x201A;ˇ Specify the server URL as the target server for subsequent service requests. Note: Development tools differ in the way you specify session headers and server URLs. For more information, see the documentation for your particular development tool.

General Syntax LoginResult = cventapi.Login(string AccountNumber, string UserName, string Password)

Input Name

Type

Description

AccountNumber

String

The Cvent account number associated with the username the client application is using to access the Cvent system.

UserName

String

The Cvent username the client application is using to access the Cvent system.

Password

String

The Cvent password associated with the given username and account number.

Name

Type

Description

LoginSuccess

Boolean

Indicates whether the login was a success or not. If the value is false, the client application will need to create a new session in order to make subsequent calls.

ServerURL

String

URL of the Cvent Web service that will process subsequent API calls. The client application needs to define the target server.

CventSessionHeader

String

Unique ID associated with the current session. The client application needs to set this value in the SOAP header.

Output

Page 13 of 155

Cvent Web Services API Version V200611 January 2015

2.1.2 Search Usage Use Search to search for specified objects.

General Syntax SearchResultArray = cventapi.Search(CvObjectType ObjectType, CvSearchObject CvSearchObject)

Input Name

Type

Description

ObjectType

CvObject Type

Object from which to retrieve data.

CvSearchObject

CvSearch Object

A Cvent search object that defines the parameters of the given search. The parameters supplied must match the valid parameters for the supplied ObjectType. See section 3.2 for more details on this object.

Name

Type

Description

ID Array

Array of one or more object IDs that meet the search parameters supplied.

Output

Notes Please take into account the following notes when using the Search call:  Maximum Number of Search Filters Passed – Your can pass to 256 search filters in a single search call. If a search request exceeds 256 search filters, then the entire operation fails.  Searching on Custom Fields – Event and Contact custom fields are searchable using this method. To search on a custom field, the field parameter in the CvSearchObject must match the following format and include the custom field ID: o

Event Custom Field: “CustomEventField:<FieldId>”

Contact Custom Field: “CustomContactField:<FieldId>”

Page 14 of 155

Cvent Web Services API Version V200611 January 2015

2.1.3 Retrieve Usage Use Retrieve to retrieve the detailed data associated with a specific object.

Basic Steps 1.

2. 3. 4.

Determine the ID of each object that you want to retrieve. For example, you might call GetUpdated to get a list of transactions that have taken place within a specific date range. Construct an ID array and populate it with the IDs of the records you wish to retrieve. Call Retrieve, passing in the ID array and the ObjectType string. Process the results in the CvObject array result set. Note: Retrieve Registration only returns “accepted” or “cancelled” invitees and guests. Retrieve Response only returns “partial” and “completed” respondents.

General Syntax RetrieveResultArray = cventapi.Retrieve(CvObjectType ObjectType, IdArray Ids)

Input Name ObjectType Ids

Type CvObject Type ID Array

Description Object from which to retrieve data. Array of one or more object IDs to be retrieved.

Output Name CvObject

Type CvObject Array

Description Array of one or more CvObjects representing individual objects of the specified object. The number of CvObjects returned in the array matches the number of object IDs passed into the retrieve call. If you do not have access to an object or if a passed ID is invalid, the array returns null for that object.

Page 15 of 155

Cvent Web Services API Version V200611 January 2015

2.1.4 GetUpdated Usage Use GetUpdated to get the IDs of individual objects that have been updated or created during the specified time for the specified object.

Basic Steps 1. 2.

Call GetUpdated, passing in the object and time span for which to retrieve data. Iterate through the returned array of IDs. For each ID element in the array, call Retrieve to obtain the latest information you want from the associated object. Your client application must then take the appropriate action on the local data, such as inserting new rows or updating existing ones with the latest information. Optionally, the client application saves the request timestamp for future reference.

General Syntax GetUpdatedResultArray = cventapi.GetUpdated(CvObjectType ObjectType, dateTime StartDate, dateTime EndDate)

Input Name

Type

Description

ObjectType

CvObject Type

Object from which to retrieve data.

StartDate

DateTime

Starting date/time (GMT â&#x20AC;&#x201C; not local time zone) of the time span for which to retrieve the data. The Cvent Web service ignores the seconds portion of the specified dateTime value. For example, 12:30:15 is interpreted as 12:30:00 GMT.

EndDate

DateTime

Ending date/time (GMT â&#x20AC;&#x201C; not local time zone) of the time span for which to retrieve the data. The Cvent Web service ignores the seconds portion of the specified dateTime value. For example, 12:30:15 is interpreted as 12:30:00 GMT.

Name

Type

Description

ID Array

Array of one or more Object IDs that have been updated or created in the given time span.

Output

Page 16 of 155

Cvent Web Services API Version V200611 January 2015

2.1.5 DescribeGlobal Usage Use the DescribeGlobal to get the API settings for your account.

General Syntax DescribeGlobalResult = cventapi.DescribeGlobal ()

Input None

Output Name

Type

Description

MaxAPICalls

Integer

Maximum number of API calls that can be made by your organization within a 24-hour period (midnight to midnight) Eastern Time (ET).

CurrentAPICalls

Integer

Current number of API calls made by your organization in the current 24-hour period (midnight to midnight) Eastern Time (ET).

MaxBatchSize

Integer

The maximum number of records that can be impacted by a Create, Update, or Delete call.

MaxRecordSet

Integer

The maximum number of records that can be impacted by a Create, Update, or Delete call.

CvObjectTypes

String Array

A list of object types valid for your account.

Page 17 of 155

Cvent Web Services API Version V200611 January 2015

2.1.6 DescribeCvObject Usage Use the DescribeCvObject to get metadata associated with your account CvObjects.

General Syntax DescribeCvObjectResultArray = cventapi.DescribeCvObject (CvObjectTypeArray ObjectTypes)

Input Name

Type

Description

ObjectTypes

CvObject Type Array

An array of the objects you want described.

Output Name

Type

Description

Name

String

Name of the object. This is the same string that was passed in as the CvObjectType parameter.

Creatable

Boolean

Indicates whether a create call can be made (True) or not (False) for this object.

Updateable

Boolean

Indicates whether an update call can be made (True) or not (False) for this object.

Deletable

Boolean

Indicates whether a delete call can be made (True) or not (False) for this object.

Replicateable

Boolean

Indicates whether a GetUpdated call can be made (True) or not (False) for this object.

Retrieveable

Boolean

Indicates whether a retrieve call can be made (True) or not (False) for this object.

Searchable

Boolean

Indicates whether a search call can be made (True) or not (False) for this object.

Fields

Field

Gives field level data about the object. The field data includes the following information:  Name – The field name.  DataType – The data type of the field.  MaxLength – The maximum length of the field. This property is only used for string type fields.  Searchable – Indicates if the field can be used in a Search call.  Required – Indicates if the field is required for a Create call.  ReadOnly – Indicates if the field can be updated in an update call or specified in a Create call.  DefaultValue – Gives the default value of the field for a Create or Update call, if no value is supplied.  DefaultSerachValue – Gives the default value for a Search call if no specific filter for this field is defined.

Custom Field

Field

Gives field level data about the object. The field data includes the following information:  ID – The ID of the custom field.  Name – The custom field name.  Category – The category of the custom field.  FieldType – Indicates the field type.  Format – The format of the custom field.  SetOrder – The order of the custom field.  AnswerText – The answer text of the custom field.

Page 18 of 155

Cvent Web Services API Version V200611 January 2015

2.2

Administration 2.2.1 CreateUser Usage Use CreateUser to add one or more users to your Cvent account data. The CreateUser call is analogous to the INSERT statement in SQL.

Basic Steps 1.

Create an instance of one or more individual user objects. For each user object, you populate its fields with the data that you want to add. Construct a User array and populate that array with the users that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateUser, passing in the User. Process the results in the CreateUserResultArray object to verify whether the users have been successfully created.

2. 3.

4. 5.

General Syntax CreateUserResultArray = cventapi.CreateUser (UserArray)

Input Name

Type

Description

Users

CVObjectArray

Array of one or more instances (up to 200) to create, and optionally MessageIds which will be returned as ReferenceIds.

Output Name

Type

Description

ID of the user that you attempted to create. If this field contains a value, then the user was created successfully. If this field is empty, then the user was not created and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Notes Please take into account the following notes when using the CreateUser call:  Automatically Maintained Fields – The Cvent Web service generates unique values for ID fields automatically. For create, for example you cannot explicitly specify an ID value for a user. The CreateUserResult array contains the ID of each user that was successfully created.  Default Values – Certain fields have a default value. If you do not specify a value for such fields, the Cvent Web service populates these fields with the default value. For required fields that do not have a preconfigured default value, you must supply a value.  Required Fields – For required fields that do not have a pre-configured default value, you must supply a value.  Valid Data Values – You must supply values that are valid for the field's data type, such as integers (not alphabetic characters) for integer fields. In your client application, follow the data formatting rules specified for your programming language and development tool. Your development tool will handle the appropriate mapping of data types in SOAP messages.

Page 19 of 155

Cvent Web Services API Version V200611 January 2015

 String Values – When storing values in string fields, the Cvent Web service trims any leading and trailing whitespace. For example, if the value of a name field is entered as " XYZ Company ", then the value is stored in the database as "XYZ Company".  Maximum Number of Users Created – Your can add up to 200 individual users in a single create call. If a create request exceeds 200 users, then the entire operation fails.

Validation Rules The following validation rules should be applied to the CreateUser call: Format and Pattern

Referential Integrity Length Read-Only

 

The ID field should be a valid GUID data type. Email addresses should be in a valid email address format.

The following relationships need to be valid to ensure database referential integrity:  UserRoleID  CountryCode  StateCode The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Note: By default, users will be created as application users. To create a meeting request user, specify “Requester” as the user type.

Page 20 of 155

Cvent Web Services API Version V200611 January 2015

2.2.2 UpdateUser Usage Use UpdateUser to update one or more existing users to your Cvent account data. The update call is analogous to the UPDATE statement in SQL.

Basic Steps 1.

Determine the ID of each user that you want to update. For example, you might call Search to retrieve a set of users IDs that you would want to update. If you store the Cvent IDs for your user records within your database, you can use these IDs to update the desired users. For each object, populate its fields with the data that you want to update. Note: To preserve an existing field value, pass the null value for that field.

2. 3. 4.

Construct a User array and populate that array with the users that you want to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateUser, passing in the User array. Process the results in the UpdateUserResultArray object to verify whether the Users have been successfully updated.

5. 6.

General Syntax UpdateUserResultArray = cventapi.UpdateUser(UserArray Users)

Input Name

Type

Description

Users

CvObject Array

Array of one or more instances (up to 200) to update, and optionally MessageIds which will be returned as ReferenceIds.

Output Name

Type

Description

ID of the user that you attempted to update. If this field contains a value, then the contact was successfully updated. If this field is empty, then the user was not updated and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject

Success

Boolean

Indicates whether the update call succeeded (True) or not (False) for this user.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Validation Rules The following validation rules should be applied to the UpdateUser call: General Format and Pattern Uniqueness

Referential Integrity Length Read-Only

The UpdateUser method shall update User by input UserId.  

The ID field should be a valid GUID data type. Email addresses should be in a valid email address format.

Based on DupMatchKey, only the first instance of a user in the array will update the user record. All subsequent instances will return an error message. The following relationships need to be valid to ensure database referential integrity:  UserRoleID  CountryCode  StateCode The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 21 of 155

Cvent Web Services API Version V200611 January 2015

2.2.3 DeleteUser Usage Use DeleteUser to delete one or more existing users from your account.

Basic Steps 1.

2. 3.

4. 5.

Determine the ID of each user that you want to delete. For example, you might call Search to retrieve a set of users IDs that you would want to delete. If you store the Cvent IDs for your user records within your database, you can use these IDs to delete the desired users. Construct a CvObject array and populate it with the IDs of each user that you want to delete. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call DeleteUser, passing in the ID array. Process the results in the DeleteUserResultArray object to verify whether the objects have been successfully deleted.

General Syntax DeleteUserResultArray = cventapi.DeleteUser(CvObjectArray CvObjects)

Input Name

Type

Description

Users

CvObject Array

Array of one or more CvObject, which contains user IDs to be deleted, and optionally MessageIds which will be returned as ReferenceIds.

Name

Type

Description

ReferenceId

The MessageId value in the input CvObject.

Success

Boolean

Indicates whether the delete call succeeded (True) or not (False) for this user.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Output

Page 22 of 155

Cvent Web Services API Version V200611 January 2015

2.2.4 CreateApprover Usage Use CreateApprover to add one or more approvers to your Cvent account data.

Basic Steps 1.

Create an instance of one or more approver objects. For each approver object, you populate its fields with the data that you want to add. Construct an Approver array and populate that array with the approver configurations you want to create Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateApprover, passing in the Approver array. Process the results in the CreateApproverResultArray object to verify whether the transactions have been successfully created.

2. 3.

4. 5.

General Syntax CreateApprovertResultArray = cventapi.CreateApprover (Approver Array)

Input Name

Type

Description

Approver

Approver Array

Array of one or more Approver objects that need to be created (max. 200) and optionally message IDs which will be returned as ReferenceIDs.

Name

Type

Description

ID of the ApproverCategory that the user attempted to create.

ReferenceId

String

MessageId input.

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Validation Rules The following validation rules should be applied to the CreateApprover call: Format and Pattern Uniqueness

Approver field should be in a valid email address format. ApproverCategory and RequestorSourceValue fields will be unique. Only one configuration can be setup for a source.

Page 23 of 155

Cvent Web Services API Version V200611 January 2015

2.2.5 DeleteApprover Usage Use DeleteApprover to delete one or more existing approvers from your Cvent account data.

Basic Steps 1.

2. 3.

4. 5.

Determine the approver configurations that need to be deleted. For example, you might call Search to retrieve a set of Approver objects instance that you might want to delete. If you store the approver instances for your records within your database, you can use those records to delete the desired instances. Construct an Approver array and populate it with the approver configuration you want to delete. Note: ApproverCategory and RequestorSourceValue are required fields. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call DeleteApprover, passing in the Approver array Process the results in the DeleteApproverResultArray object to verify whether the transactions have been successfully deleted.

General Syntax DeleteApprovertResultArray = cventapi.DeleteApprover (Approver Array)

Input Name

Type

Description

Approver

Approver Array

Array of one or more Approver objects that need to be deleted (max. 200) and optionally message IDs which will be returned as ReferenceIDs.

Name

Type

Description

Approver

Approver Array

Array of Approver object instances that were created.

ReferenceId

String

MessageId input.

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Page 24 of 155

Cvent Web Services API Version V200611 January 2015

2.2.6 UpdateApprover Usage Use UpdateApprover to update one or more existing approver configurations to your Cvent account data.

Basic Steps 1.

2. 3.

4. 5.

Determine the approver configurations that need to be updated. For example, you might call Search to retrieve a set of Approver objects instance that you might want to update. If you store the approver instances for your records within your database, you can use those records to update the desired instances. Construct an Approver array and populate it with the approver configuration you want to update. Note: ApproverCategory and RequestorSourceValue are required fields. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateApprover, passing in the Approver array Process the results in the DeleteApproverResultArray object to verify whether the transactions have been successfully updated.

General Syntax UpdateApprovertResultArray = cventapi.UpdateApprover (Approver Array)

Input Name

Type

Description

Approver

Approver Array

Array of one or more Approver objects that need to be updated (max. 200) and optionally message IDs which will be returned as ReferenceIDs.

Name

Type

Description

Approver

Approver Array

Array of Approver object instances that were updated.

ReferenceId

String

MessageId input.

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Page 25 of 155

Cvent Web Services API Version V200611 January 2015

2.2.7 CreateRateHistory Usage Use CreateRateHistory to add rate history records to one or more venues.

Basic Steps 1. 2.

Create an instance of one or more individual rate history objects. Construct a RateHistory array and populate that array with the rate history records that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call RateHistory, passing in the array of rate history records. Process the results in the CreateRateHistoryResultArray object to verify whether the rate history records have been successfully created.

4. 5.

General Syntax CreateRateHistoryResultArray = cventapi.CreateRateHistory (RateHistoryArray)

Input Name

Type

Description

RateHistory

RateHistory Array

Array of one or more RateHistory records (up to 200) to create, and optionally MessageIds which will be returned as ReferenceIds.

Name

Type

Description

ID of the RateHistory record that the client attempted to create. This value will only be populated if the insert was successful.

ReferenceId

The MessageId value input with the RateHistory object instance.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Output

Validation Rules The following validation rules should be applied to the CreateRateHistory call: Uniqueness Referential Integrity

If the venue code does not exist, all instances of the in the input array will return error messages. The following relationship needs to be valid to ensure database referential integrity: VenueCode

Page 26 of 155

Cvent Web Services API Version V200611 January 2015

2.2.8 DeleteRateHistory Usage Use DeleteRateHistory to delete one or more rate history records from your account.

Basic Steps 1. 2. 3.

4. 5.

Determine the ID of each rate history records that you want to delete. Construct a CvObject array and populate it with the IDs of each rate history record that you want to delete. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call DeleteRateHistory, passing in the ID array. Process the results in the DeleteRateHistoryResultArray object to verify whether the objects have been successfully deleted.

General Syntax DeleteRateHistoryResultArray = cventapi.DeleteRateHistory(CvObjectArray CvObjects)

Input Name

Type

Description

RateHistoryIDs

CvObject Array

Array of one or more RateHistoryIDs (up to 200) to delete, and optionally MessageIds which will be returned as ReferenceIds.

Name

Type

Description

ID of the RateHistory record that the client attempted to delete. This value will only be populated if the insert was successful.

ReferenceId

The MessageId value input with the RateHistory object instance.

Success

Boolean

Indicates whether the delete call succeeded (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Output

Page 27 of 155

Cvent Web Services API Version V200611 January 2015

2.2.9 ManageUserGroup Usage Use ManageUserGroup to update user records based on the provided action.

Basic Steps 1.

2. 3.

Determine the IDs of the users that you want to update. For example, you might call Search to retrieve a set of users IDs that you would want to update. If you store the Cvent IDs for your user records within your database, you can use these IDs to update the desired users. Construct an ID array and populate it with the IDs of each user record that you wish to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call ManageUserGroup, passing in the ID array, the action you wish to take on the users, and the user group ID. Note: The “Remove” action removes users from the group and does not delete the user group itself. Process the results in the ManageUserGroup object to verify whether the objects have been successfully updated.

General Syntax ManageUserGroupResultArray = cventapi.ManageUserGroup (ManageGroupAction Action, ID GroupId, CvObjectArray CvObjects)

Input Name

Type

Description

Action

Manage Group Action

The action being taken on the objects. Valid actions: ‘Add’ & ‘Remove’.

GroupId

The ID of the Group you adding or removing objects to or from.

CvObjects

CvObject Array

Array of one or more CvObject, which contains object IDs to be updated, and optionally MessageIds which will be returned as ReferenceIds.

Output Name

Type

Description

ID of the user that you attempted to update.

ReferenceId

The MessageId value in the input CvObject.

Success

Boolean

Indicates whether the ManageUserGroup call succeeded (True) or not (False) for this user.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Notes Please take into account the following notes when using the ManageUserGroup call:  Maximum Number of Users Updated – Your can update up to 200 individual users in a single ManageUsersGroupMembers call. If the ManageUsersGroupMembers request exceeds 200 users, then the entire operation fails.

Validation Rules The following validation rules should be applied to the ManageUserGroup call: Actions

Valid actions are Add and Remove.  For the Add action to succeed, the user must not already be a member of the specified user group.

Page 28 of 155

Cvent Web Services API Version V200611 January 2015

ď&#x201A;ˇ Uniqueness

For the Remove action to succeed, the user must already be a member of the specified user group.

Based on ID, only the first instance of a user in the array will update the user record. All subsequent instances will return an error message.

Page 29 of 155

Cvent Web Services API Version V200611 January 2015

2.2.10 CreateConversionRate Usage Use CreateConversionRate to create or update a conversion rate in an event.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual ConversionRates objects. For each ConversionRate object, you populate its fields with the data that you want to add. Construct a ConversionRate array and populate that array with the Conversion Rate that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateConversionRate, passing in the ConversionRate array. Process the results in the CreateConversionRateResultArray object to verify whether the conversion rate have been successfully created.

General Syntax CreateConversionRateResultArray = cventapi.CreateConversionRate (ConversionRateArray)

Input Name

Type

Description

ConversionRateArray

CvConversionRate

Array of one or more conversion rates. A MessageId can also be included with each instance of the array.

Name

Type

Description

ID of ConversionRate record included in the create call.

ReferenceId

String

MessageId input for the CvConversionRate object instance.

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the CreateConversionRate call: ď ˝ ConversionRateId â&#x20AC;&#x201C; ConversionRateId, if specified with the call will be used to update an existing conversion rate otherwise a new conversion rate will be created.

Page 30 of 155

Cvent Web Services API Version V200611 January 2015

2.2.11 DeleteConversionRate Usage Use DeleteConversionRate to delete a conversion rate from an event.

Basic Steps 1. 2. 3.

4. 5.

Determine the ID of the ConversionRate you want to delete. Construct a CvObject array and populate it with the IDs of each user that you want to delete. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call DeleteConversionRate, passing in the ID array. Process the results in the DeleteConversionRateResultArray object to verify whether the objects have been successfully deleted.

General Syntax DeleteConversionRateResultArray = cventapi. DeleteConversionRate (CvObjectArray CvObjects)

Input Name

Type

Description

CvObject Array

Array

Array of one or more Id to delete. No more than 200 in an array. A MessageId can also be included with each instance of the array.

Output Name

Type

Description

GUID

Id specified with the call.

ReferenceId

String

MessageId input

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Page 31 of 155

Cvent Web Services API Version V200611 January 2015

2.2.12 CreateCustomField Call Usage Use CreateCustomField to add one or more custom fields to your Cvent account. The CreateContact call is analogous to the INSERT statement in SQL.

Basic Steps 1.

Create an instance of one or more individual custom field objects. For each custom field object, you populate its fields with the data that you want to add. Construct a CustomField array and populate that array with the custom fields that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateCustomField, passing in the CustomField array. Process the results in the CreateCustomFieldResultArray object to verify whether the custom fields have been successfully created.

2. 3.

4. 5.

General Syntax CreateCustomFieldResultArray = cventapi.CreateCustomField (CustomFieldArray)

Input Name

Type

Description

CustomFieldCategory

Enumeration

Contains all possible categories for custom field. (e.g. ContactCustomField, EventCustomField, RFPCustomField etc.)

CustomField

CvObject Array

Array of one or more Custom FIelds (up to 200) to create. Optional MessageIDs, returned as ReferenceIDs.

Output Name

Type

Description

Error

If an error occurred during the CreateCustom Field, an error object providing error code and description.

ID of the Custom Field created.

ReferenceId

The MessageID value in the input CvObject.

Success

Boolean

Indicates whether the createcall succeeded (True) or not (False) for this custom field.

Validations The following validation rules should be applied to the CreateCustomField call: Format and Pattern Uniqueness Length Read-Only

The ID field should be a valid GUID data type. FieldCode must be a unique value to other custom fields. The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 32 of 155

Cvent Web Services API Version V200611 January 2015

2.2.13 UpdateCustomField Call Usage Use UpdateCustomField to update one or more existing custom fields in your Cvent account. The update call is analogous to the UPDATE statement in SQL.

Basic Steps 1.

Determine the ID of each custom field that you want to update. For example, you might call Search to retrieve a set of custom field IDs that you would want to update. If you store the Cvent IDs for your custom field records within your database, you can use these IDs to update the desired custom fields. For each object, populate its fields with the data that you want to update. Note: To preserve an existing field value, pass the null value for that field. Construct a CustomField array and populate that array with the custom fields that you want to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateCustomField, passing in the CustomField array. Process the results in the UpdateCustomFieldResultArray object to verify whether the custom fields have been successfully updated.

2. 3. 4.

5. 6.

General Syntax UpdateCustomFieldResultArray = cventapi.UpdateCustomField (CustomFieldArray)

Input Name

Type

Description

CustomFieldCategory

Enumeration

Contains all possible categories for custom field. (e.g. ContactCustomField, EventCustomField, RFPCustomField etc.)

CustomField

CvObject Array

Array of one or more Custom FIelds (up to 200) to update. Optional MessageIDs, returned as ReferenceIDs.

Output Name

Type

Description

Error

If an error occurred during the Update Custom Field, an error object providing error code and description.

ID of the Custom Field created.

ReferenceId

The MessageID value in the input CvObject.

Success

Boolean

Indicates whether the update call succeeded (True) or not (False) for this custom field.

Validations The following validation rules should be applied to the UpdateCustomField call: Format and Pattern Length Read-Only

The ID field should be a valid GUID data type. The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 33 of 155

Cvent Web Services API Version V200611 January 2015

2.2.14 AddAdvancedLogic Call Usage Use AddAdvancedLogic to add one or more advanced logic layers to your Cvent custom fields. The AddAdvancedLogic call is analogous to the INSERT statement in SQL.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual advanced logic objects. For each advanced logic object, you populate its fields with the data that you want to add. Construct an AdvancedLogic array and populate that array with the advanced logic objects that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call AddAdvancedLogic, passing in the AdvancedLogic array. Process the results in the AddAdvancedLogicResultArray object to verify whether the advanced logic objects have been successfully created.

General Syntax AddAdvancedLogicResultArray = cventapi.AddAdvancedLogic (AdvancedLogicArray)

Input Name

Type

Description

CustomFieldCategory

Enumeration

Contains all possible categories for custom field. (e.g., ContactCustomField, EventCustomField, RFPCustomField etc.)

AdvancedLogic

CvObject Array

Array of one or more AdvancedLogic objects (up to 200) to add advanced logic. Optional MessageIDs, returned as ReferenceIDs.

Name

Type

Description

Errors

Error Array

If an error occurred during the Advanced Logic call, an array of one or more Error objects providing the error code and description.

ID of the Custom Field for which advanced logic is being added.

ReferenceId

The MessageID value in the input CvObject.

Success

Boolean

Indicates whether the advanced logic has been added successfully (True) or not (False) for the custom field.

Output

Validations The following validation rules should be applied to the AddAdvancedLogic call: Format and Pattern Length Read-Only

The ID and Source fields should be a valid GUID data type. The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 34 of 155

Cvent Web Services API Version V200611 January 2015

2.3

Contacts 2.3.1 CreateContact Usage Use CreateContact to add one or more contacts to your Cvent account data. The CreateContact call is analogous to the INSERT statement in SQL.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual contact objects. For each contact object, you populate its fields with the data that you want to add. Construct a Contact array and populate that array with the contacts that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateContact, passing in the Contact array. Process the results in the CreateContactResultArray object to verify whether the contacts have been successfully created.

General Syntax CreateContactResultArray = cventapi.CreateContact(ContactArray)

Input Name

Type

Description

Contacts

Contact Array

Array of one or more contacts (up to 200) to create, and optionally MessageIds which will be returned as ReferenceIds. The Cvent Web service creates these contacts in array index order.

Name

Type

Description

ID of the contact that you attempted to create. If this field contains a value, then the contact was created successfully. If this field is empty, then the contact was not created and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject

SourceId

String

Source ID of the contact. If this field contains a value a source ID was sent in along with the contact’s other values. If the field is empty, then no source ID was supplied in the original call.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the CreateContact call:  Permissions – Your client application must be logged in with sufficient access rights to create contacts within the account.  Automatically Maintained Fields – The Cvent Web service generates unique values for ID fields automatically. For create, for example you cannot explicitly specify an ID value for a contact. The CreateContactResult array contains the ID of each contact that was successfully created.  Default Values – Certain fields have a default value. If you do not specify a value for such fields, the Cvent Web service populates these fields with the default value. For required fields that do not have a preconfigured default value, you must supply a value.

Page 35 of 155

Cvent Web Services API Version V200611 January 2015

 Required Fields – For required fields that do not have a pre-configured default value, you must supply a value.  Valid Data Values – You must supply values that are valid for the field's data type, such as integers (not alphabetic characters) for integer fields. In your client application, follow the data formatting rules specified for your programming language and development tool. Your development tool will handle the appropriate mapping of data types in SOAP messages.  String Values – When storing values in string fields, the Cvent Web service trims any leading and trailing whitespace. For example, if the value of a name field is entered as "XYZ Company”, then the value is stored in the database as "XYZ Company".  Maximum Number of Contacts Created – Your can add up to 200 individual contacts in a single create call. If a create request exceeds 200 contacts, then the entire operation fails.

Validation Rules The following validation rules should be applied to the CreateContact call: Format and Pattern

 

The ID field should be a valid GUID data type. Email addresses should be in a valid email address format.

The application will generate a DupMatchKey from your match key fields and a new contact stub for each contact record. Your match key fields are either email address only or email address, last name, and company.

Uniqueness

Referential Integrity Length Read-Only

The generated DupMatchKey will need to be unique within the input array and your account’s contact records. If a contact’s generated DupMatchKey is not unique, the contact creation result should be marked as failed and return the “Duplicated Contact Object – Key field(s) are not unique” error.  If the contact does exist in your account, all instances of the contact in the input array will return error messages.  If the contact does not exist in your account, the first instance of the contact in the input array will succeed. All subsequent instances will return an error message. The following relationships need to be valid to ensure database referential integrity:  ContactTypeCode  CountryCode  StateCode The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 36 of 155

Cvent Web Services API Version V200611 January 2015

2.3.2 UpdateContact Usage Use UpdateContact to update one or more existing contacts to your Cvent account data. The update call is analogous to the UPDATE statement in SQL.

Basic Steps 1.

Determine the ID of each contact that you want to update. For example, you might call Search to retrieve a set of contacts IDs that you would want to update. If you store the Cvent IDs for your contact records within your database, you can use these IDs to update the desired contacts. For each object, populate its fields with the data that you want to update. Note: To preserve an existing field value, pass the null value for that field.

2. 3. 4.

Construct a Contact array and populate that array with the contacts that you want to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateContact, passing in the Contact array. Process the results in the UpdateContactResultArray object to verify whether the Contacts have been successfully updated.

5. 6.

General Syntax UpdateContactResultArray = cventapi.UpdateContact(ContactArray Contacts)

Input Name

Type

Description

Contacts

Contacts Array

Array of one or more contacts (up to 200) to be updated, and optionally MessageIds which will be returned as ReferenceIds. The Cvent Web service creates these contacts in array index order.

Output Name

Type

Description

ID of the contact that you attempted to update. If this field contains a value, then the contact was successfully updated. If this field is empty, then the contact was not updated and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject

SourceId

String

Source ID of the contact. If this field contains a value a source ID was sent in along with the contact’s other values. If the field is empty, then no source ID was supplied in the original call.

Success

Boolean

Indicates whether the update call succeeded (True) or not (False) for this contact.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Validation Rules The following validation rules should be applied to the UpdateContact call: General Format and Pattern Uniqueness Referential Integrity

The UpdateContact method shall update Contact by input ContactId.  

The ID field should be a valid GUID data type. Email addresses should be in a valid email address format.

Based on DupMatchKey, only the first instance of a contact in the array will update the contact record. All subsequent instances will return an error message. The following relationships need to be valid to ensure database referential integrity:  ContactTypeCode  CountryCode

Page 37 of 155

Cvent Web Services API Version V200611 January 2015

ď&#x201A;ˇ Length Read-Only

StateCode

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 38 of 155

Cvent Web Services API Version V200611 January 2015

2.3.3 UpsertContact Usage Use UpsertContact to insert or update one or more contacts to your Cvent account data. For each instance, Cvent will determine if the contact already exists in the Cvent address book. If so, the process will result in an update. If not, it will result in a newly created contact.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual contact objects. For each contact object, you populate its fields with the data that you want to add. Construct a Contact array and populate that array with the contacts that you want to create/update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpsertContact, passing in the Contact array. Process the results in the UpsertContactResultArray object to verify whether the contacts have been successfully created/updated.

General Syntax CreateContactResultArray = cventapi.CreateContact(ContactArray)

Input Name

Type

Description

Contacts

Contacts Array

Array of one or more contacts (up to 200) to be created or updated, and optionally MessageIds which will be returned as ReferenceIds.

Output Name

Type

Description

ID of the contact that you attempted to create/update. If this field contains a value, then the contact was successfully created or updated. If this field is empty, then the contact was not created/updated and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject

SourceId

String

Source ID of the contact. If this field contains a value a source ID was sent in along with the contact’s other values. If the field is empty, then no source ID was supplied in the original call.

Success

Boolean

Indicates whether the upsert call succeeded (True) or not (False) for this contact.

NewContact

Boolean

Indicates whether the upsert call resulted in a new contact (True) or not (False).

Errors

Error Array

If an error occurred during the upsert call, an array of one or more Error objects providing the error code and description.

Validation Rules The following validation rules should be applied to the UpdateContact call: Format and Pattern

Email addresses should be in a valid email address format.

Referential Integrity

The following relationships need to be valid to ensure database referential integrity:  ContactTypeCode  CountryCode  StateCode

Length Read-Only

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 39 of 155

Cvent Web Services API Version V200611 January 2015

2.3.4 DeleteContact Usage Use DeleteContact to delete one or more existing contacts in your organization's data. This process will remove a contact from the address book but it will not remove a contacts association with existing events.

Basic Steps 1.

2. 3.

4. 5.

Determine the ID of each contact that you want to delete. For example, you might call Search to retrieve a set of contacts IDs that you would want to delete. If you store the Cvent IDs for your contact records within your database, you can use these IDs to delete the desired contacts. Construct a CvObject array and populate it with the IDs of each contact that you want to delete. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call DeleteContact, passing in the ID array. Process the results in the DeleteContactResultArray object to verify whether the objects have been successfully deleted.

General Syntax DeleteContactResultArray = cventapi.DeleteContact(CvObjectArray CvObjects)

Input Name

Type

Description

CvObjects

CvObject Array

Array of one or more CvObject, which contains contacts IDs to be deleted, and optionally MessageIds which will be returned as ReferenceIds.

Output Name

Type

Description

ReferenceId

The MessageId value in the input CvObject.

SourceId

String

Source ID of the contact. If the deleted contact had a Source ID associated with it that Source ID returned. If there was no Source ID associated with the contact record in Cvent the field will be empty.

Success

Boolean

Indicates whether the delete call succeeded (True) or not (False) for this contact.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Page 40 of 155

Cvent Web Services API Version V200611 January 2015

2.3.5 CreateContactGroup Usage Use CreateContactGroup to add one or more contact groups to your Cvent account data. The CreateContactGroup call is analogous to the INSERT statement in SQL.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual contact group objects. For each contact group object, you populate its fields with the data that you want to add. Construct a ContactGroup array and populate that array with the contact groups that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateContactGroup, passing in the ContactGroup array. Process the results in the CreateContactGroupResultArray object to verify whether the contact groups have been successfully created.

General Syntax CreateContactGroupResultArray = cventapi.CreateContactGroup(ContactGroupArray)

Input Name

Type

Description

Contact Groups

Contact Group Array

Array of one or more contact groups (up to 200) to create, and optionally MessageIds which will be returned as ReferenceIds. The Cvent Web service creates the contact groups in array index order.

Name

Type

Description

ID of the contact group that you attempted to create. If this field contains a value, then the contact group was created successfully. If this field is empty, then the contact group was not created and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the CreateContactGroup call:  Permissions – Your client application must be logged in with sufficient access rights to create contact groups within the account.  Automatically Maintained Fields – The Cvent Web service generates unique values for ID fields automatically. For create, for example you cannot explicitly specify an ID value for a contact group. The CreateContactGroupResult array contains the ID of each contact that was successfully created.  Required Fields – For required fields that do not have a pre-configured default value, you must supply a value.  Valid Data Values – You must supply values that are valid for the field's data type, such as integers (not alphabetic characters) for integer fields. In your client application, follow the data

Page 41 of 155

Cvent Web Services API Version V200611 January 2015

formatting rules specified for your programming language and development tool. Your development tool will handle the appropriate mapping of data types in SOAP messages.  String Values – When storing values in string fields, the Cvent Web service trims any leading and trailing whitespace. For example, if the value of a name field is entered as "XYZ Company”, then the value is stored in the database as "XYZ Company".  Maximum Number of Contact Groups Created – Your can add up to 200 individual contact groups in a single create call. If a create request exceeds 200 contact groups, then the entire operation fails.

Validation Rules The following validation rules should be applied to the CreateContactGroup call: Length Read-Only

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 42 of 155

Cvent Web Services API Version V200611 January 2015

2.3.6 ManageContactGroupMembers Usage Use ManageContactGroupMembers to update contact records based on the provided action.

Basic Steps 1.

2. 3.

Determine the IDs of the contacts that you want to update. For example, you might call Search to retrieve a set of contacts IDs that you would want to update. If you store the Cvent IDs for your contact records within your database, you can use these IDs to update the desired contacts. Construct an ID array and populate it with the IDs of each contact record that you wish to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call ManageContactGroupMembers, passing in the ID array, the action you wish to take on the contacts, and the contact group ID. Note: The “Remove” action removes contacts from the group and does not delete the contact group itself. Process the results in the ManageContactGroupMembers object to verify whether the objects have been successfully updated.

General Syntax ManageContactGroupMembersResultArray = cventapi.ManageContactGroupMembers (ManageGroupAction Action, ID GroupId, CvObjectArray CvObjects)

Input Name

Type

Description

Action

Manage Group Action

The action you are taking on the contacts. Valid actions Add and Remove.

GroupId

The ID of the contact that you adding or removing contacts to or from.

CvObjects

CvObject Array

Array of one or more CvObject, which contains contact IDs to be updated, and optionally MessageIds which will be returned as ReferenceIds.

Name

Type

Description

ID of the contact that you attempted to update.

ReferenceId

The MessageId value in the input CvObject.

Success

Boolean

Indicates whether the ManageContactGroupMembers call succeeded (True) or not (False) for this contact.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the ManageContactGroupMembers call:  Permissions – Your client application must be logged in with sufficient access rights to update contacts within the account.  Maximum Number of Contacts Updated – Your can update up to 200 individual contacts in a single ManageContactGroupMembers call. If the ManageContactGroupMembers request exceeds 200 contacts, then the entire operation fails.

Page 43 of 155

Cvent Web Services API Version V200611 January 2015

Validation Rules The following validation rules should be applied to the ManageContactGroupMembers call:

Actions

Uniqueness

Valid actions are Add and Remove. ď&#x201A;ˇ For the Add action to succeed, the contact must not already be a member of the specified contact group. ď&#x201A;ˇ For the Remove action to succeed, the contact must already be a member of the specified contact group. Based on ID, only the first instance of a contact in the array will update the contact record. All subsequent instances will return an error message.

Page 44 of 155

Cvent Web Services API Version V200611 January 2015

2.3.7 TransferInvitee Usage Use TransferInivtee to create or find an invitee record associated for a specific contact and activity combination.

Basic Steps 1. 2.

3. 4. 5.

6. 7.

Determine the ID of the activity for which you want to transfer the invitee by calling the Search method. Determine the ID of the contact that you wish to transfer. For example, you can call the Search method to retrieve the existing contactâ&#x20AC;&#x2122;s ID. If the contact does not already exist within your address book, call the CreateContact method. If the contact already exists and you would like to update the contactâ&#x20AC;&#x2122;s record before transferring the invitee, call the UpdateContact method. Specify the ID of the TargetedList to associate the contacts (optional). Contacts get added to default TargetedList if none specified. Construct a CvObject array and populate it with the IDs of each contact that you wish to transfer. Optionally, specify the MessageId if you need to track the transfer result of each Contact object. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Make the TransferInvitee call. Redirect the invitee to the desired target Web link.

General Syntax TransferInviteeResultArray = cventapi.TransferInvitee (ActivityType ActivityType, ID ActivtyId, ID TargetedListId, CvObjectArray CvObjects)

Input Name

Type

Description

ActivityType

Activity Type

The type of activity for which you would like to create an invitee record, Event, Campaign, or Survey.

ActivityId

The ID of the activity for which you want to create an invitee record.

TargetedListId

The ID of the targeted list which you want to associate an invitee.

CvObjects

CvObject Array

Array of one or more CvObject, which contains contacts IDs to be transferred, and optionally MessageIds which will be returned as ReferenceIds.

Name

Type

Description

ID of the invitee that you attempted to transfer. If this field contains a value, then the invitee was created or already exists for the given activity contact combination. If this field is empty, then the invitee could not be created or found and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object.

WeblinkDetailAr ray

Weblink

This is an array of the valid Web links associated with the Invitee. Each Web link is made up of a Target (String) and a URL (string). Provided the transfer call was successful this array will be populated.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Output

Page 45 of 155

Cvent Web Services API Version V200611 January 2015

2.3.8 ValidateInvitee Usage Use ValidateInvitee to check whether an invitee is eligible to attend an event or a session.

Basic Steps 1. 2. 3. 4. 5.

Determine the type and ID of the product for which you want validate the invitee Construct an array of InviteeIDs that need to be validated Optionally, specify if you want to check if the invitee has made full payment for the product Call ValidateInvitee, passing in the ProductID and array of InviteeIDs Process the results in the ValidateInviteeResultArray to verify whether the answers have been successfully validated.

General Syntax ValidateInviteeResultArray = cventapi.ValidateInvitee(ProductType, ProductID, CheckPaidInFull, CvObjectArray)

Input Name

Type

Description

ProductType

Enumerator type (Event/Session)

Indicates type of product (event or session).

ProductID

Indicates the session or event for which an invitee is being checked.

CheckPaidInFull

Boolean

If “True”, Cvent will check whether the invitee has made full payment for session or event. If “False”, payment information will not be checked.

CvObjectArray

Array of Invitee IDs that need to be checked.

Name

Type

Description

ReferenceId

String

MessageId input.

InviteeID

ID of Invitee that was validated.

Registered

Boolean

Indicates whether the invitee has registered (TRUE) or not (FALSE).

PaidInFull

Boolean

Indicates whether the invitee has made full payment (TRUE) or not (FALSE).

CheckedIn

Boolean

Indicates whether the invitee has been marked as participant (TRUE) or not (FALSE).

Success

Boolean

Indicates whether the action taken was successful (TRUE) or not (FALSE) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Page 46 of 155

Cvent Web Services API Version V200611 January 2015

2.3.9 SendEmail Usage Use SendEmail to send an email to one or more event invitees or survey respondents.

Basic Steps 1. 2.

3. 4.

Determine the ID of the activity (event, survey, or eMarketing campaign) for which you want to send an email for by calling the Search method. Determine the ID of the invitees or respondents that you wish to email. For example, you can call the Search method to retrieve the existing inviteeâ&#x20AC;&#x2122;s or respondentâ&#x20AC;&#x2122;s ID. If the invitee or respondent does not exist for the event or survey, call the TransferInvitee method to add the contact to the event or survey. Construct a CvObject array and populate it with the IDs of each invitee or respondent that you wish to email. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Create a SendEmaiRequest object and specify the activity type, activity ID, email template, and if the email should be sent to those who have already received this email template. If you are sending a custom email template, provide the name of the custom email in the EmailName parameter. Make the SendEmail call.

General Syntax SendEmailResultArray = cventapi.SendEmail(SendEmailRequest sendEmailReq)

Input Name

Type

Description

SendEmailRequest.ActivityType

Activity Type

The type of activity for which you would like to send an email, Event, Survey, or Campaign.

SendEmailRequest.ActivityId

The ID of the activity for which you want to send an email.

SendEmailRequest.CvObjects

CvObject Array

Array of one or more CvObject, which contains invitees or respondents IDs to be emailed, and optionally MessageIds which will be returned as ReferenceIds.

SendEmailRequest.EmailTemplate

Email Template

The email template to be processed.

SendEmailRequest.EmailName

String

The name of the custom email to be processed.

SendEmailRequest.ResendToPrev iousRecipients

Boolean

Indicates whether the SendEmail call should send the email to invitees or respondents that have previously received this email.

Output Name

Type

Description

ID of the invitee or respondent that you attempted to email.

ReferenceId

The MessageId value in the input CvObject.

Success

Boolean

Indicates whether the SendEmail call succeeded (True) or not (False) for this invitee or respondent. Success indicates the emails were successfully for delivery later.

Errors

Error Array

If an error occurred during the SendEmail call, an array of one or more Error objects providing the error code and description.

Notes Please take into account the following notes when using the SendEmail call:

Page 47 of 155

Cvent Web Services API Version V200611 January 2015

 Activity and Invitee/Respondent Association – The activity ID must match the event, survey, or campaign associated to the invitee or respondent. If the activity ID does not match, the email will not be sent to that invitee or respondent.  Targeted Lists Association – If an invitee or respondent is not associated with a targeted list, the default targeted list will be used.  Opt-Outs – Invitees or respondents that have opted-out of receiving emails will not be scheduled and returned for delivery.  Maximum Number of Emails Scheduled – You can schedule up to 200 individual emails in a single SendEmail call. If a SendEmail request exceeds 200 invitees or respondents, then the entire operation fails. If the event or survey is in test mode, the maximum number of emails that can be sent is 100.

Validation Rules The following validation rules should be applied to the SendEmail call:

Statuses

Email Templates

Uniqueness

Valid event statuses are testing, active, closed, and completed. Valid survey statuses are testing, active, and closed. If an invalid status is exists, the entire operation will fail. The following email templates are valid for events.  Invitation  CustomInviteeMessage  InvitationReminder  CustomUndecidedMessage  RegistrationConfirmation  EventReminder  CustomAttendeeMessage  ModificationConfirmation  CancellationConfirmation  Regret  CustomDeclinedMessage  PostEventFollowup  CustomAttendedMessage  ApprovalDenied  ApprovalPending  CustomEmail The following email templates are valid for surveys.  SurveyInvitation  SurveyCustomInviteeMessage  SurveyReminder  SurveyCustomNoResponseMessage  SurveyPartiallyCompleteMessage  SurveyCustomMessageToPartials  SurveyCompletionMessage  SurveyCustomMessageToRespondents  SurveyCustomEmail Based on ID, only the first instance of an invitee or respondent in the array be processed.

Page 48 of 155

Cvent Web Services API Version V200611 January 2015

2.4

Events 2.4.1 UpdateInviteeInternalInfo Usage Use UpdateInviteeInternalInfo to update or insert internal information answers and default-level internal information questions for one or more invitees within an event.

Basic Steps 1. 2.

Determine the ID of the event you want to update invitee internal information for. Construct an array of InviteeIds along with the question codes (internal info questions only) and answers you want to apply to each invitee. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateInviteeInternalInfo, passing in the EventId and array of invitees/questions/answers. Process the results in the UpdateInviteeInternalInfoResultArray to verify whether the answers have been successfully inserted.

4. 5.

General Syntax UpdateInviteeInternalInfoResultArray = cventapi.UpdateInviteeInternalInfo(EventId, CvAnswerArray Answers)

Input Name

Type

Description

EventId

Id of the event that is having its invitees updated.

Answers

CvAnswer Array

Array of InviteeIds, QuestionCodes, and Answers to be applied to each invitee.

Name

Type

Description

ID of the invitee record that the client attempted to update.

ReferenceId

The MessageId value input with the Invitee object instance.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the UpdateInviteeInternalInfo call:  Field Types – To update internal information, the question type must be one of the following: o

Choice – Single Answer (Vertical)

Choice – Single Answer (Horizontal)

Choice – Single Answer (Drop-Down)

Open Ended Text – One Line

Open Ended Text – Comment Box

Validation Rules The following validation rules should be applied to the UpdateInviteeInternalInfo call:

Uniqueness

InviteeId and QuestionCode constitute a composite key for the CvAnswer array. If a provided InviteeId and QuestionCode combination is not unique, the first CvAnswer instance will be processed. All others will fail.

Page 49 of 155

Cvent Web Services API Version V200611 January 2015

Referential Integrity Length Read-Only

The following relationships need to be valid to ensure database referential integrity:  EventId  InviteeId  QuestionCode The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 50 of 155

Cvent Web Services API Version V200611 January 2015

2.4.2 CreatePostEventFeedback Usage Use CreatePostEventFeedback to create or update answers to a post-event feedback survey in your Cvent account.

Basic Steps 1. 2.

3. 4.

5. 6.

Determine the ID of the event for which you want to create answers. Determine the IDs of the invitee that you wish insert answers on behalf of. For example, you can call the Search method to retrieve the existing invitee’s ID. If the invitee does not exist for the event, call the TransferInvitee method to add the contact to the event. Construct a CvAnswers array and populate it with the InviteeId, QuestionID, QuestionCode, and Answer for each answer that you want to insert. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Create a CreatePostEventFeedback object and specify the EventId. Make the CreatePostEventFeedback call.

General Syntax CreatePostEventFeedbackResultArray = cventapi. CreatePostEventFeedback (EventId, CvAnswerArray CvAnswers)

Input Name

Type

Description

EventId

ID of the Event

CvAnswers

CvAnswer Array

Array of one or more CvAnswer array containing InviteeId or GuestId, QuestionCodes, QuestionId and Answers to be applied to each invitee. A MessageId can also be included with each instance of the array.

Output Name

Type

Description

ID of invitee or guest record included in the create call.

ReferenceId

String

MessageId input for the CvAnswer object instance.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Notes Please take into account the following notes when using the CreatePostEventFeedback call:  Field Types – To update a post-event feedback survey, you must use one of the following question types: o

Choice – Single Answer (Vertical)

Choice – Single Answer (Horizontal)

Choice – Single Answer (Drop-Down)

Open Ended Text – One Line

Open Ended Text – Comment Box

Open Ended Text – Date/Time

Matrix – Single Answer Per Row

Matrix – Multiple Answers Per Row

Page 51 of 155

Cvent Web Services API Version V200611 January 2015

 Event Status – Event must be in Active or Completed status.  Permissions – Your client application must be logged in with sufficient access rights to create or update post-event feedback within the account.

Page 52 of 155

Cvent Web Services API Version V200611 January 2015

2.4.3 SimpleEventRegistration Usage Use SimpleEventRegistration to update an invitee record based on the provided action.

Basic Steps 1. 2. 3.

4. 5.

Determine the IDs of the invitees that you want to register. Construct an ID array and populate it with the IDs of each invitee record that you wish to register. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call SimpleEventRegistration, passing in the ID array, the action you wish to take on the invitees, and the event ID. Process the results in the SimpleEventRegistration object to verify whether the objects have been successfully registered.

General Syntax SimpleEventRegistrationResultArray = cventapi.SimpleEventRegistration (CvObjectArray CvObjects, RegistrationAction RegAction, ID EventId)

Input Name

Type

Description

CvObjects

CvObject Array

Array of one or more CvObject, which contains invitee IDs to be registered, and optionally MessageIds which will be returned as ReferenceIds.

RegAction

Registration Action

The action you are taking on the invitees. Valid actions are Register, Decline, Waitlist, and Cancel.

EventId

The ID of the event that you are registering the invitees for.

AdmissionItemId

The ID of the admission item.

Output Name

Type

Description

ID of the invitee that you attempted to register.

ReferenceId

The MessageId value in the input CvObject.

Success

Boolean

Indicates whether the SimpleEventRegistration call succeeded (True) or not (False) for this invitee.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Notes Please take into account the following notes when using the SimpleEventRegistration call:  Event Admission Items – The event associated with the invitee record must have no more than one admission item and no optional items or tracks. Sessions are allowed only if all sessions are included in the admission item.  Event and Invitee Association – The event ID must match the event associated to the invitees. If the event ID does not match the event associated to an invitee the registration for that invitee will fail.  Event Capacity – The IDs in the array will be processed the order they are listed. If the event capacity is reached, the records listed after the capacity has been exceeded will fail.

Page 53 of 155

Cvent Web Services API Version V200611 January 2015

 Event Fees – The event associated with the invitee record must be a free event and have no fees.  Event Status – The event associated with the invitee record must have a status of active or closed.  Event Travel – The event associated with the invitee record must have the travel feature turned off.  Maximum Number of Contacts Registered – Your can register up to 25 individual invitees in a single SimpleEventRegistration call. If a SimpleEventRegistration request exceeds 25 invitees, then the entire operation fails.  Event Registration Paths – The event associated with the invitee record must only have one registration path.

Validation Rules The following validation rules should be applied to the SimpleEventRegistration call:

Registration Actions

Valid actions are Register, Decline, Waitlist, and Cancel. For all actions, no survey questions will be answered and no contact fields will be updated.  For the Register action to succeed, the invitee must not have a status of accepted and the event must have available capacity. If the confirmation email is active, it will be sent to the invitee when the action succeeds.  Invitees will bypass the pending approval status and move directly to accepted, regardless of whether or not the approval process is enabled for the event.  For the Decline action to succeed, the invitee must not have a status of accepted or declined. If the declined email is active, it will be sent to the invitee when the action succeeds.  For the Waitlist action to succeed, the invitee must not have a status of accepted or waitlisted and the event must be closed and have the waitlist feature active.  For the Cancel action to succeed, the invitee must have a status of accepted. If the cancellation email is active, it will be sent to the invitee when the action succeeds.

Uniqueness

Based on ID, only the first instance of an invitee in the array will update the invitee record. All subsequent instances will return an error message.

Page 54 of 155

Cvent Web Services API Version V200611 January 2015

2.4.4 SessionRegAction Usage Use SessionRegAction to register or unregister invitees and/or guests based on the provided action.

Basic Steps 1. 2. 3.

Determine the ID of the product (session) for which you want to perform register or unregister invitee/guest. Construct an ID array and populate it with the IDs of each invitee and/or guest record that you wish to register o unregister. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call SessionRegAction by specifying the ID array, the action you wish to take on invitee and/or guest and the product ID.

General Syntax SessionRegActionResultArray = cventapi. SessionRegAction (CvObjectArray CvObjects, SessionRegActionType SessionRegAction, ID ProductId)

Input Name

Type

Description

ProductId

Session from which invitee(s) are getting registered or unregistered. Prod_stub for prod_type_id = 30 (sessions)

SessionRegActionType

The action you are taking on the invitees or Guests. Valid SessionRegActionType values are Register and Unregister.

InviteeId (CvObject Array)

Array of Invitee Id to perform an action on. No more than 200 in an array.

Name

Type

Description

Id of the Invitee to Register or Unregister

ReferenceId

String

MessageId input

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the SessionRegAction call:  Call Limit – Action can only be taken on up to 200 Invitee or Guest per call.  Visibility – API user must have visibility to Manage Invitee to make this call.  Invitee/Guest Status – Invitee or Guest must be in accepted status.  Event Status – Event must be in Test mode, Active, Closed, Completed status.

Validation Rules The following validation rules should be applied to the SimpleEventRegistration call: Registration Actions

Session must belong to an event that Invitee or Guest are registered for.

Page 55 of 155

Cvent Web Services API Version V200611 January 2015

2.4.5 CheckIn Usage Use CheckIn to mark one or more invitees as participants for an event.

Basic Steps Determine the IDs of the invitees that you want to check in. Note: To check in guests, use GuestId from the Registration object. 1. 2.

3. 4.

Construct an ID array and populate it with the IDs of each record that you wish to check in. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CheckIn, passing in the ID array. Process the results in the CheckInResultArray object to verify whether the objects have been successfully checked in.

General Syntax CheckInResultArray = cventapi.CheckIn(CvObjectArray CvObjects)

Input Name

Type

Description

CvObjects

CvObject Array

Array of one or more CvObject, which contains invitee IDs to be checked in, and optionally MessageIds which will be returned as ReferenceIds.

AttendeeType

AttendeeType Array

Indicates participant status for either an event or session.

ProductID

ProductID Array

Indicates the session for a participant to be marked.

UndoCheckIn

Boolean

Undoes the marking of a participant.

Output Name

Type

Description

ID of the invitee that you attempted to check in.

ReferenceId

The MessageId value in the input CvObject.

Success

Boolean

Indicates whether the CheckIn call succeeded (True) or not (False) for this invitee.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Notes Please take into account the following notes when using the CheckIn call:  Maximum Number of Contacts Checked In – You can check in up to 200 individual invitees in a single CheckIn call. If a CheckIn request exceeds 200 invitees, the entire operation fails.  Multiple Events – The invitees in the array can be from multiple events.

Validation Rules The following validation rules should be applied to the CheckIn call: Uniqueness

Based on ID, only the first instance of an invitee in the array will update the invitee record. All subsequent instances will return an error message.

Page 56 of 155

Cvent Web Services API Version V200611 January 2015

2.4.6 CreateNoRegEvent Usage Use CreateNoRegEvent to create an event with no online registration to your Cvent account.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more EventParameter objects. Construct an EventParameter array and populate the array with the events you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateNoRegEvent, passing in the EventParameter array. Process the results in the EventParameter array object to verify whether the event have been successfully created.

General Syntax GetUpdatedResultArray = cventapi.CreateNoRegEvent(EventParameterArray)

Input Name

Type

Description

EventParameters

CvObject Array

Array of one or more Events (up to 200) to create, and optionally MessageIds which will be returned as ReferenceIds.

Output Name

Type

Description

ID Array

Array of one or more Object IDs that have been updated or created in the given time span.

ReferenceId

The MessageId value in the input CvObject

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Notes The following EventParameter fields are required to create an event:  Title  Time Zone Code – Time zones are provided by the DescribeGlobal method. The value returned in the “ID” attribute should be provided in this field.  Start Date  Planner First Name  Planner Last Name

Page 57 of 155

Cvent Web Services API Version V200611 January 2015

2.4.7 CopyEvent Usage Use CopyEvent to create a new event by single copying one that already exists within your Cvent account.

Basic Steps 1. 2. 3. 4.

5. 6.

Determine the ID of the event that you want to copy. Create a single EventParameter object. Construct an EventParameter array and populate the array with the events you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CopyEvent, passing in the EventId and EventParameter array. Process the results in the EventParameter array object to verify whether the event have been successfully created.

General Syntax CopyEventResultArray = cventapi.CopyEvent(EventId, EventParameterArray)

Input Name

Type

Description

EventId

Id of the event that will be copied.

EventParameters

EventParameters Array

An array of event parameters (up to 200) from which to create new events.

Name

Type

Description

ID of the event that was created. If this field contains a value, then the action was successful. If this field is empty, then the event was not created and instead returned an error.

ReferenceId

String

MessageId input for the EventParameters object instance.

Success

Boolean

Indicates whether the call succeeded (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Output

Page 58 of 155

Cvent Web Services API Version V200611 January 2015

2.4.8

UpdateEventParameters

Usage Use UpdateEventParameters to update one or more existing events in your Cvent account. The update call is analogous to the UPDATE statement in SQL.

Basic Steps 1.

2. 3. 4.

5. 6.

Determine the ID of each event that you want to update. For example, you might call Search to retrieve a set of event IDs that you would want to update. If you store the Cvent IDs for your event records within your database, you can use these IDs to update the desired events. For each object, populate its fields with the data that you want to update. Note: To preserve an existing field value, pass the null value for that field. Construct an EventParameters array and populate that array with the event parameters that you want to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateEventParameters, passing in the EventParameters array. Process the results in the UpdateEventParametersResultArray object to verify whether the events have been successfully updated.

General Syntax UpdateEventParametersResultArray = cventapi.UpdateEventParameters (EventParametersArray)

Input Name

Type

Description

EventParameters

EventParameters Array

An array of up to 200 event parameters to be updated.

Output Name

Type

Description

ReferenceId

String

Message input for the EventParameters object instance.

Success

Boolean

Indicates whether the call succeeded or failed (true/false).

Errors

Error Array

If an error occurred during the update call, an array of one of more Error objects providing the error code and description.

Notes Timezone, State & Country codes are provided by the DescribeGlobal method. Use the corresponding codes returned in the “ID” attribute provided by the DescribeGloabl call. PlannerEmailAddress must come from a pre-defined list of available planner emails uploaded into the system.

Validations The following validation rules should be applied to the UpdateEventParameters call: Format and Pattern

The ID field should be a valid GUID data type. The following relationships need to be valid to ensure database referential integrity:

Referential Integrity

Length

   

TimeZoneCode StateCode CountryCode PlannerEmailAddress

The application will truncate data which exceeds the maximum length of a field.

Page 59 of 155

Cvent Web Services API Version V200611 January 2015

Read-Only

The application will ignore the value in the read-only fields.

2.4.9 CreateSession Usage Use CreateSession to add one or more sessions to your Cvent event. The CreateContact call is analogous to the INSERT statement in SQL.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual session objects. For each session object, you populate its fields with the data that you want to add. Construct a Session array and populate that array with the sessions that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateSession, passing in the Session array. Process the results in the CreateSessionResultArray object to verify whether the sessions have been successfully created.

General Syntax CreateSessionResultArray = cventapi.CreateSession (SessionArray)

Input Name

Type

Description

EventID

The ID of the Event where the session is to be created.

Session

SessionDetails Array

An array of up to 200 products (sessions) to be created. The ProductType does not need to be specified, but if supplied must = 30. Any other value for ProductType should return an error.

Output Name

Type

Description

ID of the Session that you attempted to create. Returned blank if creation was unsuccessful.

ReferenceId

String

MessageID value for the input.

Success

Boolean

Indicates whether the create call succeeded or failed (true/false).

Errors

Error Array

If an error occurred during the create call, an array of one of more Error objects providing the error code and description.

Validations The following validation rules should be applied to the CreateSession call: Format and Pattern

The ID field should be a valid GUID data type.

Referential Integrity

StartTime must be before EndTime.

Length Read-Only

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 60 of 155

Cvent Web Services API Version V200611 January 2015

2.4.10 UpdateSession Usage Use UpdateSession to update one or more existing sessions in your Cvent account. The update call is analogous to the UPDATE statement in SQL.

Basic Steps 1.

2. 3. 4.

5. 6.

Determine the ID of each session that you want to update. For example, you might call Search to retrieve a set of session IDs that you would want to update. If you store the Cvent IDs for your session records within your database, you can use these IDs to update the desired session. For each object, populate its fields with the data that you want to update. Note: To preserve an existing field value, pass the null value for that field. Construct a Session array and populate that array with the sessions that you want to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateSession, passing in the Session array. Process the results in the UpdateSessionResultArray object to verify whether the sessions have been successfully updated.

General Syntax UpdateSessionResultArray = cventapi.UpdateSession (SessionArray)

Input Name

Type

Description

EventID

The ID of the Event where the session is to be updated.

Session

SessionDetails Array

An array of up to 200 products (sessions) to be updated.

Name

Type

Description

ID of the Session that you attempted to update. If this field contains a value then the session was successfully updated. If blank then it was not updated.

ReferenceId

String

MessageID value for the input.

Success

Boolean

Indicates whether the update call succeeded or failed (true/false).

Errors

Error Array

If an error occurred during the update call, an array of one of more Error objects providing the error code and description.

Output

Validations The following validation rules should be applied to the UpdateSession call: Format and Pattern

The ID field should be a valid GUID data type.

Referential Integrity

StartTime must be before EndTime.

Length Read-Only

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 61 of 155

Cvent Web Services API Version V200611 January 2015

2.4.11 CreateTransaction Usage Use CreateTransaction to insert offline payments for one or more registrants within an event. The CreateTransaction call is analogous to the INSERT statement in SQL.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual transaction objects. For each transaction object, you populate its fields with the data that you want to add. Construct a Transaction array and populate that array with the transactions that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateTransaction, passing in the transaction array and the ID of the event. Process the results in the CreateTransactionResultArray object to verify whether the transactions have been successfully created.

General Syntax CreateTransactionResultArray = cventapi.CreateTransaction (EventId, TransactionArray)

Input Name

Type

Description

EventId

The ID of the event.

Transactions

CVObjectArray

Array of one or more instances (up to 200) to create, and optionally MessageIds which will be returned as ReferenceIds.

Name

Type

Description

ID of the transaction that you attempted to create. If this field contains a value, then the transaction was created successfully. If this field is empty, then the transaction was not created and the Cvent Web service returned error information instead.

ReferenceId

The MessageId value in the input CvObject

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object.

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the CreateTransaction call:  PaidInFull – If the PaidInFull Boolean for a given transaction is set to True, Cvent will automatically calculate the payment amount based on the amount due and effectively set the registrant’s balance due to zero. If false, the transaction amount must be distributed to individual products.  Transaction Types – Valid transaction types for this method include “Offline Charge” and “Offline Refund”.  Event Status – This method can only be used with events in one of the following statuses: Active, Closed, Completed, and Cancelled.  Invitee Status – This method can only be used for invitees in one of the following statuses: Accepted and Cancelled.

Page 62 of 155

Cvent Web Services API Version V200611 January 2015

2.4.12 CreateBudgetItem Usage Use CreateBudgetItem to create or update a budget item in an event.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual BudgetItem objects. For each Budget Item object, you populate its fields with the data that you want to add. Construct a BudgetItem array and populate that array with the budget Item that you want to create or update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateBudgetItem, passing in the Budget Item array. Process the results in the CreateBudgetItemResultArray object to verify whether the BudgetItem have been successfully created or updated.

General Syntax CreateBudgetItemResultArray = cventapi.CreateBudgetItem (BudgetItems)

Input Name

Type

Description

BudgetItem

BudgetItem Array

Array of one or more budget items (up to 200) to be created or updated, and optionally MessageIds which will be returned as ReferenceIds.

Output Name

Type

Description

ID of the budget item that was created or updated. If this field contains a value, then the budget item was successfully created or updated. If this field is empty, then the budget item was not created or updated and instead returned an error.

ReferenceId

The MessageId value in the input CvObject

Success

Boolean

Indicates whether the upsert call succeeded (True) or not (False) for the object instance.

NewBudgetItem

Boolean

Indicates whether the upsert call resulted in a new BudgetItem (True) or updated an existing BudgetItem (False).

Errors

Error Array

If an error occurred during the upsert call, an array of one or more one Error objects providing the error code and description.

Notes Please take into account the following notes when using the CreateTransaction call:  Budget Feature – This must be turned on at the event level in order to make this call.  Default Budget Version – Newly created Budget Item will apply to default budget version.  Budget Policy – Budget Policies do not apply when BudgetItems are created with this call.

Page 63 of 155

Cvent Web Services API Version V200611 January 2015

2.4.13 DeleteBudgetItem Usage Use DeleteBudgetItem to delete a budget item from an event.

Basic Steps 1. 2. 3.

4. 5.

Determine the ID of the BudgetItems you want to delete. Construct a CvObject array and populate it with the IDs of each user that you want to delete. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call DeleteBudgetItem, passing in the ID array. Process the results in the DeleteBudgetItemResultArray object to verify whether the objects have been successfully deleted.

General Syntax DeleteBudgetItemResultArray = cventapi.DeleteBudgetItem(CvObjectArray CvObjects)

Input Name

Type

Description

CvObject Array

Array

Array of one or more ID to delete. No more than 200 in an array. A MessageId can also be included with each instance of the array.

Name

Type

Description

GUID

ID specified with the call.

ReferenceId

String

MessageId input

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Page 64 of 155

Cvent Web Services API Version V200611 January 2015

2.5

Meeting Request Forms 2.5.1 CreateMeetingRequest Usage Use CreateMeetingRequest to add one or more meeting requests to your Cvent account. The CreateContact call is analogous to the INSERT statement in SQL.

Basic Steps 1.

Create an instance of one or more individual meeting request objects. For each meeting request object, you populate its fields with the data that you want to add. Construct a MeetingRequest array and populate that array with the meeting requests that you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateMeetingRequest, passing in the MeetingRequest array. Process the results in the CreateMeetingRequestResultArray object to verify whether the meeting requests have been successfully created.

2. 3.

4. 5.

General Syntax CreateMeetingRequestResultArray = cventapi.CreateMeetingRequest (MeetingRequestArray)

Input Name

Type

Description

RequesterId

ID of the user, used for applying visibility of the resulting Meeting Request Form.

MeetingRequestParameter

CvObject Array

Array of one or more Meeting Requests to create. Optional MessageIDs, returned as ReferenceIDs.

Output Name

Type

Description

ID Array

RequestCode of the Meeting Request that was created. If this field contains a value, then the action was successful. If the field is empty, then the Meeting Request was not created and instead returned an error.

ReferenceId

The MessageID value in the input CvObject.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object).

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Notes Timezone, State & Country codes are provided by the DescribeGlobal method. Use the corresponding codes returned in the “ID” attribute provided by the DescribeGloabl call.

Validations The following validation rules should be applied to the CreateMeetingRequest call: Format and Pattern

The ID field should be a valid GUID data type. The following relationships need to be valid to ensure database referential integrity:

Referential Integrity

     

RequesterStateCode RequesterCountryCode EventStateCode EventCountryCode StakeholderStateCode StakeholderCountryCode

Page 65 of 155

Cvent Web Services API Version V200611 January 2015

Length Read-Only

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 66 of 155

Cvent Web Services API Version V200611 January 2015

2.5.2 UpdateMeetingRequest Usage Use UpdateMeetingRequest to update one or more existing meeting requests in your Cvent account. The update call is analogous to the UPDATE statement in SQL.

Basic Steps 1.

2. 3. 4.

5. 6.

Determine the ID of each meeting request that you want to update. For example, you might call Search to retrieve a set of meeting request IDs that you would want to update. If you store the Cvent IDs for your meeting request records within your database, you can use these IDs to update the desired meeting requests. For each object, populate its fields with the data that you want to update. Note: To preserve an existing field value, pass the null value for that field. Construct a MeetingRequest array and populate that array with the meeting requests that you want to update. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call UpdateMeetingRequest, passing in the MeetingRequest array. Process the results in the UpdateMeetingRequestResultArray object to verify whether the meeting requests have been successfully updated.

General Syntax UpdateMeetingRequestResultArray = cventapi.UpdateMeetingRequest (MeetingRequestArray)

Input Name

Type

Description

MeetingRequestParameter

Meeting Request Array

Array of one or more MRs to be updated, and optionally MessageIds which will be returned as ReferenceIDs.

Output Name

Type

Description

ID Array

ID of the Meeting Request that was updated. If this field contains a value, then the Meeting Request was successfully updated. If this field is empty, then the Meeting Request was not updated and instead returned an error.

ReferenceId

The MessageID value in the input CvObject.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for this object).

Errors

Error Array

If an error occurred during the create call, an array of one or more Error objects providing the error code and description.

Notes Timezone, State & Country codes are provided by the DescribeGlobal method. Use the corresponding codes returned in the “ID” attribute provided by the DescribeGloabl call.

Validations The following validation rules should be applied to the UpdateMeetingRequest call: General

The UpdateMeetingRequest method shall update Meeting Request by input MeetingRequestId.

Format and Pattern

The ID field should be a valid GUID data type.

Referential Integrity

The following relationships need to be valid to ensure database referential integrity:



RequesterStateCode

Page 67 of 155

Cvent Web Services API Version V200611 January 2015

     Length Read-Only

RequesterCountryCode EventStateCode EventCountryCode StakeholderStateCode StakeholderCountryCode

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 68 of 155

Cvent Web Services API Version V200611 January 2015

2.6

Survey 2.6.1 CreateSurveyAnswer Usage Use CreateSurveyAnswer to insert one or more answers on behalf of your survey respondents.

Basic Steps 1. 2.

Determine the ID of the survey for which you want to create answers. Determine the IDs of the respondents that you wish insert answers on behalf of. For example, you can call the Search method to retrieve the existing respondent’s ID. If the respondent does not exist for the survey, call the TransferInvitee method to add the contact to the survey. Construct a CvAnswers array and populate it with the RespondentId, QuestionID, QuestionCode, and Answer for each answer that you want to insert. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Create a CreateSurveyAnswer object and specify the survey ID and status to which you want each respondent set. Make the CreateSurveyAnswer call.

3. 4.

5. 6.

General Syntax CreateSurveyAnswerResultArray = cventapi.CreateSurveyAnswer(SurveyId, SetStatus, CvAnswerArray CvAnswers)

Input Name

Type

Description

SurveyId

Id of the survey

SetStatus

String

The status to which each respondent will be set, Partial or Complete.

CvAnswers

CvAnswer Array

Array of RespondentIds, QuestionsIDs, QuestionCodes, and Answers to be applied to each respondent. A MessageId can also be included with each instance of the array.

Output Name

Type

Description

Id of respondent record included in the create call.

ReferenceId

String

MessageId input for the CvAnswer object instance.

Success

Boolean

Indicates whether the create call succeeded (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Notes Please take into account the following notes when using the CreateSurveyAnswer call:  Existing Answers – If the respondent already has a store answer for the question, we will replace the answer with the value provided in the API call.  Question Types – To create survey answers, the question type must be one of the following: Question Type

Format

Choice – Single Answer (Horizontal)

Choice – Single Answer (Vertical)

Open Ended Text – Date/Time

DateTime

Page 69 of 155

Cvent Web Services API Version V200611 January 2015

Matrix – Single Answers Per Row

<CategoryName>:<Choice>;…

Matrix – Multiple Answers Per Row

<CategoryName>:<Choice1>:<Choice2>;…

Matrix – Spreadsheet

<CategoryName>:<Choice>:<Value>;…

Matrix – Side-by-Side

<CategoryName>:<Left/Right SideHeader>:<Choice>;…

Data List

<Choice>:<Value>;…

Rank Order

<Choice>:<Value>;…

Number Allocation – Constant Sum

<Choice>:<Value>;…

Net Promoter

 Limited Answers – Regardless of the number of respondents in the CreateSurvey Answer call, you are limited to 200 answers.

Validation Rules The following validation rules should be applied to the CreateSurveyAnswer call: Statuses

Rules

Valid survey statuses are testing, active and closed. If Survey = Multi-Response and Ticketing is On, then all RespondentIDs in the CvAnswers array should have a TransactionID (Response ID) associated with in Cvent. If False, skip record and throw an error “Transaction ID not found for respondent”

Uniqueness

A TransactionID given for a particular contact needs to be unique for the mentioned survey ID. 

Respondent Statuses

  

If partial status, all respondents with at least one successful CvAnswer instance will be set to ‘Partial Response.’ If complete status, all respondents with at least one successful CvAnswer instance will be set to ‘Complete Response.’ If no status or an unrecognized status is provided, all respondents with at least one CvAnswer instance will be set to ‘Partial Response.’ If an invalid status exists, the entire operation will fail.

Page 70 of 155

Cvent Web Services API Version V200611 January 2015

2.7

Supplier Network 2.7.1 CreateRFP Usage Use CreateRFP to create a new RFP to add to your Cvent account.

Basic Steps 1. 2. 3.

4. 5.

Determine the ID of the user that will be used for applying visibility to the new RFP. Construct an RFPParameter array and populate the array with the RFPs you want to create. Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateRFP, passing in the RFPParameter array. Process the results in the RFPParameter array object to verify whether the event have been successfully created.

General Syntax GetUpdatedResultArray = cventapi.CreateRFP(RFPParameterArray RFPParameters)

Input Name

Type

Description

UserId

Id of the user that used for applying visibility to the resulting RFP.

RFPParameters

RFPParameters Array

An array of RFP parameters (up to 200) from which to create new RFPs.

Name

Type

Description

ID of the RFP that was created. If this field contains a value, then the action was successful. If this field is empty, then the RFP was not created and instead returned an error.

Code

String

RFPCode of the RFP that was created. If this field contains a value, then the action was successful. If this field is empty, then the RFP was not created and instead returned an error.

ReferenceId

String

MessageId input for the RFPParameters object instance.

Success

Boolean

Indicates whether the call succeeded (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred during the update call, an array of one or more Error objects providing the error code and description.

Output

Notes Please take into account the following notes when using the CreateRFP call:  Required Fields – The following RFPParameter fields are required: RFPTypeID and RFPName  RFP Status – All RFPs created through this method will be set to ‘Draft’ status.

Page 71 of 155

Cvent Web Services API Version V200611 January 2015

2.8

eMarketing 2.8.1 CreateDistributionList Usage Use CreateDistributionList to add one or more eMarketing distribution lists to your Cvent account data. The CreateDistributionList call is analogous to the INSERT statement in SQL.

Basic Steps 1. 2. 3.

4. 5.

Create an instance of one or more individual distribution list objects Construct a DistributionList array and populate that array with the distribution lists that you want to create Optionally, specify the MessageID if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call CreateDistributionList, passing in the DistributionList array. Process the results in the CreateDistributionListResultArray object to verify whether the transactions have been successfully created.

General Syntax CreateDistributionListResultArray = cventapi.CreateDistributionList(DistributionListArray)

Input Name

Type

Description

Distribution Lists

Distribution List Array

Array of DistributionList objects that need to be created.

Output Name

Type

Description

Id of the distribution list that will be created.

ReferenceId

MessageId input.

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Validation Rules The following validation rules should be applied to the CreateDistributionList call: Length Read-Only

The application will truncate data which exceeds the maximum length of a field. The application will ignore the value in the read-only fields.

Page 72 of 155

Cvent Web Services API Version V200611 January 2015

2.8.2 ManageDistributionListMembers Usage Use ManageDistributionListMembers to manage distribution list members based on the provided action.

Basic Steps 1.

2. 3.

Determine the IDs of the contacts you want to update. For example, you might call Search to retrieve a set of Contact IDs that you would want to update. If you store the Cvent IDs for your contact records within your database, you can use these IDs to update the desired contacts Construct an ID array and populate it with the IDs of each contact record that you wish to update Optionally, specify the MessageId if you want to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes. Call ManageDistributionListMembers, passing the distribution list ID, the action you want to take on the contacts, and the contact group ID. Note: The “Remove” action removes contacts from the list and does not delete the distribution list itself. Process the results in the ManageDistributionListMembersResultArray object to verify whether the transactions have been successfully created.

General Syntax ManageDistributionListMembersResultArray = cventapi.ManageDistributionListMembers(ID, Action, CvObjectArray)

Input Name

Type

Description

Id of the distribution list.

Action

Manage DistributionList action

The action that is going to be performed on the contracts. Valid actions Add, Add as Pending, and Remove.

CvObjectArray

CvObject Array

Array of Contact IDs that need to be added or removed from list.

Name

Type

Description

Id of the distribution list that will be updated.

ReferenceId

String

MessageId input.

Success

Boolean

Indicates whether the action taken was successful (True) or not (False) for the object instance.

Errors

Error Array

If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description.

Output

Validation Rules The following validation rules should be applied to the ManageDistributionList call:

Actions

Valid actions are Add, Add as Pending, and Remove.  For the Add action to succeed, the contact must not already be a member of the specified contact group.  For the Add as Pending action to succeed, the contact must not already by a member of the specified contact group.  For the Remove action to succeed, the contact must already be a member of the specified contact group.

Uniqueness

Based on ID, only the first instance of a contact in the array will update the contact record. All subsequent instances will return an error message.

Page 73 of 155

Cvent Web Services API Version V200611 January 2015

3.0

Object Definitions 3.1

Overview

The following objects are available.

3.1.1

API Core Objects

Object

Description

CvSearchObject

Parent object of Cvent data objects. Used in Search method.

CvObject

Parent object of Cvent data objects.

3.1.2

Cvent Objects

Cvent Data Contact

Event

Survey

eMarketing

Suppliers

RFPs

Object

Description

Contact

Represents an individual associated with your accountâ&#x20AC;&#x2122;s address book.

ContactGroup

Represents a group of contacts within your account.

Event

Represents an event associated with your account.

EventParameters

Represents the fields associated with an event.

EventDetails

Represents the details associated with an event.

Invitee

Represents a specific invitee associated with an event.

Registration

Represents the registration details associated with a specific event invitee, including items registered for, survey answers, etc.

Guest

Represents a specific guest associated with an event.

EventEmailHistory

Represents the email history details associated with a specific event invitee and a specific email.

Transaction

Represents a monetary transaction associated with a specific invitee/contact.

Travel

Represents the housing and travel details associated with a specific event invitee.

Budget

Represents the overall budget for an event.

BudgetItem

Represents the items in an event budget.

EventQuestion

Represents questions in your event.

Survey

Represents a survey associated with your account.

Respondent

Represents a specific respondent associated with a survey.

Response

Represents answer details associated with a specific respondent.

SurveyEmailHistory

Represents email history details associated with a specific survey respondent and specific email.

Campaign

Represents the details associated with a campaign.

Distribution List

Represents the details associated with a distribution list.

EMarketingEmailHistory

Represents email history in your eMarketing account.

RFP

Represents an RFP created in your account.

Proposal

Represents a proposal for an RFP created in your account.

Supplier

Represents venue/service details for suppliers that have been awarded business within your account.

SupplierRFP

Represents an RFP received in your account.

SupplierProposal

Represents a proposal for an RFP created in your account.

Page 74 of 155

Cvent Web Services API Version V200611 January 2015

Administration

User

Represents an individual user within your account.

Meeting Request User

Represents a specific meeting request user within your account.

Approver

Represents a specific approver within your account.

User Group

Represents a group of users within your account.

User Role

Represents a specific user role within your account.

Page 75 of 155

Cvent Web Services API Version V200611 January 2015

3.2

Contact Objects

The following contact objects are available.

3.2.1

Contact

The following are the fields associated with the Contact object and the properties of these fields. Field Name

Type

Read-Only

Searchable

SourceId

String

FirstName

String

LastName

String

EmailAddress

String

CCEmailAddress

String

Company

String

Title

String

ContactType

String

ContactTypeCode

String

Salutation

String

Nickname

String

MiddleName

String

Designation

String

Active â&#x2C6;&#x17E;

Boolean

ExcludedFromEmail

Boolean

LastOptOutDate

DateTime

LastOptOutBy

String

OptedIn

Boolean

ImageURL

String

CreatedDate *

DateTime

CreatedBy

String

LastModifiedDate *

DateTime

LastModifiedBy

String

EmailAddressStatus

String

LogDate

DateTime

LogReason

String

LogResponse

String

PrimaryAddressType

String

HomeAddress1

String

HomeAddress2

String

HomeAddress3

String

HomeCity

String

HomeState

String

HomeStateCode

String

HomePostalCode

String

HomeCountry

String

HomeCountryCode

String

X X

X X X

X X

Page 76 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

HomePhone

String

HomeFax

String

WorkAddress1

String

WorkAddress2

String

WorkAddress3

String

WorkCity

String

WorkState

String

WorkStateCode

String

WorkPostalCode

String

WorkCountry

String

WorkCountryCode

String

WorkPhone

String

WorkFax

String

MobilePhone

String

Pager

String

SMTPCode

String

JoinDate

DateTime

ExpirationDate

DateTime

LastRenewalDate

DateTime

FacebookURL

String

TwitterURL

String

LinkedInURL

String

Gender

String

DateOfBirth

Datetime

SocialSecurityNumber*

String

NationalIdentificationNumber*

String

PassportNumber*

String

PassportCountry

String

PassportCountryCode

String

ActivityId

GUID

ParentContactId

GUID

FieldId

GUID

FieldType

String

FieldName

String

FieldValue

String

GroupId

GUID

GroupName

String

X X

CustomFieldDetail

ContactGroupDetail

DistributionListDetail ID

Page 77 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

DistributionListName

String

Approved

Boolean

⁪

Searchable X

Required Default search value = true Used in GetUpdated call

∞ * 

Read-Only

To search on a custom field, the field parameter in the CvSearchObject must match the following format and include the custom field ID: “CustomContactField:<FieldId>”

3.2.2

ContactGroup

The following are the fields associated with the ContactGroup object and the properties of these fields. Field Name

Type

Name

String

GroupType

String

ShortDescription

String

Read-Only

Searchable X

Page 78 of 155

Cvent Web Services API Version V200611 January 2015

3.3

Administration Objects

The following Administration objects are available.

3.3.1

User

The following are the fields associated with the User object and the properties of these fields. Field Name

Type

Username

String

Read-Only

FederatedId

String

UserType

String

UserRole

String

UserRoleId

GUID

Active

Boolean

Password†

String

ChangePasswordOnLogin†

Boolean

Prefix

String

FirstName

String

LastName

String

Company

String

Title

String

WorkPhone

String

HomePhone

String

MobilePhone

String

WorkFax

String

HomeFax

String

Pager

String

Address1

String

Address2

String

Address3

String

City

String

State

String

StateCode

String

PostalCode

String

Country

String

CountryCode

String

AllEventVisibility

Boolean

AllSurveyVisibility

Boolean

AllRFPVisibility

Boolean

DefaultContactGroupId

GUID

CreatedDate

DateTime

CreatedBy

String

LastModifiedDate*

DateTime

LastModifiedBy

String

Searchable

X X

UserGroupDetail

Page 79 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

UserGroupName

String

UserGroupId

GUID

Read-Only

Searchable

VisibilityDefaults VisibilityType

String

UserGroupName

String

UserGroupId

GUID

* â&#x20AC;

Used in GetUpdated call Passwords can only be created and updated, not retrieved

Page 80 of 155

Cvent Web Services API Version V200611 January 2015

3.3.2

MeetingRequestUser

The following are the fields associated with the MeetingRequestUser object and the properties of these fields. Field Name

Type

Username

String

Read-Only

FederatedId

String

UserType

String

UserRole

String

UserRoleId

GUID

Active

Boolean

Password †

String

ChangePasswordOnLogin †

Boolean

Prefix

String

FirstName

String

LastName

String

Company

String

Title

String

WorkPhone

String

HomePhone

String

MobilePhone

String

WorkFax

String

HomeFax

String

Pager

String

Address1

String

Address2

String

Address3

String

City

String

State

String

StateCode

String

PostalCode

String

Country

String

CountryCode

String

AllEventVisibility

Boolean

AllSurveyVisibility

Boolean

AllRFPVisibility

Boolean

DefaultContactGroupId

GUID

CreatedDate

DateTime

CreatedBy

String

LastModifiedDate *

DateTime

LastModifiedBy

String

UserGroupName

String

UserGroupId

GUID

Searchable

X X

UserGroupDetail

Page 81 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

VisibilityDefaults VisibilityType

String

UserGroupName

String

* 3.3.3

Used in GetUpdated call

Approver

The following are the fields associated with the Approver object and the properties of these fields. Field Name

Type

ApproverCategoryID

GUID

ApproverCategory

String

RequestorSourceValue

String

ApproverEmail

String

3.3.4

Read-Only

Searchable

UserGroup

The following are the fields associated with the UserGroup object and the properties of these fields. Since there are no update or create calls for the UserGroup object, all fields are considered readonly. Field Name

Type

UserGroupName

String

InternalNote

String

3.3.5

Read-Only

Searchable

UserRole

The following are the fields associated with the UserRole object and the properties of these fields. Since there are no update or create calls for the UserRole object, all fields are considered read-only. Field Name

Type

UserRoleName

String

Read-Only X

Searchable X

Description

String

UserRightName

String

UserRightCategory

String

AccessLevel

String

UserRights

Page 82 of 155

Cvent Web Services API Version V200611 January 2015

3.3.6

MeetingRequest

The following are the fields associated with the MeetingRequestUser object and the properties of these fields. Field Name

Type

GUID

Read-Only

RequestName

String

RequestStatus

String

RequestCode

String

FormId

GUID

FormName

String

FormDescription

String

FormInternalNote

String

RequesterId

GUID

RequesterFirstName

String

RequesterLastName

String

RequesterEmailAddress

String

RequesterTitle

String

RequesterCompany

String

RequesterWorkPhone

String

RequesterHomePhone

String

RequesterWorkFax

String

RequesterMobilePhone

String

RequesterAddress1

String

RequesterAddress2

String

RequesterAddress3

String

RequesterCity

String

RequesterState

String

RequesterStateCode

String

RequesterPostalCode

String

RequesterCountry

String

RequesterCountryCode

String

Archived

Boolean

ArchiveDate

DateTime

CreatedBy

String

CreatedDate

DateTime

LastModifiedBy

String

LastModifiedDate*

DateTime

EventRequestInfo EventTitle

String

EventCategory

String

EventDescription

String

EventInternalNote

String

EventLocation

String

EventAddress1

String

Page 83 of 155

Cvent Web Services API Version V200611 January 2015

EventAddress2

String

EventAddress3

String

EventCity

String

EventState

String

EventStateCode

String

EventPostalCode

String

EventCountry

String

EventCountryCode

String

EventPhone

String

EventStartDate

DateTime

EventEndDate

DateTime

EventRSVPDate

DateTime

EventTimeZone

String

EventTimeZoneId

Integer

EventCapacity

Integer

EstimateAccomodation

Money

EstimateCreativeAndDesign

Money

EstimateEventProduction

Money

EstimateFoodAndBeverage

Money

EstimateGroundTransport

Money

EstimateHotelAndVenueMisc

Money

EstimateManagementFees

Money

EstimateMerchandiseAndGifts

Money

EstimateMiscellaneous

Money

EstimatePrintAndWebsites

Money

EstimateRoomRental

Money

EstimateSetupAndEquipment

Money

EstimateSiteInspection

Money

EstimateSpecialEvents

Money

EstimateTravel

Money

StakeholderFirstName

String

StakeholderLastName

String

StakeholderEmailAddress

String

StakeholderTitle

String

StakeholderCompany

String

StakeholderWorkPhone

String

StakeholderHomePhone

String

StakeholderWorkFax

String

StakeholderMobilePhone

String

StakeholderAddress1

String

StakeholderAddress2

String

StakeholderAddress3

String

StakeholderCity

String

StakeholderState

String

Page 84 of 155

Cvent Web Services API Version V200611 January 2015

StakeholderStateCode

String

StakeholderPostalCode

String

StakeholderCountry

String

StakeholderCountryCode

String

MaximumEventCapacity

Integer

NumberCancelledRegistrants

Integer

NumberDeclinedRegistrants

Integer

NumberParticipants

Integer

NumberRegisteredAttendees

Integer

NumberInvited

Integer

RFPRequestInfo ExpectedAttendees

Integer

AlternateStartDate1

DateTime

AlternateEndDate1

DateTime

AlternateDate1Note

String

AlternateStartDate1

DateTime

AlternateEndDate1

DateTime

AlternateDate1Note

String

TotalMeetingSpace

String

LargestMeetingRoom

String

BusinessObjectives

String

DestinationsUnderConsideration

String

BudgetedRoomRate

Money

SleepRoomAdditionalInfo

String

TotalMeetingRoomsNeeded

Integer

MeetingRoomAdditionalInfo

String

ConcessionAndContractual

String

DecisionDate

DateTime

ResponseDueDate

DateTime

AVNeeds

String

CustomFieldDetail FieldId

GUID

FieldName

String

FieldType

String

FieldValue

String

DocumentDetail FileName

String

FileType

String

FileSize

Integer

UploadDate

DateTime

FileURL

String

EventSurveyDetail SurveyType

String

QuestionId

GUID

Page 85 of 155

Cvent Web Services API Version V200611 January 2015

QuestionCode

String

QuestionText

String

AnswerDetail AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

* 3.3.7

Used in GetUpdated call

ConversionRate

The following are the fields associated with the ConversionRate object and the properties of these fields. Field Name

Type

ConversionRateId

GUID

BaseCurrencyName

String

BaseCurrencyCode

String

CurrencyName

String

CurrencyCode

String

ConversionRate

Decimal

Current

Boolean

StartDate

DateTime

EndDate

DateTime

CreatedDate

DateTime

LastModifiedDate *

DateTime

Read-Only

Searchable

X X

Used in GetUpdated call

Page 86 of 155

Cvent Web Services API Version V200611 January 2015

3.3.8

CustomField Object

The following are the fields associated with the ConversionRate object and the properties of these fields. Field Name

Type

GUID

FieldName

String

FieldCode

String

HelpText

String

FieldType

String

FieldChoices

Array

AnswerFormat

int

MinimumCharacters

int

MaximumCharacters

int

MinimumNumber

int

MaximumNumber

int

PrepopulateCurrentDate

Boolean

EarliestDate

DateTime

LatestDate

DateTime

DIsplayPopUpCalendar

Boolean

3.3.9

Read-Only X

Searchable X

AdvancedLogic

The following are the fields associated with the ConversionRate object and the properties of these fields. Field Name

Type

GUID

SourceField

GUID

AdvancedLogicChoices

Array

Read-Only

Searchable

Page 87 of 155

Cvent Web Services API Version V200611 January 2015

3.4

Event

The following event objects are available.

3.4.1

Event

The following are the fields associated with the Event object and the properties of these fields. Since there are no update or create calls for the Event object, all fields are considered read-only. Field Name

Type

EventCode

String

Read-Only X

Searchable X

EventTitle

String

EventStartDate

DateTime

EventEndDate

DateTime

EventLaunchDate

DateTime

Timezone

String

EventDescription

String

InternalNote

String

EventStatus

String

PlanningStatus

String

Capacity=

Integer

Category

String

MeetingRequestId

GUID

Currency

String

Hidden â&#x20AC;Ą

Boolean

Location

String

StreetAddress1

String

StreetAddress2

String

StreetAddress3

String

City

String

State

String

StateCode

String

PostalCode

String

Country

String

CountryCode

String

PhoneNumber

String

PlannerFirstName

String

PlannerLastName

String

PlannerEmailAddress

String

RSVPbyDate

DateTime

ArchiveDate

DateTime

ClosedBy

String

ExternalAuthentication

Boolean

LastModifiedDate *

DateTime

FieldId

GUID

FieldType

String

CustomFieldDetail

Page 88 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

FieldName

String

FieldValue

String

ProductId

GUID

ProductName

String

ProductCode

String

ProductType

String

ProductDescription

String

IsIncluded

Boolean

StartTime

DateTime

EndTime

DateTime

Status

String

Capacity=

Integer

FieldId

GUID

FieldName

String

FieldType

String

FieldValue

String

ProductID

GUID

ProductName

String

ProductCode

String

ProductType

String

StartTime

String

EndTime

String

DataTagCode

String

ProductDescription

String

RegistrantInformation

String

Status

Boolean

AutoCloseDate

Date

Capacity=

Integer

EnableWaitlist

Boolean

WaitlistCapacity

Integer

ProductDetail

CustomFieldDetail

SessionDetail ~

CustomFieldDetail

FieldId

GUID

FieldName

String

FieldType

String

FieldValue

String

WeblinkDetail Target

String

URL

String

Answer

Page 89 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

FileName

String

FileType

String

FileSize

Integer

UploadDate

DateTime

FileURL

String

TargetedListId

GUID

TargetedListName

String

TargetedListLanguage

String

TargetedListDefault

Boolean

Searchable

DocumentDetail

TargetedListDetail

* ‡ ~ = 

Used in GetUpdated call Default search value = false SessionDetails If capacity equals negative one, it is unlimited To search on a custom field, the field parameter in the CvSearchObject must match the following format and include the custom field ID: “CustomEventField:<FieldId>”

Page 90 of 155

Cvent Web Services API Version V200611 January 2015

3.4.2

EventParameters

The following are the fields associated with the EventParameters object and the properties of these fields. Note: This object cannot be Retrieved as a standalone object. Field Name

Type

Title

String

Description

String

Capacity

Integer

LocationName

String

Address1

String

Address2

String

Address3

String

City

String

StateCode

String

PostalCode

String

CountryCode

String

Phone

String

TimeZoneCode

String

StartDate

DateTime

EndDate

DateTime

PlannerFirstName

String

PlannerLastName

String

PlannerEmailAddress

String

RSVPByDate

DateTime

Language

String

Category

String

Internal Note

String

Publish Date

DateTime

Archive Date

DateTime

PlannerPrefix

String

PlannerCompany

String

PlannerTitle

String

StakeholderFirstName

String

StakeholderLastName

String

StakeholderEmailAddress

String

StakeholderTitle

String

StakeholderCompany

String

StakeholderWorkPhone

String

StakeholderHomePhone

String

StakeholderWorkFax

String

StakeholderMobilePhone

String

StakeholderAddress1

String

StakeholderAddress2

String

Read-Only

Searchable

Page 91 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

StakeholderAddress3

String

StakeholderCity

String

StakeholderState

String

StakeholderStateCode

String

StakeholderPostalCode

String

StakeholderCountry

String

StakeholderCountryCode

String

Read-Only

Searchable

CustomFieldDetail FieldID

GUID

FieldType

String

FieldName

String

FieldValue

String

Page 92 of 155

Cvent Web Services API Version V200611 January 2015

3.4.3

EventDetails

The following are the fields associated with the EventDetails object and the properties of these fields. Field Name

Type

GUID

Read-Only X

EventCode

String

EventTitle

String

EventDescription

String

EventStatus

String

EventSummaryHeader

String

PlanningStatus

String

RequestID

GUID

RequestName

String

RequestStatus

String

RequestCode

String

RequesterFirstName

String

RequesterLastName

String

RequesterID

GUID

RequestSubmittedDate

DateTime

OldStatus

String

NewStatus

String

ActionDate

DateTime

ModifiedBy

String

Comments

String

GUID

Name

String

Status

String

SubmittedBy

String

SubmittedDate

DateTime

LastModifiedBy

String

LastModifiedDate

DateTime

AssigneeID

GUID

AssigneeFirstName

String

AssigneeLastName

String

AssigneeEmailAddress

String

AssignedRole

String

AssignedBy

String

AssignedDate

DateTime

EmailComments

String

PlanningStatusHistory

ProcessFormDetail

EventRoleDetail

FAQDetail Question

Page 93 of 155

Cvent Web Services API Version V200611 January 2015

Answer

String

Sequence

Integer

Language

String

Active

Boolean

StaffFirstName

String

StaffLastName

String

StaffRole

String

StaffEmailAddress

String

DisplayOnWebsite

Boolean

StaffAddress1

String

StaffAddress2

String

StaffAddress3

String

StaffCity

String

StaffState

String

StaffStateCode

String

StaffPostalCode

String

StaffCountry

String

StaffCountryCode

String

FeeID

GUID

FeeName

String

FeeAmount*

Money

ProductID

GUID

ProductName

String

Active

Boolean

CreatedDate

Date/Time

LastModifiedDate

Date/Time

GLName

String

GLDescription

String

GLCode

GUID

GLID

GUID

StaffDetail

Fees

Page 94 of 155

Cvent Web Services API Version V200611 January 2015

3.4.4

Invitee

The following are the fields associated with the Invitee object and the properties of these fields. Since there are no update or create calls for the Invitee object, all fields are considered read-only. Field Name

Type

ContactId

GUID

Read-Only X

Searchable X

SourceId

String

FirstName

String

LastName

String

Company

String

Title

String

EmailAddress

String

CCEmailAddress

String

WorkPhone

String

Participant

Boolean

EventId

GUID

EventCode

String

EventTitle

String

EventStartDate

DateTime

Status

String

InternalNote

String

OriginalResponseDate

DateTime

LastModifiedDate *

DateTime

ConfirmationNumber

String

ReferenceId

String

LastModifiedDate

DateTime

TargetedListId

GUID

TargetedListName

String

VoucherCode

String

Target

String

URL

String

QuestionText

String

AnswerText

String

SurveyType

String

QuestionId

GUID

QuestionCode

String

QuestionText

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

WeblinkDetail

InternalInfoDetail

RegretSurveyDetail

Answer

Page 95 of 155

Cvent Web Services API Version V200611 January 2015

AnswerComment

3.4.5

String

Used in GetUpdated call

Registration

The following are the fields associated with the Registration object and the properties of these fields. Since there are no update or create calls for the Registration object, all fields are considered readonly. Note: Travel data is not contained in this object. Field Name

Type

ContactId

GUID

Read-Only X

Searchable X

InviteeId

GUID

SourceId

String

FirstName

String

LastName

String

Company

String

Title

String

EmailAddress

String

CCEmailAddress

String

WorkPhone

String

EventId

GUID

EventCode

String

EventTitle

String

EventStartDate

DateTime

Status

String

GroupLeader

Boolean

GroupId

String

Participant

Boolean

Credit

Integer

InternalNote

String

InvitedBy

String

RegistrationDate *

DateTime

CancelledDate *

DateTime

OriginalResponseDate

DateTime

LastModifiedDate *

DateTime

ModifiedBy

String

ResponseMethod

String

ConfirmationNumber

String

RegistrationType

String

RegistrationTypeCode

String

TargetedListId

GUID

TargetedListName

String

ReferenceId

String

SurveyDetail

Page 96 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

SurveyType

String

QuestionId

GUID

QuestionCode

String

QuestionText

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

AnswerText â&#x2014;&#x2039;

String

GuestId

GUID

FirstName

String

MiddleName

String

LastName

String

Company

String

Title

String

Phone

String

EmailAddress

String

Address1

String

Address2

String

Address3

String

City

String

State

String

StateCode

String

PostalCode

String

Country

String

CountryCode

String

RegistrationType

String

RegistrationTypeCode

String

Participant

Boolean

ConfirmationNumber

String

SurveyType

String

QuestionId

GUID

QuestionCode

String

QuestionText

String

AnswerText

String

OrderDetailItemId

GUID

OrderDetailId

GUID

OrderNumber

String

Searchable

Answer

GuestDetail

SurveyDetail

OrderDetail

Page 97 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

FirstName

String

LastName

String

ProductId

GUID

ProductName

String

ProductCode

String

ProductType

String

Quantity

Integer

ProductDescription

String

StartTime

DateTime

EndTime

DateTime

Action

String

ActionDate

String

Amount

Money

AmountPaid

Money

AmountDue

Money

Participant

Boolean

DiscountDetailId

GUID

DiscountCode

String

DiscountName

String

DiscountType

String

DiscountValue

String

DiscountAmount

Money

TransactionId

GUID

TransactionNumber

String

TransactionDate

DateTime

TransactionType

String

ReferenceNumber

String

Online

Boolean

Amount

Money

Searchable

DiscountDetail

PaymentDetail

* ○



Used in GetUpdated call The AnswerText array is being depreciated and will be phased out in 2012. Use the Answer subarrary instead. The question types “Matrix – Multiple Answers per Row” and “Matrix – Single Answers per Row” are not supported by the AnswerText array. To search guest confirmation, the field name must match the guest confirmation number.

Page 98 of 155

Cvent Web Services API Version V200611 January 2015

3.4.6

Guest

The following are the fields associated with the Guest object and the properties of these fields. Since there are no update or create calls for the Guest object, all fields are considered read-only. Field Name

Type

ContactId

GUID

Read-Only X

Searchable X

EventID

GUID

Event Title

String

Event Code

GUID

GuestConfirmationNumber

GUID

RegistrationID

GUID

FirstName

String

MiddleName

String

LastName

String

Nickname

String

Gender

String

DateOfBirth

DateTime

SocialSecurityNumber*

String

NationalIdentificationNumber*

String

PassportNumber*

String

PassportCountry

String

Company

String

Designation

String

Title

String

Phone

String

Mobile

String

CCEmail

String

Address1

String

Address2

String

Address3

String

City

String

State

String

RegistrationDate

DateTime

CreatedDate

DateTime

CreatedBy

DateTime

LastModifiedDate

DateTime

LastModifiedBy

DateTime

LastOptOutDate

DateTime

OptedOut

Boolean

Participant

Boolean

Status

Enum

FieldID

GUID

FieldName

String

CustomFieldDetail

Page 99 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

FieldType

String

FieldValue

String

3.4.7

Read-Only

Searchable

EventEmailHistory

The following are the fields associated with the EventEmailHistory object and the properties of these fields. Since there are no update or create calls for the EventEmailHistory object, all fields are considered read-only. Field Name

Type

EventId

GUID

InviteeId

GUID

ContactId

GUID

TargetList

String

EmailSentDate

DateTime

EmailStatus

String

EmailType

String

FromEmailAddress

String

ToEmailAddress

String

EmailViewed

Boolean

EmailBounced

Boolean

LastModifiedDate *

DateTime

3.4.8

Read-Only

Searchable

Used in GetUpdated call

Transaction

The following are the fields associated with the Transaction object and the properties of these fields. Since there are no update or create calls for the Transaction object, all fields are considered readonly. Field Name

Type

Read-Only

Searchable

ContactId

GUID

InviteeId

GUID

SourceId

String

FirstName

String

LastName

String

Company

String

Title

String

EmailAddress

String

WorkPhone

String

EventId

GUID

EventCode

String

EventTitle

String

EventStartDate

DateTime

TransactionType

String

Success â&#x2C6;&#x17E;

Boolean

X X

Page 100 of 155

Cvent Web Services API Version V200611 January 2015

TransactionNumber

String

PaymentType

String

NameOnCard

String

ReferenceNumber

String

BatchNumber

String

Amount

Money

PaidInFull **

Boolean

TransactionDate *

DateTime

Note

String

LastModifiedDate *

DateTime

ModifiedBy

String

ProductId

GUID

ProductName

String

ProductCode

String

ProductType

String

OrderNumber

String

OrderPrice

Money

AmountApplied

Money

GLCode

String

GLDescription

String

X X

DistributionDetail

** â&#x2C6;&#x17E; *

Used only in CreateOfflinePayment call. Default search value = true Used in GetUpdated call

Page 101 of 155

Cvent Web Services API Version V200611 January 2015

3.4.9

Travel

The following are the fields associated with the Travel object and the properties of these fields. Since there are no update or create calls for the Travel object, all fields are considered read-only. Field Name

Type

ContactId

GUID

Read-Only X

SourceId

String

FirstName

String

LastName

String

Company

String

Title

String

EmailAddress

String

CCEmailAddress

String

EventId

GUID

EventCode

String

EventTitle

String

EventStartDate

DateTime

Status

String

RegistrationType

String

RequesterId

GUID

RequesterType

String

RequesterFirstName

String

RequesterLastName

String

HotelName

String

HotelCode

String

RoomName

String

RoomCode

String

Quantity

Integer

RoommateRequest

String

SpecialNeeds

String

RewardsCode

String

CheckinDate

DateTime

CheckoutDate

DateTime

Smoking

Boolean

Cancelled

Boolean

Handicap

Boolean

Status

String

ConfirmationNumber

String

ShareRoom

Boolean

RoommateLeader

Boolean

Gender

String

TotalAmount

Money

CurrencyCode

String

RoomCharge

Boolean

Searchable X

HotelRequest

Page 102 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

RoomTaxBillingInstructions

String

IncidentalBillingInstructions

String

LastModifiedDate

String

HotelModifiedDate

DateTime

PlannerMemo

String

EarliestShoulderDate

Date

LatestShoulderDate

Date

HotelRoomRate

String

RoomTaxBillingExceptions

String

IncidentalBillingExceptions

String

HotelAddress1

String

HotelAddress2

String

HotelAddress3

String

HotelCity

String

HotelState

String

HotelPostalCode

String

HotelCountry

String

SurveyType

String

QuestionId

GUID

QuestionCode

String

QuestionText

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

RequestId

String

RequesterId

GUID

RequesterType

String

RequesterFirstName

String

RequesterLastName

String

PickUpDate

String

PickUpTime

DateTime

DropOffDate

DateTime

DropOffTime

String

RentalCarType

String

RentalCompany

String

RewardsCode

String

Cancelled

Boolean

Searchable

SurveyDetail

Answer

CarRequest

Page 103 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Status

String

ConfirmationNumber

String

LastModifiedBy

String

CarLastModifiedDate

DateTime

SurveyType

String

QuestionId

GUID

QuestionCode

String

QuestionText

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

RequesterId

GUID

RequesterType

String

RequesterFirstName

String

RequesterSuffix

String

RequesterMiddleName

String

RequesterLastName

String

RedressNumber

String

KnownTravelerNumber

String

Leg1Origin

String

Leg1Destination

String

Leg1Date

DateTime

Leg1Time

String

Leg2Origin

String

Leg2Destination

String

Leg2Date

DateTime

Leg2Time

String

TicketType

String

SeatType

String

MealText

String

OtherText

String

RewardsCode1

String

RewardsCode2

String

RewardsCode3

String

AirlinePreference1

String

AirlinePreference2

String

AirlinePreference3

String

AgeCategory

String

Searchable

SurveyDetail

Answer

AirRequest

Page 104 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Cancelled

Boolean

Status

String

PlannerMemo

String

FullName

String

Gender

String

DateOfBirth

String

LastModifiedBy

String

AirRequestLastModifiedDate

DateTime

SurveyType

String

QuestionId

GUID

QuestionCode

String

QuestionText

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

RequesterId

GUID

RequesterType

String

Name

String

ConfirmationNumber

String

TotalAmount

Money

CurrencyCode

String

Note

String

GDSRecordLocator

String

GDSNote

String

LastModifiedBy

String

AirActualLastModifiedDate

DateTime

Airline

String

FlightNumber

String

Origin

String

OriginCode

String

Destination

String

DestinationCode

String

Departing

DateTime

Arriving

DateTime

SeatNumber

String

Searchable

SurveyDetail

Answer

AirActual

FlightDetail

Page 105 of 155

Cvent Web Services API Version V200611 January 2015

3.4.10 Budget The following are the fields associated with the Budget object and the properties of these fields. Since there are no update or create calls for the Budget object, all fields are considered read-only. Field Name

Type

EventCode

String

Read-Only X

Searchable X

EventTitle

String

DefaultTax

Money

DefaultTaxType

String

DefaultTax2

Decimal

DefaultTax2Type

String

DefaultTax3

Decimal

DefaultTax3Type

String

DefaultTax4

Decimal

DefaultTax4Type

String

DefaultTax5

Decimal

DefaultTax5Type

String

DefaultGratuity

Money

DefaultGratuityType

String

ModifiedBy

String

LastModifiedDate

DateTime

CategoryName

String

HighLevelEstimate

Money

AmountDetailId

GUID

AmountName

String

Amount

Money

CategoryDetail

AmountDetail

Page 106 of 155

Cvent Web Services API Version V200611 January 2015

3.4.11 BudgetItem The following are the fields associated with the Budget object and the properties of these fields. Since there are no update or create calls for the Budget object, all fields are considered read-only. Field Name

Type

ItemName

String

Read-Only X

Searchable X

ItemCode

String

ItemType

String

EventId

GUID

EventCode

String

RFPId

String

RFPCode

String

CategoryName

String

SubcategoryId

GUID

SubcategoryName

String

Status

String

ProductId

GUID

ProductName

String

VendorType

String

VendorId

GUID

VendorName

String

GLName

String

GLCode

String

Currency

String

CurrencyCode

String

ConversionRate

Decimal

TaxOnGratutity

Boolean

CostAvoidance

Money

AvoidanceDescription

String

InternalNote

String

ItemDate

DateTime

LastModifiedDate *

DateTime

CostDetailId

GUID

CostName

String

Units

Integer

Cost

Money

Tax

Money

TaxType

String

Tax2

Decimal

Tax2Type

String

Tax3

Decimal

Tax3Type

String

Tax4

Decimal

Tax4Type

String

CostDetail

Page 107 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

Tax5

Decimal

Tax5Type

String

Gratuity

Money

GratuityType

String

SavingsDetailId

GUID

SavingsName

String

Amount

Money

PaymentDetailId

GUID

PaymentName

String

PaymentType

String

PaymentDate

DateTime

Amount

Money

ReferenceNumber

String

Currency

String

CurrencyCode

String

AllocationCategoryID

GUID

AllocationCategoryName

String

AllocationSubCategoryID

GUID

AllocationSubCategoryName

String

AllocationPercentage

Percentage

FirstName

String

LastName

String

InviteeID

GUID

ContactID

GUID

SavingsDetail

BudgetPaymentDetail

AllocationCategoryDetail

AssociatedRegistrants

Used in GetUpdated call

Page 108 of 155

Cvent Web Services API Version V200611 January 2015

3.4.12 EventQuestion The following are the fields associated with the EventQuestion object and the properties of these fields. Since there are no update or create calls for the EventQuestion object, all fields are considered read-only. Field Name

Type

Read-Only

Searchable

GUID

QuestionText

String

QuestionCode

String

SurveyType

String

QuestionType

String

EventId

GUID

EventCode

String

EventTitle

String

ProductName

String

ProductId

GUID

InternalNote

String

AllowOther

Boolean

OtherLabel

String

LastModifiedDate *

DateTime

String

AnswerDetail AnswerText RowDetail RowText

Used in GetUpdated call

3.4.13 Appointment The following are the fields associated with the Appointment object and the properties of these fields. Since there are no update or create calls for the Appointment object, all fields are considered read-only. Field Name

Type

AppointmentID

GUID

Read-Only X

EventId

GUID

AppointmentTitle

String

AppointmentDescription

String

AppointmentStatus

Enum

AppointmentType

Enum

AppointmentLocation

String

StartDate

DateTime

EndDate

DateTime

CreatedDate

DateTime

CreatedBy

String

LastModifiedDate

DateTime

LastModifiedBy

String

Searchable X

Page 109 of 155

Cvent Web Services API Version V200611 January 2015

3.4.14 AppointmentAttendee The following are the fields associated with the Attendee object and the properties of these fields. Since there are no update or create calls for the Attendee object, all fields are considered read-only. Field Name

Type

EntityID

GUID

Read-Only X

EntityType

Enum

AppointmentID

GUID

IsOrganizer

Boolean

AppointmentAttendeeStatus

Enum

AppointmentAttendeeNote

String

CreatedDate

DateTime

CreatedBy

String

LastModifiedDate

DateTime

LastModifiedBy

String

Searchable X

3.4.15 Speaker The following are the fields associated with the Speaker object and the properties of these fields. Since there are no update or create calls for the Speaker object, all fields are considered read-only. Field Name

Type

SpeakerId

Read-Only X

Searchable

FirstName

String

LastName

String

EmailAddress

String

Prefix

String

Designation

String

Company

String

Title

String

SpeakerCode

String

EventId

GUID

EventTitle

String

EventCode

String

FacebookURL

String

LinkedInURL

String

TwitterURL

String

CategoryId

GUID

Category

String

DisplayOnWebsite

Boolean

ProfileImageURL

String

Biography

String

InternalNote

String

CreatedDate

Datetime

CreatedBy

String

LastModifiedDate

Datetime

LastModifiedBy

String

Page 110 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

DocumentDetail FileName

String

FileType

String

FileSize

Integer

UploadDate

Datetime

FileDisplay

Boolean

FileURL

String

LinkName

String

LinkURL

String

DisplayLink

Boolean

SessionId

GUID

SessionName

String

SessionStartDate

DateTime

SessionEndDate

DateTime

RelatedWebsitesDetail

AssignedSessions X

3.4.16 TableAssignment The following are the fields associated with the TableAssignment object and the properties of these fields. Since there are no update or create calls for the TableAssignment object, all fields are considered read-only. Field Name

Type

TableId

GUID

TableName

String

SeatingId

GUID

SeatingCode

String

SeatingName

String

EventId

GUID

EventTitle

String

EntityId

GUID

EntityType

String

SeatName

String

FirstName

String

LastName

String

Company

String

LastModifiedDate *

DateTime

Read-Only

Searchable

X X

Used in GetUpdated call

Page 111 of 155

Cvent Web Services API Version V200611 January 2015

3.5

Survey Objects

The following survey objects are available.

3.5.1

Survey

The following are the fields associated with the Survey object and the properties of these fields. Since there are no update or create calls for the Survey object, all fields are considered read-only. Field Name

Type

Read-Only

Searchable

SurveyCode

String

SurveyTitle

String

EventCloseDate

DateTime

EventLaunchDate *

DateTime

Description

String

SurveyStatus

String

InternalNote

String

PlannerFirstName

String

PlannerLastName

String

Target

String

URL

String

FieldID

GUID

FieldType

String

FieldName

String

FieldValue

String

TargetedListId

GUID

TargetedListName

String

TargetedListLanguage

String

TargetedListDefault

Boolean

WeblinkDetail

CustomFieldDetail

TargetedListDetail

Used in GetUpdated call

Page 112 of 155

Cvent Web Services API Version V200611 January 2015

3.5.2

Respondent

The following are the fields associated with the Respondent object and the properties of these fields. Since there are no update or create calls for the Respondent object, all fields are read-only. Field Name

Type

ContactId

GUID

Read-Only X

SourceId

String

TransactionID

String

FirstName

String

LastName

String

Company

String

Title

String

EmailAddress

String

WorkPhone

String

SurveyId

GUID

SurveyCode

String

SurveyTitle

String

SurveyLaunchDate

DateTime

Status

String

InternalNote

String

ReferenceId

String

ResponseScore

Decimal

TargetedListId

GUID

TargetedListName

String

Target

String

URL

String

Searchable X

WeblinkDetail

Page 113 of 155

Cvent Web Services API Version V200611 January 2015

3.5.3

Response

The following are the fields associated with the Response object and the properties of these fields. Since there are no update or create calls for the Response object, all fields are considered readonly. Field Name

Type

Read-Only

Searchable

ContactId

GUID

SourceId

String

TransactionID

String

FirstName

String

LastName

String

Company

String

Title

String

EmailAddress

String

WorkPhone

String

SurveyId

GUID

SurveyCode

String

SurveyTitle

String

SurveyLaunchDate

DateTime

Status

String

InternalNote

String

ReferenceId

String

InvitedBy

String

CompletionDate *

DateTime

LastModifiedDate *

DateTime

ModifiedBy

String

ResponseMethod

String

ResponseNumber

String

QuestionText

String

QuestionExportValue

String

QuestionType

String

QuestionScore

Decimal

QuestionCode

String

QuestionNumber

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerExportValue

String

AnswerComment

String

SurveyDetail

Answer

Used in GetUpdated call

Page 114 of 155

Cvent Web Services API Version V200611 January 2015

3.5.4

SurveyEmailHistory

The following are the fields associated with the SurveyEmailHistory object and the properties of these fields. Since there are no update or create calls for the SurveyEmailHistory object, all fields are considered read-only. Field Name

Type

GUID

SurveyId

GUID

RespondentId

GUID

ContactId

GUID

TargetList

String

EmailSentDate

DateTime

EmailStatus

String

EmailType

String

FromEmailAddress

String

ToEmailAddress

String

EmailViewed

Boolean

EmailBounced

Boolean

LastModifiedDate *

DateTime

Read-Only

Searchable

Used in GetUpdated call

Page 115 of 155

Cvent Web Services API Version V200611 January 2015

3.5.5

SurveyQuestion

The following are the fields associated with the SurveyQuestion object and the properties of these fields. Since there are no update or create calls for the SurveyQuestion object, all fields are considered read-only. Field Name

Type

Read-Only

GUID

QuestionText

String

QuestionHTMLText

String

QuestionCode

String

QuestionType

String

SurveyID

GUID

SurveyCode

String

SurveyTitle

String

QuestionNumber

String

IsRequired

Boolean

AllowOther

Boolean

MinimumSelections

String

MaximumSelections

String

MinimumCharacters

String

MaximumCharacters

String

AllowNA

Boolean

AnswerFormat

String

LeftSideHeader

String

RightSideHeader

String

Searchable X

Used in GetUpdated call

Page 116 of 155

Cvent Web Services API Version V200611 January 2015

3.6

eMarketing Objects

The following eMarketing objects are available.

3.6.1

Campaign

The following are the fields associated with the Campaign object and the properties of these fields. Since there are no update or create calls for the Campaign, all fields are considered read-only. Field Name

Type

Read-Only

Searchable

GUID

CampaignCode

GUID

CampaignName

String

Active

Boolean

FromFirstName

String

FromLastName

String

FromEmailAddress

String

InternalNote

String

FieldID

GUID

FieldName

String

FieldType

String

FieldValue

String

CustomFieldDetail

Page 117 of 155

Cvent Web Services API Version V200611 January 2015

3.6.2

Distribution List

The following are the fields associated with the DistributionList object and the properties of these fields. Since there are no update or create calls for the DistributionList, all fields are considered read-only. Field Name

Type

GUID

DistributionListName

String

Active

Boolean

Description

String

Internal Note

String

SecurityType

Enum

3.6.3

Read-Only

Searchable

X X

EMarketingEmailHistory

The following are the fields associated with the EMarketingEmailHistory object and the properties of these fields. Since there are no update or create calls for the EMarketingEmailHistory, all fields are considered read-only. Field Name

Type

Read-Only

GUID

Searchable

CampaignCode

GUID

CampaignName

String

Active

Boolean

FromFirstName

String

FromLastName

String

FromEmailAddress

String

InternalNote

String

FieldID

GUID

FieldName

String

FieldType

String

FieldValue

String

CustomFieldDetail

Page 118 of 155

Cvent Web Services API Version V200611 January 2015

3.7

RFP Objects

The following RFP objects are available.

3.7.1

RFP

The RFP object is for planner side only. The following are the fields associated with the RFP object and the properties of these fields. Since there are no update or create calls for the UserRole object, all fields are considered read-only. Field Name

Type

RFPType

String

Read-Only X

Searchable

QuickRFP

Boolean

FlexibleDates

Boolean

RFPStatus

String

RFPCode

String

RFPName

String

EventId

GUID

EventCode

String

EventTitle

String

ResponseDueDate

DateTime

DecisionDate

DateTime

AwardedDate

DateTime

CancelledDate

DateTime

CancelReason

String

CancelReasonComments

String

MultiAwarded

Boolean

Currency

String

RFPDescription

String

DecisionFactors

String

Commissionable

Boolean

CommissionRate

Integer

InternalNote

String

ReceivePackageRatesResponse

Boolean

EmployeesRange

String

AverageAttendeesPerEventRange

String

AverageRoomNightsPerEventRange

String

TotalAttendeesPerYearRange

String

TotalRoomNightsPerYearRange

String

CreatedDate

DateTime

Archived

Boolean

CreatedBy

String

LastModifiedDate *

DateTime

LastModifiedBy

String

CityWideFlag

Boolean

AcceptRebates

Boolean

Rebate

Integer

X X

Page 119 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

RebateType

String

EventName

String

EventType

String

ReferenceNumber

String

EventStartDate

DateTime

EventEndDate

DateTime

AlternateStartDate1

DateTime

AlternateEndDate1

DateTime

AlternateStartDate2

DateTime

AlternateEndDate2

DateTime

TotalAttendees

Integer

TotalBudget

Money

TotalMeetingSpace

Integer

LargestMeetingRoom

Integer

ContractSignatureLocation

String

BusinessObjectives

String

DestinationsUnderConsideration

String

AdditionalInformation

String

Concessions

String

BillingInformation

String

DayNumber

Integer

StartDate

DateTime

EndDate

DateTime

Notes

String

VenueName

String

City

String

State

String

StateCode

String

Date

String

Attendees

Integer

RoomBlock

Integer

RoomPickup

Integer

FoodAndBeverageSpend

Money

EventHistoryNote

String

Organization

String

OrganizationType

String

OrganizationAddress1

String

OrganizationAddress2

String

OrganizationAddress3

String

Searchable

EventInfo X

Alternate Dates

EventHistoryDetail

OrganizationInfo X

Page 120 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

OrganizationCity

String

OrganizationState

String

OrganizationStateCode

String

OrganizationPostalCode

String

OrganizationCountry

String

OrganizationCountryCode

String

Employees

Integer

EventsPerYear

Integer

SingleDayEvents

String

MultiDayEvents

String

AverageAttendeesPerEvent

Integer

AverageRoomNightsPerEvent

Integer

TotalAttendeesPerYear

Integer

TotalRoomNightsPerYear

Integer

OrganizationInformation

String

KeyContactFirstName

String

KeyContactLastName

String

KeyContactTitle

String

KeyContactEmailAddress

String

KeyContactPhone

String

KeyContactFax

String

KeyContactMobilePhone

String

KeyContactOrganization

String

KeyContactOrganizationWebsite

String

KeyContactAddress1

String

KeyContactAddress2

String

KeyContactAddress3

String

KeyContactCity

String

KeyContactState

String

KeyContactStateCode

String

KeyContactPostalCode

String

KeyContactCountry

String

KeyContactCountryCode

String

KeyContactAdditionalInformation

String

FoodAndBeverageBudget

Money

TotalMeetingRooms

Integer

MeetingRoomSizeType

String

MeetingRoomAdditionalInformation

String

AmenityAdditionalInformation

String

Integer

Searchable

KeyContactInfo

EventRequirementsInfo

MeetingRoomDetail DayNumber

Page 121 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

StartTime

DateTime

EndTime

DateTime

AgendaItem

String

AgendaItemType

String

SetupType

String

RoomSize

Integer

NumberOfPeople

Integer

TwentyFourHourHold

Boolean

MeetingRoomNote

String

LocatedAtHostHotelOrConventionCenter

Boolean

CheckInDate

DateTime

BudgetedRoomRate

Money

SleepRoomAdditionalInformation

String

DayNumber

Integer

Date

DateTime

AnyRoomQuantity

Integer

SingleRoomQuantity

Integer

DoubleRoomQuantity

Integer

SuiteQuantity

Integer

SleepRoomNote

String

StaffRoomQuantity

Integer

RoomType

String

Occupancy

String

FileName

String

FileType

String

FileSize

Integer

UploadedDate

DateTime

FileURL

String

QuestionId

GUID

QuestionType

String

QuestionText

String

DinnerStartDate

DateTime

DinnerEndDate

DateTime

DinnerAttendees

Integer

DinnerFoodAndBeverage

Money

DinnerContractSignatureLocation

String

DinnerAdditionalInformation

String

Searchable

SleepRoomInfo

SleepRoomDetail

OccupancyPerRoomDetail

AttachmentDetail

QuestionDetail

DinnerInfo

Page 122 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

DinnerPrivateRoom

Boolean

DinnerAVRequirements

String

DinnerAlcoholPolicy

String

DinnerSpecialNeeds

String

ProposalId

GUID

VenueID

GUID

VenueName

String

VenueCode

String

VenueType

String

VenueCity

String

VenueMMA

String

VenueBrand

String

VenueChain

String

Preferred

Boolean

MainPhone

String

SalesPhone

String

Status

String

RFPSentDate

DateTime

RFPLastSentDate

DateTime

RFPViewedDate

DateTime

RFPLastViewedDate

DateTime

BidReceivedDate

DateTime

SupplierDetail

DateTime

ResponseReason

LastestResponseDate

String

ResponseReasonComment

String

InternalNote

String

UserId

GUID

Username

String

FirstName

String

LastName

String

UserGroupId

GUID

UserGroupName

String

FieldID

GUID

FieldName

String

FieldType

String

FieldValue

String

UserVisibilityDetail

UserGroupVisibilityDetail

CustomFieldDetail

Used in GetUpdated call

Page 123 of 155

Cvent Web Services API Version V200611 January 2015

3.7.2

Proposal

The Proposal object is for planner side only. The following are the fields associated with the Proposal object and the properties of these fields. Field Name

Type

RFPId

GUID

Read-Only X

Searchable X

RFPType

String

RFPStatus

String

RFPCode

String

RFPName

String

ProposalStatus

String

ProposalSentDate

DateTime

Commissionable

Boolean

NotesRecommendations

String

CommissionRate

Integer

InternalNote

String

CreatedDate

DateTime

CreatedBy

String

LastModifiedDate *

DateTime

LastModifiedBy

String

VenueName

String

VenueCode

String

VenueType

String

VenueDescription

String

VenuePhone

String

VenueAddress1

String

VenueAddress2

String

VenueCity

String

VenueState

String

VenueStateCode

String

VenuePostalCode

String

VenueCountry

String

VenueCountryCode

String

VenueMMA

String

VenueBrand

String

VenueChain

String

EventStartDate

DateTime

EventEndDate

DateTime

Availability

String

Currency

String

EstimatedTotalCost

Money

AdditionalInformation

String

AlternateStartDate1

DateTime

VenueInfo

EventInfo

Page 124 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

AlternateEndDate1

DateTime

AlternateSleepRoomRate1

String

AlternateAdditionalInformation1

String

AlternateStartDate2

DateTime

AlternateEndDate2

DateTime

AlternateSleepRoomRate2

String

AlternateAdditionalInformation2

String

ConcessionAdditionalInformation

String

IncludedRebates

Boolean

Rebate

Integer

RebateType

String

RebatesIncentive

String

RoomRateConfirmed

Boolean

ConfirmationContingencies

String

MaxYearlyIncrease

Integer

RoomRateInfo

String

UnionInfo

String

ContractorInfo

String

KeyContactFirstName

String

KeyContactLastName

String

KeyContactTitle

String

KeyContactEmailAddress

String

KeyContactPhone

String

KeyContactFax

String

KeyContactMobilePhone

String

KeyContactOrganization

String

KeyContactOrganizationWebsite

String

KeyContactAddress1

String

KeyContactAddress2

String

KeyContactAddress3

String

KeyContactCity

String

KeyContactState

String

KeyContactStateCode

String

KeyContactPostalCode

String

KeyContactCountry

String

KeyContactCountryCode

String

KeyContactAdditionalInformation

String

CheckInDate

DateTime

SleepRoomNeedsMet

Boolean

SleepRoomNeedsMetAdditionalIno

String

Searchable

ConventionCenterInfo

KeyContactInfo

SleepRoomInfo

Page 125 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

FeeAdditionalInformation

String

DayNumber

Integer

Date

DateTime

AnyRoomQuantity

Integer

AnyRoomRate

Money

SingleRoomQuantity

Integer

SingleRoomRate

Money

DoubleRoomQuantity

Integer

DoubleRoomRate

Money

SuiteQuantity

Integer

SuiteRate

Money

SleepRoomNote

String

StaffRoomQuantity

Integer

StaffRoomRate

Money

RoomName

String

RoomSize

Integer

CeilingHeight

Integer

TwentyFourHourHold

Boolean

MoveInDate

DateTime

MoveInRate

Money

MoveInRateType

String

MoveOutDate

DateTime

MoveOutRate

Money

MoveOutRateType

String

EventStartDate

DateTime

EventEndDate

DateTime

EventRate

Money

EventRateType

String

Note

String

Category

String

Type

String

Value

Decimal

MeetingRoomNeedsMet

Boolean

MeetingRoomNeedsMetAdditionalInfo

String

TotalFoodAndBeverageMinimum

Money

FAndBMinimumNote

String

ApplicableTax

Integer

ServiceCharge

Integer

MeetingRoomAdditionalInformation

String

Searchable

SleepRoomAvailabilityDetail

EventSpace

AdditionalFeeDetail

EventRequirementsInfo

Page 126 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

AmenityAdditionalInformation

String

RoomSizeUnitOfMeasure

String

CeilingHeightUnitOfMeasure

String

DayNumber

Integer

StartTime

DateTime

EndTime

DateTime

AgendaItem

String

AgendaItemType

String

SetupType

String

RoomName

String

CeilingHeight

Decimal

RoomSize

Integer

NumberOfPeople

Integer

TwentyFourHourHold

Boolean

Note

String

DateType

String

StartDate

DateTime

EndDate

DateTime

Availability

String

SleepRoomRate

String

AdditionalInformation

String

Amount

Money

Quantity

Integer

Type

String

TaxOrServiceCharge

String

Note

String

FileName

String

FileType

String

FileSize

Integer

UploadedDate

DateTime

FileURL

String

Date

DateTime

Package

String

Occupancy

String

RoomType

String

PricePerDay

Integer

PackagePricingNote

String

Searchable

MeetingRoomAvailabilityDetail

AlternateSleepRoomAvailabilityDetails

ProposalEstimatedCostDetail

AttachmentDetail

PackagePricing

ContractInfo

Page 127 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Contracted

Boolean

EventStartDate

DateTime

EventEndDate

DateTime

Attendees

Integer

TotalRoomNights

Integer

AdditionalInformation

String

CommissionRate

Integer

Currency

String

TotalMeetingSpaceCost

Money

TotalFoodAndBeverageMinimum

Money

TotalAVCost

Money

TotalContractValue

Money

ReferenceId

String

Concessions

String

DateContracted

DateTime

RoomType

String

RoomQuantity

String

RoomRate

Money

FileName

String

FileType

String

FileSize

Integer

UploadedDate

DateTime

FileUrl

String

KeyContactFirstName

String

KeyContactLastName

String

KeyContactTitle

String

KeyContactEmailAddress

String

KeyContactPhone

String

KeyContactFax

String

KeyContactMobilePhone

String

KeyContactOrganization

String

KeyContactOrganizationWebsite

String

KeyContactAddress1

String

KeyContactAddress2

String

KeyContactAddress3

String

KeyContactCity

String

KeyContactState

String

KeyContactStateCode

String

KeyContactPostalCode

String

KeyContactCountry

String

Searchable

SleepRoomDetail

AttachmentDetail

BillingContactInfo

Page 128 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

KeyContactCountryCode

String

KeyContactAdditionalInformation

String

QuestionId

Money

QuestionType

Integer

QuestionText

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

Searchable

SurveyDetail

Answer

Used in GetUpdated call

Page 129 of 155

Cvent Web Services API Version V200611 January 2015

3.7.3

Supplier

The Supplier object is for planner side only. The following are the fields associated with the Supplier object and the properties of these fields. Access to this object is restricted. To request to have this object enabled in your account, please contact your Cvent client service representative. Field Name

Type

Read-Only

GUID

Name

String

VenueCode

String

VenueType

String

Brand

String

ChainAffiliation

String

MainPhoneNumber

String

MainFaxNumber

String

SalesPhoneNumber

String

SalesFaxNumber

String

SourceId

String

VenueWebsiteURL

String

CventStarRating

String

Address1

String

Address2

String

City

String

State

String

StateCode

String

PostalCode

String

Country

String

CountryCode

String

MetroArea

String

Currency

String

Description

String

CancellationPolicy

String

TotalSleepRooms

Integer

TotalSingleRooms

Integer

TotalDoubleRooms

Integer

TotalSuites

Integer

ProfileCompleteness

Percentage

ProposalDefaultCompleteness

Percentage

ImageName

String

ImageCategory

String

ImageURL

String

GUID

Searchable

ImageDetail

RateHistoryDetail RateHistoryId ExternalIdDetail

Page 130 of 155

Cvent Web Services API Version V200611 January 2015

3.8

ExternalIdType

String

ExternalId

String

Supplier Objects

The following Supplier objects are available.

3.8.1

SupplierRFP

The SupplierRFP object is for venues only. The following are the fields associated with the SupplierRFP object and the properties of these fields. Field Name

Type

Read-Only

Searchable

RFPType

String

RFPStatus

String

RFPCode

String

RFPName

String

QuickRFP

Boolean

ResponseDueDate

DateTime

DecisionDate

DateTime

CancelledDate

DateTime

CancelReason

String

CancelReasonComments

String

Currency

String

RFPDescription

String

DecisionFactors

String

Commissionable

Boolean

CommissionRate

Integer

ReceivePackageRatesResponse

Boolean

RFPRating

Decimal

EmployeesRange

String

AverageAttendeesPerEventRange

String

AverageRoomNightsPerEventRange

String

TotalAttendeesPerYearRange

String

TotalRoomNightsPerYearRange

String

CityWideFlag

Boolean

AcceptRebates

Boolean

Rebate

Integer

RebateType

String

Organization

String

OrganizationType

String

OrganizationAddress1

String

OrganizationAddress2

String

OrganizationAddress3

String

OrganizationCity

String

OrganizationState

String

OrganizationStateCode

String

OrganizationInfo X

Page 131 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

OrganizationPostalCode

String

OrganizationCountry

String

OrganizationCountryCode

String

Employees

Integer

EventsPerYear

Integer

SingleDayEvents

String

MultiDayEvents

String

AverageAttendeesPerEvent

Integer

AverageRoomNightsPerEvent

Integer

TotalAttendeesPerYear

Integer

TotalRoomNightsPerYear

Integer

OrganizationInformation

String

LastModifiedDate *

DateTime

EventName

String

EventType

String

ReferenceNumber

String

EventStartDate

DateTime

EventEndDate

DateTime

AlternateStartDate1

DateTime

AlternateEndDate1

DateTime

AlternateStartDate2

DateTime

AlternateEndDate2

DateTime

TotalAttendees

Integer

TotalBudget

Money

TotalMeetingSpace

String

LargestMeetingRoom

String

ContractSignatureLocation

String

BusinessObjectives

String

DestinationsUnderConsideration

String

AdditionalInformation

String

RepeatEvent

Boolean

Concessions

String

BillingInformation

String

DinnerPrivateRoom

Boolean

DinnerAVRequirements

String

DinnerAlcoholPolicy

String

DinnerSpecialNeeds

String

DayNumber

Integer

StartDate

DateTime

EndDate

DateTime

Notes

String

EventInfo

Alternate Dates

Page 132 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

EventHistoryDetail VenueName

String

City

String

State

String

StateCode

String

Date

String

Attendees

Integer

RoomBlock

Integer

RoomPickup

Integer

KeyContactFirstName

String

KeyContactLastName

String

KeyContactTitle

String

KeyContactEmailAddress

String

KeyContactPhone

String

KeyContactFax

String

KeyContactMobilePhone

String

KeyContactOrganization

String

KeyContactOrganizationWebsite

String

KeyContactAddress1

String

KeyContactAddress2

String

KeyContactAddress3

String

KeyContactCity

String

KeyContactState

String

KeyContactStateCode

String

KeyContactPostalCode

String

KeyContactCountry

String

KeyContactCountryCode

String

KeyContactAdditionalInformation

String

CheckInDate

DateTime

BudgetedRoomRate

Money

RoomSizeType

String

SleepRoomAdditionalInformation

String

DayNumber

Integer

Date

DateTime

AnyRoomQuantity

Integer

SingleRoomQuantity

Integer

DoubleRoomQuantity

Integer

SuiteQuantity

Integer

SleepRoomNote

String

StaffRoomQuantity

Integer

KeyContactInfo

SleepRoomInfo

SleepRoomDetail

Page 133 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

OccupancyPerRoomDetail RoomType

String

Occupancy

String

TotalMeetingRooms

Integer

FoodAndBeverageBudget

Money

MeetingRoomAdditionalInformation

String

AmenityAdditionalInformation

String

DayNumber

Integer

StartTime (include date)

DateTime

EndTime (include date)

DateTime

AgendaItem

String

AgendaItemType

String

SetupType

String

RoomSize

Integer

NumberOfPeople

Integer

TwentyFourHourHold

Boolean

MeetingRoomNote

String

LocatedAtHostHotelOrConventionCenter

Boolean

FileName

String

FileType

String

FileSize

Integer

UploadedDate

DateTime

FileURL

String

QuestionId

GUID

QuestionType

String

QuestionText

String

ProposalId

GUID

VenueID

GUID

VenueName

String

VenueCode

String

SourceId

String

VenueType

String

VenueCity

String

VenueMMA

String

Status

String

Archived

Boolean

RFPReceivedDate

DateTime

RFPLastSentDate *

DateTime

EventRequirementInfo

MeetingRoomDetail

AttachmentDetail

QuestionDetail

SupplierDetail

X X

Page 134 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

RFPViewedDate

DateTime

RFPLastViewedDate

DateTime

BidSentDate

DateTime

ResponseReason

String

ResponseReasonComment

String

RecipientEmailAddress

String

RecipientType

String

RecievedDate

String

SenderFirstName

String

SenderLastName

String

SenderEmailAddress

String

ForwardedVenueName

String

ForwardedVenueCode

String

ForwardAdditionalInformation

String

ForwardDate

String

AssigneeFirstName

String

AssigneeLastName

String

AssigneeEmailAddress

String

AssignorEmailAddress

String

AssignmentStatus

String

AssignmentMessage

String

CurrentAssignee

Boolean

LastestResponseDate

Read-Only

Searchable

RecipientDetail

ForwardHistoryDetail

AssignmentHistoryDetail

Used in GetUpdated call

Page 135 of 155

Cvent Web Services API Version V200611 January 2015

3.8.2

SupplierProposal

The SupplierProposal object is for venues only. The following are the fields associated with the SupplierProposal object and the properties of these fields. Field Name

Type

RFPId

GUID

Read-Only X

Searchable X

RFPType

String

RFPStatus

String

RFPCode

String

RFPName

String

ProposalStatus

String

ProposalSentDate

DateTime

Commissionable

Boolean

CommissionRate

Integer

CreatedDate

DateTime

CreatedBy

String

LastModifiedDate *

DateTime

LastModifiedBy

String

IncludeRebates

Boolean

Rebate

Integer

RebateType

String

RebatesIncentive

String

RoomRateConfirmed

Boolean

ConfirmationContingencies

String

YearlyIncrease

Integer

RoomRateInfo

String

UnionInfo

String

ContractorInfo

String

VenueName

String

VenueCode

String

VenueType

String

SourceId

String

EventStartDate

DateTime

EventEndDate

DateTime

Availability

String

Currency

String

EstimatedTotalCost

Money

AdditionalInformation

String

AlternateStartDate1

DateTime

AlternateEndDate1

DateTime

AlternateSleepRoomRate1

String

AlternateAdditionalInformation1

String

AlternateStartDate2

DateTime

VenueInfo

EventInfo

Page 136 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

AlternateEndDate2

DateTime

AlternateSleepRoomRate2

String

AlternateAdditionalInformation2

String

KeyContactFirstName

String

KeyContactLastName

String

KeyContactTitle

String

KeyContactEmailAddress

String

KeyContactPhone

String

KeyContactFax

String

KeyContactMobilePhone

String

KeyContactOrganization

String

KeyContactOrganizationWebsite

String

KeyContactAddress1

String

KeyContactAddress2

String

KeyContactAddress3

String

KeyContactCity

String

KeyContactState

String

KeyContactStateCode

String

KeyContactPostalCode

String

KeyContactCountry

String

KeyContactCountryCode

String

KeyContactAdditionalInformation

String

SleepRoomNeedsMet

Boolean

SleepRoomNeedsMetAdditionalInfo

String

CheckInDate

DateTime

FeeAdditionalInformation

String

DayNumber

Integer

Date

DateTime

AnyRoomQuantity

Integer

AnyRoomRate

Money

SingleRoomQuantity

Integer

SingleRoomRate

Money

DoubleRoomQuantity

Integer

DoubleRoomRate

Money

SuiteQuantity

Integer

SuiteRate

Money

StaffRoomQuantity

Integer

StaffRoomRate

Money

Searchable

ConcessionAdditionalInformation KeyContactInfo

SleepRoomInfo

SleepRoomAvailabilityDetail

EventSpace

Page 137 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

RoomName

String

RoomSize

Integer

CeilingHeight

Integer

TwentyFourHourHold

Boolean

MoveInDate

DateTime

MoveInRate

Money

MoveInRateType

String

MoveOutDate

DateTime

MoveOutRate

Money

MoveOutRateType

String

EventStartDate

DateTime

EventEndDate

DateTime

EventRate

Money

EventRateType

String

Note

String

Category

String

Type

String

Value

Decimal

MeetingRoomNeedsMet

Boolean

MeetingRoomNeedsMetAdditionalInfo

String

TotalFoodAndBeverageMinimum

Money

FAndBMinimumNote

String

ApplicableTax

Integer

ServiceCharge

Integer

CostAdditionalInformation

String

AmenityAdditionalInformation

String

RoomSizeUnitOfMeasure

String

CeilingHeightUnitOfMeasure

String

Amount

Money

Quantity

Integer

Type

String

TaxOrServiceCharge

String

Note

String

DateType

String

StartDate

DateTime

EndDate

DateTime

Availability

String

SleepRoomRate

String

AdditionalInformation

String

Searchable

AdditionalFeeDetail

EventRequirementsInfo

ProposalEstimatedCostDetail

AlternateSleepRoomAvailabilityDetails

Page 138 of 155

Cvent Web Services API Version V200611 January 2015

Field Name

Type

Read-Only

Searchable

MeetingRoomAvailabilityDetail DayNumber

Integer

StartTime (include date)

DateTime

EndTime (include date)

DateTime

AgendaItem

String

AgendaItemType

String

SetupType

String

RoomName

String

RoomHeight

Decimal

RoomSize

Integer

NumberOfPeople

Integer

TwentyFourHourHold

Boolean

MeetingRoomAdditionalInfo

String

FileName

String

FileType

String

FileSize

Integer

UploadedDate

DateTime

FileURL

String

Date

DateTime

Package

String

Occupancy

String

RoomType

String

PricePerDay

Integer

PackagePricingNote

String

QuestionId

String

QuestionType

Integer

QuestionText

String

AnswerPart

String

AnswerColumn

String

AnswerText

String

AnswerOther

String

AnswerComment

String

AttachmentDetail

Package Pricing

SurveyDetail

Answer

Used in GetUpdated call

Page 139 of 155

Cvent Web Services API Version V200611 January 2015

3.8.3

RFPParameters

The following are the fields associated with the RFPParameters object and the properties of these fields. Field Name

Type

RFPType

String

RFPName

String

ResponseDueDate

DateTime

DecisionDate

DateTime

CurrencyCode

String

RFPDescription

String

InternalNote

String

EventName

String

EventStartDate

DateTime

EventEndDate

DateTime

TotalAttendees

Integer

DestinationsUnderConsideration

String

BudgetedRoomRate

Money

KeyContactFirstName

String

KeyContactLastName

String

KeyContactTitle

String

KeyContactEmailAddress

String

KeyContactPhone

String

KeyContactFax

String

KeyContactMobilePhone

String

KeyContactOrganization

String

KeyContactAddress1

String

KeyContactAddress2

String

KeyContactAddress3

String

KeyContactCity

String

KeyContactStateCode

String

KeyContactPostalCode

String

KeyContactCountryCode

String

Read Only

Searchable

Page 140 of 155

Cvent Web Services API Version V200611 January 2015

3.8.4

RateHistory

The following are the fields associated with the RateHistory object and the properties of these fields. Field

Type

VenueID

GUID

VenueCode

String

VenueName

String

RateName

String

RateStartDate

Date/Time

RateEndDate

Date/Time

MinimumRate

Double

MaximumRate

Double

RoomType

String

RoomNightCount

Integer

Comment

String

Currency

String

ContractedRate

Boolean

ContractDate

Date/Time

CreatedDate

Date/Time

CreatedBy

String

LastModifiedDate*

Date/Time

LastModifiedBy

String

Read Only

Searchable

Used in GetUpdated call

Page 141 of 155

Cvent Web Services API Version V200611 January 2015

4.0

API Management

In your Cvent account, you will be able to manage API users and view call-related statistics and graphs. To access this page, go to Admin > Integrations > SOAP API Usage.

To view this section, make sure the logged-in user is an Administrator or has full access to the â&#x20AC;&#x153;Integration Managementâ&#x20AC;? permission in Admin > Users > User Roles > Role Details.

Page 142 of 155

Cvent Web Services API Version V200611 January 2015

4.1

Daily Call Graphs

In Admin > Integrations > SOAP API Usage, the “Daily API Call Breakdown” and “API Calls by Date” graphs will appear by default.

Daily API Call Breakdown

API Calls by Date

This displays a breakdown of the calls made

This displays the number of calls made within the

on the current day. It include calls from all API

past 10 days. If you hover over a point on the

users, even if more than one API user account

graph, a pop-up will display the current date and

exists.

total calls made for that day.

4.2

API User

Below the call graphs, a list of API users associated to the account are displayed.

You can perform the following actions from this grid:  Edit API User Details – Click the edit icon to edit allowed IP addresses or to deactivate an API account. The allowed API addresses are the IP addresses that the user provided and inherited by API license. IP addresses inherited from API license cannot be edited.  Run Report on API Calls – Click the report icon to run a report on API calls made by the selected user within a specified date range.  View All Allowed IP Addresses – Click “View All” to display the IP addresses that the user provided or inherited by the API license.

Page 143 of 155

Cvent Web Services API Version V200611 January 2015

5.0

Appendix A â&#x20AC;&#x201C; Error Codes

The following are the error codes you may receive and their type and message. Error Type Generic

Security

Invalid Operations

Metric

Code

Message

CV10000

Unknown exception

CV10001

Server exception â&#x20AC;&#x201C; transaction cancelled

CV10100

Account lockout

CV10101

No access

CV10102

Invalid login

CV10103

Cannot be authenticated

CV10104

Invalid Cvent header value

CV10105

Session expired

CV10106

Invalid IP

CV10107

Unknown header value

CV10108

API currently disabled

CV20001

Malformed ID

CV20010

Invalid search filter

CV20011

Unknown search exception

CV20012

Too many IDs returned

CV20013

Invalid date range

CV20014

Invalid date range

CV20015

Invalid search operator

CV20016

Invalid custom contact field ID or search filter format

CV20017

Invalid custom event field ID or search filter format

CV20018

No ID provided

CV20019

Invalid user ID

CV20020

Invalid respondent status

CV20021

Too many IDs provided

CV30100

Exceed API call limit

CV30101

Exceed create contact limit

CV30102

Exceed update contact limit

CV30103

Exceed delete contact limit

CV30104

Exceed check-in limit

CV30105

Exceed simple event registration limit

CV30106

Exceed transfer invitee limit

CV30107

Exceed manage contact group members limit

CV30108

Exceed create user limit

CV30109

Exceed update user limit

CV30110

Exceed delete user limit

CV30111

Exceed create no-registration event limit

CV30112

Exceed manage user group limit

CV30117

Exceed copy event limit

CV30118

Exceed survey answer import limit

CV30119

Exceed create RFP limit

Page 144 of 155

Cvent Web Services API Version V200611 January 2015

Error Type

Validation

Code

Message

CV30120

Exceed upsert contact limit

CV30121

Exceed validate invitee limit

CV30122

Exceed update approver limit

CV30123

Exceed invitee limit

CV40101

Last Name is required to create a contact

CV40102

Invalid format for email address

CV40103

Duplicated Contact object â&#x20AC;&#x201C; Key field(s) are not unique

CV40104

Contact already exists

CV40105

Contact Type Code not valid

CV40106

Country Code for Home Address is not valid

CV40107

State Code for Home Address is not valid

CV40108

Country Code for Work Address is not valid

CV40109

State Code for Work Address is not valid

CV40110

ID is not valid

CV40111

Contact Custom Field ID(s) is not valid

CV40112

Contact Group ID(s) is not valid

CV40113

ID is required

CV40114

Last Name is required to update a contact

CV40115

ID is required

CV40116

Duplicated Custom Field Detail object - FieldId(s) are not unique

CV40117

Duplicated Contact Group Detail object - GroupId(s) are not unique

CV40118

Duplicate ID

CV40119

Invalid format for cc email-address

CV40120

Email is required to upsert a contact

CV40121

FirstName is required to upsert a contact

CV40122

LastName is required to upsert a contact

CV40123

Invalid DOB

CV40124

Email address does not exist in your account

CV50101

Invalid ID

CV50102

Duplicate ID

CV50103

ID does not exist in this account

CV50104

Invitee already exists

CV50105

Invalid activity ID

CV50106

Invalid activity type

CV50107

Transaction ID already exists

CV50108

Transaction ID not found for respondent

CV60101

Invalid ID

CV60102

Duplicate ID

CV70101

Invalid ID

CV70102

Duplicate ID

CV70103

ID attempted to be registered already has an Accepted status

CV70104

ID attempted to be declined cannot have an Accepted or Declined status

CV70105

ID attempted to be waitlisted cannot have an Accepted or Waitlisted status

Page 145 of 155

Cvent Web Services API Version V200611 January 2015

Error Type

Budget Item

Code

Message

CV70106

ID attempted to be canceled must already have an Accepted status

CV70107

Event capacity has been reached

CV70108

Invalid registration action

CV70109

Invalid event ID

CV70110

Event ID is not eligible for simple event registration

CV70111

Waitlist is not active for supplied event ID

CV70112

Event status is not valid for supplied registration action

CV70113

The event you are currently requesting is not open for registration

CV80101

Invalid ID

CV80102

ID is required

CV80103

Contact already exists in the passed contact group

CV80104

Contact does not exist in the passed contact group

CV80105

Invalid action

CV90101

Exceed create contact group limit

CV90102

Name is required to create a contact group

CV91101

Required arguments not supplied

CV91102

Invalid argument format

CV91103

Invalid template

CV91105

No event email access

CV91106

No survey email access

CV91107

Exceed send email limit

CV91108

No eMarketing email access

CV91200

Recipient's ID is not valid

CV91201

Recipient does not exist

CV91202

Duplicate recipient found

CV91203

Recipient's contact information not found

CV91204

Recipient has already received this email

CV91205

Recipient's email address is invalid

CV91206

Recipient has opted out

CV91207

Sending mail process for the recipient resulted in a failure

CV91208

No email template

CV91209

Registration approval is not enabled

CV91210

Recipient has unsubscribed

CV91211

Invalid ID

CV91212

Duplicate ID

CV91213

ID does not exist in this account

CV91214

Invalid event ID

CV91215

Blank budget item name

CV91216

Invalid budget item type

CV91217

Invalid budget item status

CV91218

Invalid budget currency code

CV91219

Budget currency code inactive in this account

CV91220

Invalid conversion rate

Page 146 of 155

Cvent Web Services API Version V200611 January 2015

Error Type

User Management

Code

Message

CV91221

Invalid budget category name

CV91222

Invalid budget subcategory ID

CV91223

Invalid vendor ID

CV91224

Invalid product ID

CV91225

Invalid budget item date

CV91226

Invalid GL code

CV91227

Invalid cost avoidance

CV91229

Invalid units

CV91230

Invalid cost

CV91231

Invalid tax 1 rate

CV91232

Invalid tax 2 rate

CV91233

Invalid tax 3 rate

CV91234

Invalid tax 4 rate

CV91235

Invalid tax 5 rate

CV91236

Invalid gratuity rate

CV91237

Budgeted cost is required

CV91238

Invalid budget cost type

CV91240

Invalid allocation category ID

CV91241

Invalid allocation subcategory ID

CV91242

Invalid allocation percentage

CV91243

Sum of allocations does not equal 100%

CV91245

Invalid payment name

CV91246

Invalid payment method

CV91247

Invalid payment date

CV91248

Invalid payment amount

CV91249

Invalid currency code

CV91250

Currency code inactive in this account

CV91251

Invalid payment detail ID

CV91252

Invalid RFP ID

CV91253

Account budget tracking is off

CV91254

Account budget allocation is off

CV91255

GL code must be active

CV91256

Duplicate budget cost nameâ&#x20AC;?

CV92101

UserType is required

CV92102

Username is required to create a User

CV92103

FederatedId is required to create a User

CV92104

UserRoleId is required to create a User

CV92105

Email is required to create a User

CV92106

First Name is required to create a User

CV92107

Last Name is required to create a User

CV92108

Password is required to create a User

CV92109

ID is not Valid

CV92110

ID is required to update a User

Page 147 of 155

Cvent Web Services API Version V200611 January 2015

Error Type

Code

Message

CV92111

UserRoleId is not Valid

CV92112

User's DefaultContactGroupId is not Valid

CV92113

UserGroupDetail's UserGroupId is not Valid

CV92114

VisibilityDefaults's UserGroupId is not Valid

CV92115

Invalid format for email address

CV92116

Country Code is not valid

CV92117

State Code is not valid

CV92118

UserType is not Valid

CV92119

Username already exists

CV92120

FederatedId already exists for this user

CV92121

Duplicated User object - Key field(s) are not unique

CV92122

Duplicated User Group Detail object - GroupId(s) are not unique

CV92123

Duplicated User Visibility Defaults object - GroupId(s) are not unique

CV92124

VisibilityDefaultsâ&#x20AC;&#x2122;s VisibilityType is not Valid

CV92125

Active multi user limit has been reached

CV92126

ID is required to delete a User

CV92127

VisibilityDefaults's UserGroupId already exists for this user

CV92128

UserGroupDetail's UserGroupId already exists for this user

CV92129

You cannot delete a user who is associated to an active API account

CV93101

Invalid user group ID

CV93102

ID is required for adding/removing a User from a User Group

CV93103

User already exists in the passed User Group

CV93104

User does not exist in the passed User Group

CV94101

Title is required to create an Event

CV94102

TimeZoneCode is required to create an Event

CV94103

StartDate is required to create an Event

CV94104

PlannerFirstName is required to create an Event

CV94105

PlannerLastName is required to create an Event

CV94106

StartDate must be earlier than the EndDate

CV94107

State Code is not valid

CV94108

Country Code is not valid

CV94109

TimeZone Code is not valid

CV94110

Capacity is not valid

CV94111

Registrant count or Participant count is not valid

CV94112

RSVP By Date is not valid

Invitee Internal Information

CV95101

Combination of InviteeId and QuestionCode is not unique

CV95102

Invalid question type

Invitee Internal Information

CV95103

Question Code does not exist for this Event

CV95104

EventId is required to update Invitee Internal Information

CV95105

InviteeId is required to update Invitee Internal Information

CV95106

Question ID or Question Code is required

CV95107

Answer Text is required to update Invitee Internal Information

User Group Management

No-Registration Event Creation

Invitee Internal Information

Page 148 of 155

Cvent Web Services API Version V200611 January 2015

Error Type

Code

Message

CV95108

EventId is not Valid

CV95109

Question ID does not exist for this Event

CV84001

Invitee ID does not exist

Rate History

CV96101

ID is required to delete a Rate History

Invitee or Guest Check-In

CV97101

ID does not match an existing session

CV97102

Invitee/guest must be registered for the session to be checked in

CV98101

Invalid invitee status

CV98102

Duplicated Transaction object – Invitee ID(s) are not unique

CV98103

Duplicated Distribution Detail object – Product ID(s) are not unique

CV98104

The amount due must be greater than 0

CV98105

The amount due must be less than 0

CV98106

Amount applied to all products must equal the total amount paid

CV98107

Invalid product

CV98108

The total Amt Applied cannot be less or greater than the total payment

CV99101

You do not have access to this object

CV99611

Question Code does not exist for this Survey

CV99612

Invalid respondent status

CV99613

Invalid question type

CV99614

QuestionID or QuestionCode is required

CV99615

Question ID does not exist for this Survey

CV81101

User ID is required to create an RFP

CV81102

RFP Type is required

CV81103

RFP Name is required

CV81104

Invalid RFP Type

CV81105

Invalid Currency Code

CV81106

Invalid State Code

CV81107

Invalid Country Code

CV81108

Event Start Date must be earlier than the Event End Date

CV83101

Name is required to create a Distribution List

CV83102

Active flag is missing

CV83103

Security Type is required

CV89102

ID is required for adding/removing from a Distribution List

CV89103

Contact already included in Distribution List

CV89104

Contact is not included in Distribution List

CV85101

ApproverCategory is required

CV85102

ApproverCategory already exists

CV85103

Approver configuration for source already exists

CV85104

Invalid Email Address

CV85106

ApproverCategory ID is invalid or does not exist

CV85107

Approver category ID and requestor source value combination is invalid or does not exist

CV85108

ApproverCategory ID is or Source Value is not exist

CV85111

ApproverCategory ID is invalid or does not exist

Transaction Creation

Supplier

Survey Answer Import

RFP Creation

Distribution List

Approver Approver

Approver

Page 149 of 155

Cvent Web Services API Version V200611 January 2015

Error Type

Invitee Validation

Contact

No Permission

Code

Message

CV85112

Invalid email ID of approver

CV85113

ApproverCategory and Source nor exists

CV85114

Approver configuration already exists for the given category and source

CV85115

RequestorSource is required

CV85116

Approver is required

CV85117

Duplicate Approver Objects - Key field(s) are not unique

CV90100

Invalid product type

CV90103

Invalid product ID

CV90104

Invitee or guest must be in Accepted status

CV90105

This invitee or guest is already registered for this session

CV90106

This invitee or guest is not registered for this session

CV90107

Event status is not valid

CV90108

Session does not belong to the registrant event

CV90109

This invitee or guest is already registered for a session within this session group

CV90110

Invitee or guest cannot be unregistered from this session

CV91100

Name is required to create a Distribution List

CV20022

Access denied

CV99616

Targeted List ID does not exist

CV99617

Invalid Contact Group Type

CV99618

Response ID is required for ticketing survey

Page 150 of 155

Cvent Web Services API Version V200611 January 2015

6.0

Appendix B – Sample Code

The sample C# code illustrates common use cases of the Cvent Web Service API. Examples are provided for the following scenarios:  Logging In  Searching for Events  Retrieving Event Details  Retrieving All Survey Responses Updated Today  Setting Up Custom Identity Authentication Logging In Use the Login method to retrieve a valid client session and begin to use the Cvent API. //Private Cvent Web Service class variable private com.cvent.api.V200611 _ws = new com.cvent.api.V200611(); // Log in with provided credentials // acctNum - Cvent provided API Account Number // username - Cvent provided API User Name // pwd - Cvent provided API password private Boolean login(String acctNum, String userName, String pwd) { //login to cvent web service com.cvent.api.LoginResult loginResult = _ws.Login(acctNum,userName,pwd);

//assign login object to session _ws.CventSessionHeaderValue = new com.cvent.api.CventSessionHeader(); _ws.CventSessionHeaderValue.CventSessionValue = loginResult.CventSessionHeader; //return success or fail if (loginResult.LoginSuccess) { Console.WriteLine("--> Login successful"); } else { Console.Write("--> Login failed"); } return (loginResult.LoginSuccess); }

Page 151 of 155

Cvent Web Services API Version V200611 January 2015

Searching for Events Use the Search method to search for events by event title. //Private Cvent Web Service class variable private com.cvent.api.V200611 _ws = new com.cvent.api.V200611(); //Search for events by event title //eventTitle - Event Title to search for //string[] - Array of EventIds that match the search criteria public string[] GetEventIdsByTitle(String eventTitle) { //Array of EventIds string[] ids; //Create Cvent search object com.cvent.api.CvSearch search = new com.cvent.api.CvSearch(); //Create Cvent search filter object array //Create a one-row array of Filter objects //Create larger array if searching on multiple fields/filters search.Filter = new com.cvent.api.Filter[1]; search.Filter[0] = new com.cvent.api.Filter(); //Search by Event Title field and provided search criteria //EventTitle is a ‘‘searchable’’ attribute of the Event object //any searchable attribute can be added as a search filter search.Filter[0].Field = ‘‘EventTitle’’; search.Filter[0].Value = fieldVal; //Search for all Event Titles that ‘‘start with’’ provided criteria search.Filter[0].Operator = com.cvent.api.CvSearchOperatorType.Startswith; //Specify if the search filters should be used to build an ‘‘And’’ or ‘‘Or’’ search search.SearchType = com.cvent.api.CvSearchType.AndSearch; //Perform search for event ids that match the search criteria //Note: Use same technique to search for other Cvent objects including //Contacts, Invitees, Registrations, Surveys, etc ids = _ws.Search(com.cvent.api.CvObjectType.Event, search); //Return string array of event ids return (ids); }

Page 152 of 155

Cvent Web Services API Version V200611 January 2015

Retrieving Event Details Traverse an array of Event IDs and use the Retrieve method to analyze or display event details. //Private Cvent Web Service class variable private com.cvent.api.V200611 _ws = new com.cvent.api.V200611(); //Display event details by event id //ids â&#x20AC;&#x201C; String array of event ids void DisplayEventsByIds(string[] ids) { //Declare an array of CvObjects for later use com.cvent.api.CvObject[] objects; if (ids != null && ids.Length > 0) { //Retrieve applicable objects corresponding to array of ids //Use same technique to retrieve other Cvent objects, //including Contacts, Invitees, Registrations, Surveys, etc objects = _ws.Retrieve(com.cvent.api.CvObjectType.Event, ids); Console.WriteLine("\nThere are " + ids.Length + " EVENT records returned from your search."); //Traverse event objects for (int i = 0; i < objects.Length; i++) { //Cast the retrieved CvObjects to Event objects com.cvent.api.Event evt = (com.cvent.api.Event)objects[i]; //Print and/or analyze Event Details System.Console.WriteLine("\n No: " + i); System.Console.WriteLine("Event Title: " + evt.EventTitle); System.Console.WriteLine(" Start Date: " +evt.EventStartDate); System.Console.WriteLine(" End Date: " + evt.EventEndDate); System.Console.WriteLine(" Status: " + evt.EventStatus); } } }

Page 153 of 155

Cvent Web Services API Version V200611 January 2015

Retrieving All Survey Responses Updated Today Use the GetUpdated method to retrieve all survey responses updated since this morning. //Private Cvent Web Service class variable private com.cvent.api.V200611 _ws = new com.cvent.api.V200611(); //Display all surveys updated today private void displayTodaysResponses() { //Get todayâ&#x20AC;&#x2122;s datetime and convert to GMT/UTC time DateTime today = System.DateTime.Today.Date; today = TimeZone.CurrentTimeZone.ToUniversalTime(today); //Get current datetime and convert to GMT/UTC time DateTime now = System.DateTime.Now; now = TimeZone.CurrentTimeZone.ToUniversalTime(now); //Retrieve all Survey Responses updated since this morning string[] ids = _ws.GetUpdated(com.cvent.api.CvObjectType.Response, today, now); //Declare an array of CvObjects for later use com.cvent.api.CvObject[] objects; if (ids != null && ids.Length > 0) { //Retrieve applicable objects corresponding to array of ids //Use same technique to retrieve other Cvent objects, //including Contacts, Invitees, Registrations, Surveys, etc objects = _ws.Retrieve(com.cvent.api.CvObjectType.Response, ids); Console.WriteLine("\nThere are " + objects.Length + " RESPONSE \ records returned from your search."); //Traverse response objects for (int i = 0; i < objects.Length; i++) { com.cvent.api.Response response = (com.cvent.api.Response)objects[i]; //Display Respondentâ&#x20AC;&#x2122;s name and title System.Console.WriteLine("\n No: System.Console.WriteLine(" First Name: " System.Console.WriteLine(" Last Name: " System.Console.WriteLine(" Title: "

" + + +

+ i); response.FirstName); response.LastName); response.Title);

//Display survey question/answer pairs displaySurveyResponse(response); } } } //Display all questions/answers for provided survey response private void displaySurveyResponse (com.cvent.api.Response response) { if (response != null) { //Declare array of survey detail objects com.cvent.api.SurveyDetail[] sd = response.SurveyDetail; if (sd != null && sd.Length > 0) { //Traverse survey details for (int j = 0; j < sd.Length; j++) {

Page 154 of 155

Cvent Web Services API Version V200611 January 2015

Retrieving All Survey Responses Updated Today

//Display question System.Console.WriteLine("\nQuestion Number: " + (j+1)); System.Console.WriteLine("Question: " + sd[j].QuestionText);

(Continued) //Display question answer(s) com.cvent.api.Answer[] answers = sd[j].Answer; if (answers != null && answers.Length > 0) { for (int x = 0; x < answers.Length; x++) { System.Console.WriteLine("\nAnswerComment(" + (x+1) + "): " + answers[x].AnswerComment); System.Console.WriteLine("AnswerPart(" + (x + 1) + "): " + answers[x].AnswerPart); System.Console.WriteLine("AnswerOther(" + (x + 1) + "): " + answers[x].AnswerOther); System.Console.WriteLine("AnswerText(" + (x + 1) + "): " + answers[x].AnswerText); } } } } } }

Page 155 of 155