# Events

Create and manage events used for Soldier.

# 🔐 Route

This is an authenticated route.
It requires an auth header:

authentication: The bearer token contained in your authentication string
Example: Soldier HCYrY1MsaB2fd13

# Endpoints

# Get All Events

Gets all active concurrent events in the guild

Request Body
No Request Body required for this request

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event[]
  }

# Get Event

Gets one active event in the guild

Request Body
No Request Body required for this request

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event
  }

# Put Event Awardees

Overwrites all awardees for an event

Request Body

Number[]

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event
  }

# Event Awardees Add

Adds awardees to an event

Request Body

Number[]

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event
  }

# Event Awardees Remove

Removes awardees from an event

Request Body

Number[]

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event
  }

# Complete Event

Completes the event and runs the conclude action

Request Body
No Request Body required for this request

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event
  }

# Create Event

Creates a new Soldier managed event

Request Body

{
  creator: String,
  name: String.max(50),
  duration: Number.int(), // in minutes
  location: String.max(75),
  description: String.max(100)?,
  concludeAction: "Promote" | "GiveMedal" | "AddXp",
  concludeMedalId: String?,
  concludeXp: Number?
}

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event
  }

# Delete Event

Cancels the event and concludes the Discord event

Request Body
No Request Body required for this request

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Event
  }

# Types

# Event Object

Event
{
  name: string,
  eventId: string,
  concludeAction: "Promote" | "GiveMedal" | "AddXp",
  concludeMedalId: string?,
  concludeXp: number?,
  awardees: number[]
}