Event Group Event

Manages the relationship between EventGroups and Events. You must have the registration or scheduling ConventionPrivilege to access this. Event Group Events are accessed via /api/eventgroupevent.

Properties

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

Complete details in EventGroupEventProperties.

Related Objects

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

convention

The Convention this event group event belongs to.

event

The Event this event group event belongs to.

eventgroup

The EventGroup this event group event belongs to.

Includes

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

has_needed_group_seats

Returns whether the associated Event has enough seats for all BadgeTypes unreserved_quantity associated via the Event's EventGroups. 1 means true, 0 means false.

For Events not in an EventGroup this will likely still return 1 (true).

in_multiple_groups

Returns three flag values (1 means true, 0 means false):

in_multiple_groups

Whether the Event is in more than one EventGroup.

in_multiple_autoinclude_groups

Whether the Event is in more than one EventGroup that has its tickets_autoincluded set to true.

is_in_autoinclude_group

Whether any EventGroup the Event is in has its tickets_autoincluded set to true.

Services

The services used to fetch and manipulate event group events.

Search Event Group Events

This section describes basic searchability of Event Group Events, which is now available across several main endpoints.

Available Endpoints

To request Event Group Events, a user must make a request via an endpoint for a parent object. The parent objects for which this consolidated search behavior is valid are: Convention, Event, and EventGroup. Departures/differences from basic behavior will be discussed in the documentation for the specific parent=>eventgroupevent relationship. (The old endpoint GET /api/eventgroupevent, which allowed searching across conventions and users, has been made admin-only.)

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "event_id" : "xxx",
          "eventgroup_id" : "xxx",
          ...
        },
        ...
    ]
 }

Optional Params

Queryables

Pass a string query to search for a partial match in specifically allowed text fields.

Queryable fields

event.name

(can be searched only by specifying field with query_field=event.name; see options below)

eventgroup.name

(can be searched only by specifying field with query_field=eventgroup.name; see options below)

Queryable options

query_field

Event Group Event query searches must include the query_field parameter, set to one of the fields above.

Qualifiers

convention_id

event_id

eventgroup_id

Create Event Group Event

 POST /api/eventgroupevent

Required Params

eventgroup_id

event_id

Returns the same as a normal read.

Read Event Group Event

 GET /api/eventgroupevent/xxx

Returns:

 {
   "id" : "xxx",
   "event_id" : "xxx",
   ...
 }

Update Event Group Event

 PUT /api/eventgroupevent/xxx

Returns the same as a normal read.

Delete Event Group Event

 DELETE /api/eventgroupevent/xxx

Returns:

 {
   "success" : 1
 }

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 156:

You forgot a '=back' before '=head3'