GET udf_services/UDFBooking?bookingTypeID={bookingTypeID}

Returns the booking system UDF definitions.

HTTP Status Codes:

200: OK - Request satisfied, data included in body.

404: Not Found - There are no UDF's defined.

Response Object:

Label: The UDF label displayed in Centaman applications. May be used as is or replaced with a custom value.

Required: If TRUE, a value must be entered by the end user on add/update operations.

IsBookingWaiver: If TRUE, indicates this UDF is defined as a Booking waiver.

IsAttendeeUDF: If TRUE, indicates this UDF is an Attendee UDF used in Timed Ticketing transactions that support Attendees.

IsMemberWaiver: If TRUE, indicates this UDF is defined as a Membership waiver.

FieldName: UDF Field Name is the principal identifier of a UDF. Used when adding/updating UDF values.

FieldType: The datatype of the UDF.

FieldLength: The maximum number of character can be saved for the UDF.

Options: A UDF may be defined with ‘options’ that can be used to populate a UI control (eg: a dropdown or picklist). If no options are returned the field is not a dropdown/picklist.

Requires HTTPS, Basic Auth.

Request Information

Parameters

The BookingTypeID returned from GET ticket_services/TimedTicket.

Response Information

Response body formats

[
  {
    "Label": "sample string 1",
    "IsRequired": true,
    "IsMemberWaiver": true,
    "IsBookingWaiver": true,
    "IsAttendeeUDF": true,
    "BookingTypeID": 6,
    "FieldName": "sample string 7",
    "FieldType": "sample string 8",
    "FieldLength": 9,
    "TabName": "sample string 10",
    "Options": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  },
  {
    "Label": "sample string 1",
    "IsRequired": true,
    "IsMemberWaiver": true,
    "IsBookingWaiver": true,
    "IsAttendeeUDF": true,
    "BookingTypeID": 6,
    "FieldName": "sample string 7",
    "FieldType": "sample string 8",
    "FieldLength": 9,
    "TabName": "sample string 10",
    "Options": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  },
  {
    "Label": "sample string 1",
    "IsRequired": true,
    "IsMemberWaiver": true,
    "IsBookingWaiver": true,
    "IsAttendeeUDF": true,
    "BookingTypeID": 6,
    "FieldName": "sample string 7",
    "FieldType": "sample string 8",
    "FieldLength": 9,
    "TabName": "sample string 10",
    "Options": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ]
  }
]