Ticket

A registration of a Badge to an Event. You must have the registration ConventionPrivilege to access this. Tickets are accessed via /api/ticket.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in TicketProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

badge

The Badge this ticket belongs to.

badgetype

The BadgeType of the ticket, if the ticket was complimentary with a BadgeType.

convention

The Convention this ticket belongs to.

event

The Event this ticket belongs to.

eventgroup

The EventGroup of the ticket, if the ticket was complimentary with an EventGroup associated with a BadgeType.

Includes

See "Includes" in Introduction for how to use them.

longname

A very descriptive name for this ticket. It pulls data from several objects, which is why it is not included by default. For a ticket, it is the shortname concatenated with a ":" and the mediumname.

mediumname

The name of the event concatenated with the user's badge name, e.g. "[event name] for [badge name/info]".

Services

The services used to fetch and manipulate tickets.

Create Ticket

You almost certainly want to add it to a ConventionCart instead of creating one. Or if you want to administratively create one, then use that method.

 POST /api/ticket

Required Params

convention_id

event_id

badge_id

Returns the same as a normal read.

Administratively Create Ticket

This will create a ticket that is fully verified. You'll need to have the registration ConventionPrivilege to do this.

 POST /api/ticket/verified

Required Params

The same as the Create Ticket service.

Returns the same as a normal read.

Read Ticket

 GET /api/ticket/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "The Captain is Dead",
   ...
 }

Update Ticket

 PUT /api/ticket/xxx

Returns the same as a normal read.

Delete Ticket

 DELETE /api/ticket/xxx

Optional params

cashdrawer_id

You need to specify this to refund if purchased with cash in the point of sale system.

Returns:

 {
   "success" : 1
 }

Mark Picked Up

 PUT /api/ticket/xxx/pick-up

Returns the same as a normal read.

Unmark Picked Up

 PUT /api/ticket/xxx/reverse-pick-up

Returns the same as a normal read.

Convert Ticket to Free

This refunds a charge for a ticket without deleting it. Use of this endpoint requires the registration privilege.

 PUT /api/ticket/xxx/convert/free

Returns the same as a normal read.

Convert Ticket

Convert a ticket purchase to a different Event. This will charge or refund the difference in the costs. This cannot be used for organizer-granted tickets.

 POST /api/ticket/xxx/convert/event/:event_id

Required Params

event_id

The ID of the Event to convert the ticket to.

Returns a normal read of the add-on converted to.

Toggle Ticket's Tournament Status

Toggle a ticket's tournament status (in tournament, or eliminated). Calling this for tickets which are not for a tournament event will raise an error.

 PUT /api/ticket/xxx/in-tournament