Ticket module display page setting

This API is used to get the ticket module display page setting with the specified event. It will return data like showEnterEventButton, address, startDate, endDate, preEventAccessMinutes, eventListingStatus and ticketTypes etc.
To call this API, the user has to pass query param with API urls like eventUrl, accesscode and authentication key to authenticate the user.

Response

Here is the description of response attributes, which returns to the form of JSON.

Attribute

Description

showRegistrationButton

This contains the show registration button on the event landing page.

endDate

This contains the end date of ticket sales.

eventFormat

This contains the event venue status like VIRTUAL, HYBRID, or IN-PERSON.

eventListingStatus

This contains the event listing status. It will return types like PRIVATE, PUBLIC, PREVIEW, PUBLISHED, or POSTPONED.

eventVenueStatus

This will return the event venue status like VENUE, VIRTUAL, or TO BE ANNOUNCED.

preEventAccessMinutes

This will return the number of pre-event access times in minutes.

showEnterEventButton

This contains the show enter event button on the portal. By default set a false value.

address

This contains the event venue address.

showTicketPrice

This contains the show ticket price on the event landing page.

startDate

This contains the start date of ticket sales.

ticketTypes

This contains the different types of tickets. It will return a list of ticketing types.
typeId : It contains the ticket type id.
price : It contains the ticket type price.
ticketType : It contains the ticket type e.g. FREE, PAID or DONATION.
dataType : It contains the datatype e.g. TICKET or ADDON.

Error Code

Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error code

Error Description

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

40600013

Cant create url

4040200

No Event could be found

4040051

Ticketing setting not found

Language
Authentication
Header
Click Try It! to start a request and see the response here!