# Events

## `GET /api/events`

**ListEvents**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `when` | query | string | no |  |
| `kind` | query | {ref}`EventKind <model-eventkind>` \| null | no |  |

**Response `200` — Request fulfilled, document follows**

Model: array of {ref}`EventSummary <model-eventsummary>`

Type: array of {ref}`EventSummary <model-eventsummary>`


## `POST /api/events`

**CreateEvent**

**Request body**

Model: {ref}`EventCreate <model-eventcreate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `kind` | {ref}`EventKind <model-eventkind>` | yes |  |
| `title` | string | yes |  |
| `location` | string | no |  |
| `starts_at` | string (date-time) | yes |  |
| `ends_at` | string (date-time) \| null | no |  |
| `size` | integer \| null | no |  |
| `ep_override` | integer \| null | no |  |
| `notes` | string \| null | no |  |

**Response `201` — Document created, URL follows**

Model: {ref}`EventDetail <model-eventdetail>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `kind` | {ref}`EventKind <model-eventkind>` | yes |  |
| `title` | string | yes |  |
| `location` | string | yes |  |
| `starts_at` | string (date-time) | yes |  |
| `ends_at` | string (date-time) \| null | yes |  |
| `size` | integer \| null | yes |  |
| `ep` | integer | yes |  |
| `ep_override` | integer \| null | yes |  |
| `status` | {ref}`EventStatus <model-eventstatus>` | yes |  |
| `notes` | string \| null | yes |  |
| `counts` | {ref}`EventCounts <model-eventcounts>` \| null | yes |  |
| `series` | {ref}`SeriesRef <model-seriesref>` \| null | yes |  |
| `signups` | array of {ref}`Signup <model-signup>` | yes |  |
| `my_signup` | {ref}`Signup <model-signup>` \| null | yes |  |
| `discord_interest` | {ref}`DiscordInterest <model-discordinterest>` \| null | yes |  |
| `away` | array of {ref}`SignupMember <model-signupmember>` \| null | yes |  |


## `DELETE /api/events/{event_id}`

**DeleteEvent**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `event_id` | path | string (uuid) | yes |  |

**Response `204`** — Request fulfilled, nothing follows


## `GET /api/events/{event_id}`

**GetEvent**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `event_id` | path | string (uuid) | yes |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EventDetail <model-eventdetail>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `kind` | {ref}`EventKind <model-eventkind>` | yes |  |
| `title` | string | yes |  |
| `location` | string | yes |  |
| `starts_at` | string (date-time) | yes |  |
| `ends_at` | string (date-time) \| null | yes |  |
| `size` | integer \| null | yes |  |
| `ep` | integer | yes |  |
| `ep_override` | integer \| null | yes |  |
| `status` | {ref}`EventStatus <model-eventstatus>` | yes |  |
| `notes` | string \| null | yes |  |
| `counts` | {ref}`EventCounts <model-eventcounts>` \| null | yes |  |
| `series` | {ref}`SeriesRef <model-seriesref>` \| null | yes |  |
| `signups` | array of {ref}`Signup <model-signup>` | yes |  |
| `my_signup` | {ref}`Signup <model-signup>` \| null | yes |  |
| `discord_interest` | {ref}`DiscordInterest <model-discordinterest>` \| null | yes |  |
| `away` | array of {ref}`SignupMember <model-signupmember>` \| null | yes |  |


## `PATCH /api/events/{event_id}`

**UpdateEvent**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `event_id` | path | string (uuid) | yes |  |

**Request body**

Model: {ref}`EventUpdate <model-eventupdate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `kind` | {ref}`EventKind <model-eventkind>` \| null | no |  |
| `title` | string \| null | no |  |
| `location` | string \| null | no |  |
| `starts_at` | string (date-time) \| null | no |  |
| `ends_at` | string (date-time) \| null | no |  |
| `size` | integer \| null | no |  |
| `ep_override` | integer \| null | no |  |
| `notes` | string \| null | no |  |
| `status` | {ref}`EventStatus <model-eventstatus>` \| null | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`EventDetail <model-eventdetail>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `kind` | {ref}`EventKind <model-eventkind>` | yes |  |
| `title` | string | yes |  |
| `location` | string | yes |  |
| `starts_at` | string (date-time) | yes |  |
| `ends_at` | string (date-time) \| null | yes |  |
| `size` | integer \| null | yes |  |
| `ep` | integer | yes |  |
| `ep_override` | integer \| null | yes |  |
| `status` | {ref}`EventStatus <model-eventstatus>` | yes |  |
| `notes` | string \| null | yes |  |
| `counts` | {ref}`EventCounts <model-eventcounts>` \| null | yes |  |
| `series` | {ref}`SeriesRef <model-seriesref>` \| null | yes |  |
| `signups` | array of {ref}`Signup <model-signup>` | yes |  |
| `my_signup` | {ref}`Signup <model-signup>` \| null | yes |  |
| `discord_interest` | {ref}`DiscordInterest <model-discordinterest>` \| null | yes |  |
| `away` | array of {ref}`SignupMember <model-signupmember>` \| null | yes |  |


## `DELETE /api/events/{event_id}/signup`

**DeleteSignup**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `event_id` | path | string (uuid) | yes |  |

**Response `204`** — Request fulfilled, nothing follows


## `PUT /api/events/{event_id}/signup`

**UpsertSignup**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `event_id` | path | string (uuid) | yes |  |

**Request body**

Model: {ref}`SignupUpsert <model-signupupsert>`

| Field | Type | Required | Description |
|---|---|---|---|
| `character` | string \| null | no |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | no |  |
| `role` | {ref}`SignupRole <model-signuprole>` \| null | no |  |
| `status` | {ref}`SignupStatus <model-signupstatus>` | yes |  |
| `comment` | string \| null | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`Signup <model-signup>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `member` | {ref}`SignupMember <model-signupmember>` | yes |  |
| `character` | string \| null | yes |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | yes |  |
| `role` | {ref}`SignupRole <model-signuprole>` \| null | yes |  |
| `status` | {ref}`SignupStatus <model-signupstatus>` | yes |  |
| `comment` | string \| null | yes |  |
| `group` | integer \| null | yes |  |
| `bench` | boolean | yes |  |
| `updated_at` | string (date-time) | yes |  |


## `PATCH /api/events/{event_id}/signups/{signup_id}`

**UpdateEventChart**

**Parameters**

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `event_id` | path | string (uuid) | yes |  |
| `signup_id` | path | string (uuid) | yes |  |

**Request body**

Model: {ref}`ChartUpdate <model-chartupdate>`

| Field | Type | Required | Description |
|---|---|---|---|
| `group` | integer \| null | no |  |
| `bench` | boolean \| null | no |  |

**Response `200` — Request fulfilled, document follows**

Model: {ref}`Signup <model-signup>`

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string (uuid) | yes |  |
| `member` | {ref}`SignupMember <model-signupmember>` | yes |  |
| `character` | string \| null | yes |  |
| `class` | {ref}`WowClass <model-wowclass>` \| null | yes |  |
| `role` | {ref}`SignupRole <model-signuprole>` \| null | yes |  |
| `status` | {ref}`SignupStatus <model-signupstatus>` | yes |  |
| `comment` | string \| null | yes |  |
| `group` | integer \| null | yes |  |
| `bench` | boolean | yes |  |
| `updated_at` | string (date-time) | yes |  |