Event Group

Used to set up special privileges for badges, usually used with VIPs. You must have the scheduling or registration ConventionPrivilege to access this. Event Groups are accessed via /api/eventgroup.

Properties

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

Complete details in EventGroupProperties.

Related Objects

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

convention

The Convention this eventgroup belongs to.

Deprecation Note -- April 2023

Field limit_by_badge_type is no longer used. Instead, refer to an EventGroup's EventGroupBadgeTypes, max_tickets_per_badge field.

Relationships

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

badgetypes

The list of BadgeTypes that can buy Tickets for Events in this group.

eventgroupbadgetypes

Manages the relationship between event groups and BadgeTypes.

eventgroupevents

Manages the relationship between event groups and Events.

events

The list of Events that are part of this group.

Includes

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

badgetype_names

Returns an sorted array of the Event Group's associated BadgeTypes.

events_without_needed_seats

Returns an array of the Event IDs for the Group's Events lacking needed seats relative to associated BadgeTypes' available amount. Applies only to Event Groups which are tickets_autoincluded.

has_events_without_needed_seats

A flag whether any of the Event Group's associated Events lacks the needed seats relative to associated BadgeTypes' available amount. Applies only to Event Groups which are tickets_autoincluded.

offers_comp_tickets

Returns 1 (true) if the Event Group offers complimentary tickets, 0 if not.

Services

The services used to fetch and manipulate event groups.

Search Event Groups

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/eventgroup

Optional Params

query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "Charity Event",
          ...
        },
        ...
    ]
 }

Create Event Group

 POST /api/eventgroup

Required Params

convention_id

name

Returns the same as a normal read.

Read Event Group

 GET /api/eventgroup/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Charity Event",
   ...
 }

Update Event Group

 PUT /api/eventgroup/xxx

Returns the same as a normal read.

Delete Event Group

 DELETE /api/eventgroup/xxx

Returns:

 {
   "success" : 1
 }

Remaining Badge Types

Get list of BadgeTypes not associated with the Event Group.

 GET /api/eventgroup/xxx/remaining-badgetypes

Returns list of BadgeTypes.