This API is used to show the ticket module display page settings associated with the specified event. This API can be accessed by event admin and super admin. It will return event data like address, event format, ticket types, startDate, endDate, eventListingStatus, show ticket price, and many more. To call this API, the user has to pass eventurl as a query param, access code, recurringEventId, and authentication key to authenticate the user.
Here is the description of response attributes, which is returned in JSON format.
It will return a success message if API is executed successfully.
Attribute | Description |
|---|---|
bundleType | It will provide a ticket bundle type e.g. INDIVIDUAL_TICKET, TABLE, SPONSOR, or BLOCK. |
dataType | It will provide details of available data types in a specified event like the addon, ticket. |
address | It contains the address of the ticketing venue. |
eventListingStatus | It contains the event listing status for ticketing. |
eventFormat | It will return the event format details like Virtual, Hybrid, and In-Person. |
showRegistrationButton | It contains the show registration button on the display page. |
preEventAccessMinutes | It contains the pre-event access time in minutes, e.g. 30 |
showEnterEventButton | It will return a true or false value. by default show, enter event button return a false value. |
eventVenueStatus | It contains the event venue status, e.g. ONLINE_EVENT, TO_BE_ANNOUNCED, VIRTUAL |
showTicketPrice | It contains the show ticket price on the display page. |
ticketsPerTable | Only return if ticket type is as table and per table number of tickets. |
startDate | It will provide a ticket type's start date. |
endDate | It will provide a ticket type's end date. |
typeId | The type id returns a unique value associated with the ticketing type. |
name | It will provide a ticket name that is set by the event host to differentiate. |
price | It contains the ticketing type price. |
fee | It will show the extra charges on the ticket amount. |
categoryColor | It will return a category color. |
categoryId | The category id returns a unique value associated with the ticketing type. |
enableTicketDescription | If its value is true then the ticket description will display. |
maxTickerPerBuyer | It will provide a count, how many tickets users can buy at a time. |
minTickerPerBuyer | It will provide a minimum count for ticket purchases. |
passFeesToBuyer | It will return true if the amount of the fee will be passed to the buyers. |
position | Ticket type position can be used to sort the ticketing type |
remaniningTickets | It will return the available ticket count. |
ticketType | It contains the ticket type e.g. FREE, PAID, or DONATION. |
ticketTypeDescription | It will return a custom description for ticket type. |
totalSoldTickets | It will return sold ticket count. |
Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.
Error Code | Error Description |
|---|---|
200 | Ok |
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. |
4040200 | Event Not Found. |