Make a request »

EventService.GetControls

Gets event registration form controls as configured in event registration form editor. Build your own event registration form by including all these controls and following what their properties define. Works with Event 3.0 or newer (Direct method) (See code examples)


URL Parameters

Http verb: GET
URI: Full url: http://se.api.anpdm.com/event/v2/{eventId}/registrationForm/controls
URL parameters:
eventIdStringEvent ID

Body parameters

Body parameters
Not used

Response

Body parameters
returns
Response object that includes event registration form controls, status code and status message

Code Int32 The response Code.
Message String The response Message.
Result
The response Result.

RegistrationFormControl
Lorem ipsum dolor sit amet, consectetur adipiscing elit...

Type String Control type that can be one of: heading, label, text, textarea, select, checkbox, email, phonenumber. Always populated.
HiddenField Boolean Control is hidden on the registration form. Used by: all control types.
HiddenForAdditionalGuests Boolean Control is hidden on the registration form for non-anonymous additional guests. Used by: all control types.
Name String Name is used to identify the control with the RegisterAttendee API method. Used by: text, textarea, select, checkbox, email.
DisplayName String Text that is displayed next to the control on the registration form. Used by: text, textarea, select, checkbox, email, phonenumber.
Text String Heading or description text. Used by: heading, description.
SubType String Single-choice select control type that can be one of: dropdown, radiobutton. Used by: select.
EmptyItemDisplayName String If populated, the dropdown is not defaulted to any value and a "nothing selected" option is added with this text. Used by: select of sub-type dropdown.
Items
Available options. Used by: select, checkbox.

SelectItem
Option. Used by: select, checkbox.

Value String Name is used to identify the option with the RegisterAttendee API method. Used by: select, checkbox.
DisplayName String Text that is displayed next to the option on the registration form. Used by: select, checkbox.
ValidateRequired Boolean If set, the registration form will validate if the value is provided before attempting to call the RegisterAttendee API method. Used by: text, textarea, select, checkbox, email.
ValidateRequiredMessage String The message that will be displayed on registration form if a required value was not provided. Used by: text, textarea, select, checkbox, email, phonenumber.
ValidatePattern String If set, the registration form will regex-validate the value before attempting to call the RegisterAttendee API method. Used by: email.
ValidatePatternMessage String The message that will be displayed on registration form if the pattern validation failed. Used by: email.
ValidateMaxLength Int32 If greater than 0, the registration form will validate if the value is not longer before attempting to call the RegisterAttendee API method. Used by: text, textarea, email.
CountryCode
Country code. Used by: phonenumber.

Name String Name is used to identify the control with the RegisterAttendee API method. Used by: phonenumber.
ValidateRequired Boolean If set, the registration form will validate if the value is provided before attempting to call the RegisterAttendee API method. Used by: phonenumber.
ValidateMaxLength Int32 If greater than 0, the registration form will validate if the value is not longer before attempting to call the RegisterAttendee API method. Used by: phonenumber.
Hidden Boolean Country code is hidden on the registration form. Used by: phonenumber.
PhoneNumber
Phone number. Used by: phonenumber.

Name String Name is used to identify the control with the RegisterAttendee API method. Used by: phonenumber.
ValidateRequired Boolean If set, the registration form will validate if the value is provided before attempting to call the RegisterAttendee API method. Used by: phonenumber.
ValidateMaxLength Int32 If greater than 0, the registration form will validate if the value is not longer before attempting to call the RegisterAttendee API method. Used by: phonenumber.
Body Example


Help

Code examples