Event Resources

An event is a collection of event dates at a venue. Each event date has a venue configuration from that venue.

Gets a summary of the event

Method
GET
URL
https://api.iwannaticket.com.au/api/v2/event/{id}

Output

Name Type Description
name String The name of the Event
description String The description of the Event
heroImageUrl URL The url at which the event image may be found
landingPageUrl URL The url for the iwannaticket (non-branded) landing page
brandingLandingPageUrl URL The url for the branded landing page
lowPrice Currency The low price for the event
highPrice Currency The high price for the event. Will be the same as the low price in the case of a single ticket event.
account Ref The account of the Event.
venue Ref The Venue of the Event.
eventDates List[Ref] The Event Dates of the Event.
saleStatus SaleStatus The status of the Event.
firstDate Date The first date of the EventDates.
lastDate Date The last date of the EventDates.

Gets details of the event

Method
GET
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/detailed

This method returns all data from the event summary (as documented immediately above), plus these additional data.

Output

Name Type Description
fields List[AdditionalField] Payee additional fields
guestFields List[AdditionalFieldWithTickets] Guest additional fields
abstract String The abstract for the event (used in the account widget)
region String The 'region' for the event. This field is called 'region' even if regions are given some other name in this account
htmlDescription String The HTML description copy for this event
externalTermsUrl String A link to terms and conditions for the event.

Creates a new event

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/

Input

Name Type Description
name String Event name
venue Number Venue ID
description String Description of the event
abstractText String Abstract (short description) of the event
tags String Tags for the event
followUpEmail optional String Copy for a post-event email
barcodeEnabled optional Boolean Whether the event will use barcodes
codereadr optional Boolean Whether the event should create a CodeREADr database for scanning. You require permission from IWannaTicket to use this feature.
systemTags optional Boolean Comma-separated list of strings to set as system tags on the event. Your account must be preconfigured to set any system tags. Any tags that you try to set which are not in your account's preconfigured list will be ignored.
bankDetails optional BankDetails Each event may have its own bank details. If this is not set, account bank details are used instead.
externalTermsUrl optional String A link to terms and conditions for the event.

Updates an event

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/update

Output

Name Type Description
name optional String New name for the event
description optional String New description for the event
abstractText optional String New abstract for the event
region optional String 'Region' for the event
barcodeEnabled optional Boolean Whether the event uses barcodes or not

Sets an event hero image

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/heroImage

Input

Send the image contents as a binary body.

Updates an event banner (top of ticket) image

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/bannerImage

Input

Send the image contents as a binary body.

Updates an event footer (bottom of ticket) image

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/footerImage

Input

Send the image contents as a binary body.

List booking codes

Method
GET
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/bookingCodes

Output

Name Type Description
code String The text of the code
quantity Number How many times this code can be used
perSession Boolean Whether the code is limited to a number of uses on each event date
perSale Boolean Whether the code applies to the whole sale, or to individual tickets
requiredOnly Boolean Whether the code is consumed only by tickets which require a code
perSessionLimits String Encoding of the per-session limits

Delete booking code

Method
DELETE
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/bookingCode/{code}

Update booking code quantity

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/bookingCode/{code}

Input

Send the quantity integer as the whole body of the call.

Get sales

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/payments

Output

Name Type Description
refs List[Ref] References to each of the sales for the event.

Get admissions

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/eventAdmissions

Input

Name Type Description
fromDate long timestamp Optional querystring field. If specified will only return those admissions that were created after that timestamp (inclusive).
untilDate long timestamp Optional querystring field. If specified will only return those admissions that were created before that timestamp (exclusive).
modifiedAfter long timestamp Optional querystring field. If specified will only return those admissions that have changed and have been created since the timestamp sent as milliseconds since epoch (Unix timestamp x 1000).
If not specified will return all results in the nominated time period.

Output

List[Admission]

Apply master ticket changes

Method
PUT
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/masterTickets

Create or update an additional field

Method
POST
URL
https://api.iwannaticket.com.au/api/v2/event/{id}/additionalField

Input

Name Type Description
fieldType String FIRST_NAME, LAST_NAME, EMAIL, PHONE, OPT_IN, DOB, POSTCODE, INVOICE_TO, CONFIRM_EMAIL, CUSTOM
name Optional String The name of the field
inputType Optional String TEXT, TEXTAREA, DATE, SELECT, AUTOCOMPLETE
question Optional String The question to be shown to the ticket buyer
compulsory Optional Boolean Whether the question must be answered
sortIndex Optional Number The sort order for the field
answers Optional String Comma-separated list of responses for a SELECT field

Output

Name Type Description
id Number The unique identifier for the field