Events#
GET /api/events#
ListEvents
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
query |
string |
no |
|
|
query |
EventKind | null |
no |
Response 200 — Request fulfilled, document follows
Model: array of EventSummary
Type: array of EventSummary
POST /api/events#
CreateEvent
Request body
Model: EventCreate
Field |
Type |
Required |
Description |
|---|---|---|---|
|
yes |
||
|
string |
yes |
|
|
string |
no |
|
|
string (date-time) |
yes |
|
|
string (date-time) | null |
no |
|
|
integer | null |
no |
|
|
integer | null |
no |
|
|
string | null |
no |
Response 201 — Document created, URL follows
Model: EventDetail
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string (uuid) |
yes |
|
|
yes |
||
|
string |
yes |
|
|
string |
yes |
|
|
string (date-time) |
yes |
|
|
string (date-time) | null |
yes |
|
|
integer | null |
yes |
|
|
integer |
yes |
|
|
integer | null |
yes |
|
|
yes |
||
|
string | null |
yes |
|
|
EventCounts | null |
yes |
|
|
SeriesRef | null |
yes |
|
|
array of Signup |
yes |
|
|
Signup | null |
yes |
|
|
DiscordInterest | null |
yes |
|
|
array of SignupMember | null |
yes |
DELETE /api/events/{event_id}#
DeleteEvent
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
Response 204 — Request fulfilled, nothing follows
GET /api/events/{event_id}#
GetEvent
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
Response 200 — Request fulfilled, document follows
Model: EventDetail
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string (uuid) |
yes |
|
|
yes |
||
|
string |
yes |
|
|
string |
yes |
|
|
string (date-time) |
yes |
|
|
string (date-time) | null |
yes |
|
|
integer | null |
yes |
|
|
integer |
yes |
|
|
integer | null |
yes |
|
|
yes |
||
|
string | null |
yes |
|
|
EventCounts | null |
yes |
|
|
SeriesRef | null |
yes |
|
|
array of Signup |
yes |
|
|
Signup | null |
yes |
|
|
DiscordInterest | null |
yes |
|
|
array of SignupMember | null |
yes |
PATCH /api/events/{event_id}#
UpdateEvent
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
Request body
Model: EventUpdate
Field |
Type |
Required |
Description |
|---|---|---|---|
|
EventKind | null |
no |
|
|
string | null |
no |
|
|
string | null |
no |
|
|
string (date-time) | null |
no |
|
|
string (date-time) | null |
no |
|
|
integer | null |
no |
|
|
integer | null |
no |
|
|
string | null |
no |
|
|
EventStatus | null |
no |
Response 200 — Request fulfilled, document follows
Model: EventDetail
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string (uuid) |
yes |
|
|
yes |
||
|
string |
yes |
|
|
string |
yes |
|
|
string (date-time) |
yes |
|
|
string (date-time) | null |
yes |
|
|
integer | null |
yes |
|
|
integer |
yes |
|
|
integer | null |
yes |
|
|
yes |
||
|
string | null |
yes |
|
|
EventCounts | null |
yes |
|
|
SeriesRef | null |
yes |
|
|
array of Signup |
yes |
|
|
Signup | null |
yes |
|
|
DiscordInterest | null |
yes |
|
|
array of SignupMember | null |
yes |
DELETE /api/events/{event_id}/signup#
DeleteSignup
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
Response 204 — Request fulfilled, nothing follows
PUT /api/events/{event_id}/signup#
UpsertSignup
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
Request body
Model: SignupUpsert
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string | null |
no |
|
|
WowClass | null |
no |
|
|
SignupRole | null |
no |
|
|
yes |
||
|
string | null |
no |
Response 200 — Request fulfilled, document follows
Model: Signup
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string (uuid) |
yes |
|
|
yes |
||
|
string | null |
yes |
|
|
WowClass | null |
yes |
|
|
SignupRole | null |
yes |
|
|
yes |
||
|
string | null |
yes |
|
|
integer | null |
yes |
|
|
boolean |
yes |
|
|
string (date-time) |
yes |
PATCH /api/events/{event_id}/signups/{signup_id}#
UpdateEventChart
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
|
|
path |
string (uuid) |
yes |
Request body
Model: ChartUpdate
Field |
Type |
Required |
Description |
|---|---|---|---|
|
integer | null |
no |
|
|
boolean | null |
no |
Response 200 — Request fulfilled, document follows
Model: Signup
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string (uuid) |
yes |
|
|
yes |
||
|
string | null |
yes |
|
|
WowClass | null |
yes |
|
|
SignupRole | null |
yes |
|
|
yes |
||
|
string | null |
yes |
|
|
integer | null |
yes |
|
|
boolean |
yes |
|
|
string (date-time) |
yes |