Event Type

Control the basic parameters of an event and its rules for scheduling and pricing. You must have the scheduling ConventionPrivilege to access this. Event Types are accessed via /api/eventtype.

Properties

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

Complete details in EventTypeProperties.

Related Objects

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

convention

The Convention this event type belongs to.

Relationships

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

allowedvolunteers

The list of EventTypeAllowedVolunteers that may volunteer to host events of this type. By itself this will only return user_ids associated with the eventtype. To include user information, see "Related Objects" in Introduction.

available_dayparts

The list of DayParts that are available to be assigned to events of this type. Good for EventSubmissions so you don't ask for a day part that is no longer available.

events

The list of Events governed by this event type.

eventtyperooms

Manages the relationship between this event type and the Rooms allowed to host this event type.

rooms

The list of Rooms allowed to host this event type.

submissions

The list of EventSubmissions goverened by this event type.

Services

The services used to fetch and manipulate event types.

Search Event Types

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

 GET /api/eventtype
Optional Params
query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "Board Game",
          ...
        },
        ...
    ]
 }

Create Event Type

 POST /api/eventtype
Required Params
convention_id
max_tickets
name
user_submittable

Returns the same as a normal read.

Read Event Type

 GET /api/eventtype/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "Board Game",
   ...
 }

Update Event Type

 PUT /api/eventtype/xxx

Returns the same as a normal read.

Delete Event Type

 DELETE /api/eventtype/xxx

Returns:

 {
   "success" : 1
 }

Add or Remove Allowed Volunteer

To add a user to a restricted list of people allowed to volunteer to host events of this type, call the following endpoint with POST. To remove a user from the list, call with DELETE.

 POST   /api/eventtype/xxx/allowedvolunteer/:user_id
 DELETE /api/eventtype/xxx/allowedvolunteer/:user_id

Returns the same as a normal read.

Remove All Allowed Volunteers

Removes all users on the restricted list of people allowed to volunteer to host events of this type.

 DELETE /api/eventtype/xxx/allowedvolunteers/all

Returns the same as a normal read.