| WS Parameter | Required | Description | Additional Comments | Sample Data | Xpath for XML Message |
|---|---|---|---|---|---|
| UserName | Y | Username assigned by Cvent Passkey that has been granted API access. | reglinkapi | /GetAvailabilityRQ/Security/Login/UserName | |
| Password | Y | Password associated with API Username. | passkey1 | /GetAvailabilityRQ/Security/Login/Password | |
| PartnerID | Y | Assigned PartnerID. | 136260 | /GetAvailabilityRQ/Security/PartnerID | |
| Version | Y | Identifies the Event Connector API Message version used. | Each Event Connector API Message will contain a version. Please note the most current supported version may differ between message types. | 4.00.03 | /GetAvailabilityRQ/Message/Version |
| Mode | Y | Synchronous only | Value: S | S | /GetAvailabilityRQ/Message/Mode |
| OP | Y | Operation | Values: GetHousingAvailability GetHousingDetails | GetHousingAvailablity | /GetAvailabilityRQ/Message/OP |
| Service | Y | Service | Values: GetHousingAvailability GetHousingDetails | GetHousingAvailablity | /GetAvailabilityRQ/Message/Service |
| Locale | Y | Locale | Value: EN_US Other locales are available, please contact integrations@Cvent.com for the current supported list. | EN_US | /GetAvailabilityRQ/Message/Locale |
| EventID | Y | Event ID | Unique ID for the entire event | 146021 | /GetAvailabilityRQ/Data/GetAvailability/EventID |
| Attendee Code | Y | Attendee Code | Unique ID for the attendee code. Within in an event there can be several attendee types, for example Staff, VIP, General Attendees | RTEATT0117 | /GetAvailabilityRQ/Data/GetAvailability/AttendeeCode |
| Start Date | Y | Start Date | Start Date for the Availability Search | 2018-12-01 | /GetAvailabilityRQ/Data/GetAvailability/StartDate |
| End Date | Y | End Date | End Date for the Availability Search | 2018-12-03 | /GetAvailabilityRQ/Data/GetAvailability/EndDate |
Last updated on