Event scheduling#
POST /api/events#
Schedule an event
Creates a new guild event. An officer must be signed in.
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 |
Overrides the kind’s default EP (effort points) award for this event. None uses the preset. |
|
string | null |
no |
Response 201 — The newly created event.
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 |
Effort points (EP, shown as Renown on the site) that attending awards. |
|
integer | null |
yes |
The officer-set EP value behind ep. None means the event’s kind sets the preset. |
|
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}#
Delete an event
Deletes an event and its signups. An officer must be signed in.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
The event’s ID. |
Response 204 — The event was deleted.
PATCH /api/events/{event_id}#
Edit an event
Edits an event, including its kind and status. An officer must be signed in. Editing an event that belongs to a series detaches it, so later series-wide edits stop touching it.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
The event’s ID. |
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 |
Overrides the kind’s default EP (effort points) award for this event. None uses the preset. |
|
string | null |
no |
|
|
EventStatus | null |
no |
Response 200 — The updated event.
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 |
Effort points (EP, shown as Renown on the site) that attending awards. |
|
integer | null |
yes |
The officer-set EP value behind ep. None means the event’s kind sets the preset. |
|
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}/signups/{signup_id}#
Set a raid chart slot
Places a signed-up player into a raid chart group (1 to 8) or the bench. An officer must be signed in. Returns 409 for any event that is not a raid.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
path |
string (uuid) |
yes |
The event’s ID. |
|
path |
string (uuid) |
yes |
The signup’s ID. |
Request body
Model: ChartUpdate
Field |
Type |
Required |
Description |
|---|---|---|---|
|
integer | null |
no |
|
|
boolean | null |
no |
Response 200 — The updated signup.
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 |