Fieldset

Fieldset is a unified control for additional data that can be returned in the response.

Event fieldset

By default, the event data in the response returns id, title, slug, location, scheduling, tags, created, modified, status, guestListConfig, instanceId, userId and language fields. The response will also include following parameters based on the fieldsets provided in the request.

FieldsetFields
DETAILSdescription, mainImage and calendarLinks
TEXTSabout
REGISTRATIONregistration
URLSeventPageUrl
FORMform
DASHBOARDdashboard
FEED (for internal use)feed (for internal use)
ONLINE_CONFERENCING_SESSIONonlineConferencing

Ticket definition fieldset

By default, the definitions data in the response contains id, price, free, name, limitPerCheckout, orderIndex and eventId fields. The response will also include the following parameters based on the fieldsets provided in the request.

FieldsetFields
POLICYpolicy
DASHBOARDdashboard

RSVP fieldset

By default, the rsvps data returned in the response contains id, eventId, contactId and memberId fields. The response will also include the following parameters based on the fieldset provided in the request.

FieldsetFields
DETAILScreated, modified, firstName, lastName, status, totalGuests, guests and anonymized
FORMrsvpForm
CONTACT_DETAILSemail

Order fieldset

By default, the order data returned in the response contains orderNumber, eventId, contactId, memberId, anonimyzed and fullyCheckedIn fields. The response will also include following parameters based on the fieldsets provided in the request.

FieldsetFields
DETAILSreservationId, snapshotId, created, firstName, lastName, confirmed, status, method, ticketsQuantity, totalPrice, ticketsPdf, archived and fullName
FORMcheckoutForm
TICKETStickets
INVOICEinvoice

Ticket fieldset

By default, the ticket data in the response contains memberId and anonymized fields. The response will also include following parameters based on the fieldsets provided in the request.

FieldsetFields
TICKET_DETAILSticketNumber, orderNumber, ticketDefinitionId, name, price, free, policy, qrCode, checkIn, orderStatus, orderArchived, archived, orderFullName, ticketPdf, checkInUrl and ticketPdfUrl
GUEST_DETAILSguestDetails
GUEST_FORMguestDetails.form

Policy fieldset

By default, the policy data in the response contains id, eventId, name, updated_date and sortIndex fields. The response will also include following parameters based on the fieldsets provided in the request.

FieldsetFields
BODYbody

Token fieldset

By default, the get tokens response contains only token field. The response will also include following parameters based on the fieldsets provided in the request.

FieldsetFields
POLICIESpolicies
Was this helpful?
Yes
No