# Xp

Manage user xp in your group.

# 🔐 Route

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

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

# Endpoints

# Check Xp

Checks the xp amount of a user

Request Body
No Request Body required for this request

Response

Code

Body

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

# Xp Add

Adds xp to a user

Request Body

{
  robloxId: number.int();
  amount: number.int();
  rankerId: number.int()?,
  reason: string.max(50)?,
}

Response

Code

Body

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

# Xp Remove

Removes xp from a user

Request Body

{
  robloxId: number.int();
  amount: number.int();
  rankerId: number.int()?,
  reason: string.max(50)?,
}

Response

Code

Body

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

# Xp Set

Sets the xp of a user

Request Body

{
  robloxId: number.int();
  amount: number.int();
  rankerId: number.int()?,
  reason: string.max(50)?,
}

Response

Code

Body

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

# Xp Clear

Clears the xp of a user

Request Body

{
  robloxId: number.int();
  type: "Total" | "Rank";
  rankerId: number.int()?;
  reason: string.max(50)?;
}

Response

Code

Body

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

# Types

# Xp Data

XpData
{
  oldXp: number.int(); // Xp before changes
  newXp: number.int(); // Xp after changes
  maxRank: boolean; // If the user is at the max rank
  rankChanged: boolean; // If a change of rank occured
  xpUntilNext: number.int(); // Xp until next rank
  xpPercentage: number.int(); // Percentage integer of current xp progress
  oldRank: number.int(); // Rank before xp changes
  newRank: number.int(); // Rank after xp changes
  prevRank: number.int(); // Rank below newRank
  nextRank: number.int(); // Rank above newRank
}