REST API UserDataDefinition

From XING Events Developer Documentation
Jump to: navigation, search

Object type: userDataDefinition

The userDataDefinition object is a nested object of an event the represents the additional questions asked by the organizer to each ticket buyer during the registration process. This definitions can be retrieved from the event object with: Enumerate userDataDefinitions


Attributes: R - accessible in read requests W - accessible in write (update) requests C - accessible in create requests

Attributes Description
fieldId Number R-- The internal ID of this user data definition.
title String R-- The title of the user data object. Can be shown to the user.
The "level" of the user data item. This can either be "PAYMENT" meaning that this information is requested per payment or "TICKET" if the information is requested for each ticket.
orderNumber Number R-- Order number of this user data field (if you display the user fields of this event to any user, order them by this number).
type String R-- Possible values:
string — value is of type String.
email — value is of type String.
date — value is of type Date.
datetime — value is of type Date.
radio — value is of type Integer.
checkbox — value is of type Boolean.
dropdown — value is of type String.
photo — value is of type String.
file — value is of type String.
gender — value is of type Integer.
url — value is of type String.
birthday — value is of type Date.
address — value is an object of type Address.
phone — value is of type String.
country — value is of type Country.
textarea — value is of type String.
required Boolean R-- Is this a mandatory field in the buying process?
options Array of User Data Options
Only present if this item represents a dropdown or radio button and provides the list of available options offered to the buyer.

User Data Options

The options property returns an array of User Data Option objects. These objects provide a key and the title shown to the ticket buyer. If a ticket buyer has selected an option you will find the key of that value in the payment/ticket/participant information of that buying process.
These are the properties of this objects:

The title/name of this option as shown to the ticket buyer (e.g. one item in a drop down box).
Is internal key of this option (this is the key you will get if you read what data a ticket buyer has provided).
REST API Contents
Getting Started Get your API key Overview Formats Errors
Data Types Event Participant Payment Ticket
Ticket Categories ProductDefinition Products CodeDefinition
TicketShop Addresses Ticket Types Payment Types
BankAccount UserDataDefinition UserData User
Data Synchronization Sync Interface