User Routes

These are the API routes to do with the users on the project.

Create a new user

POST /user/new

This will create the user on the system with the provided information in the body.

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Body

Name	Type	Description
userId	UUIDv4	Id of the user for the database
userDisplayName	string	Display name of the user in the server
userSteamId	bigint	The users steam64id
userDiscordId	bigint	The users discord id
usersFirstJoin	Date	The first date that the user joined
userLastJoin	Date	The last date that the user joined
userIpAddress	string	The users IP address that they have joined from
userHWID	string	The users HWID value of the computer they have joined from

Response

200

{
    "created": boolean
}

400

403

Get From Discord Id

GET /user/discordId/[ Discord Id ]

This will return the a user value if available

Headers

Name	Value
Content-Type	application/json

Request

Name	Type	Description
Discord Id	string	This is the users discord id

Response

200

If could find user:

{
    "userId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO"
    "userDisplayName": "string"
    "userSteamId": "bigint"
    "userDiscordId": "bigint"
    "userFirstJoin": "2024-10-26T00:00:00.000Z"
    "userLastJoin": "2024-10-26T00:00:00.000Z"
    "userIpAddress": "string"
    "userHWID": "string"
}

If could not find user:

null

Get From Steam Id

GET /user/steamId/[ Steam Id ]

This will return the a user value if available

Headers

Name	Value
Content-Type	application/json

Request

Name	Type	Description
Steam Id	bigint	This is the users steam64id

Response

200

If could find user:

{
    "userId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO"
    "userDisplayName": "string"
    "userSteamId": "bigint"
    "userDiscordId": "bigint"
    "userFirstJoin": "2024-10-26T00:00:00.000Z"
    "userLastJoin": "2024-10-26T00:00:00.000Z"
    "userIpAddress": "string"
    "userHWID": "string"
}

If could not find user:

null

Get From User Id

GET /user/userId/[ User Id ]

This will return the a user value if available

Headers

Name	Value
Content-Type	application/json

Request

Name	Type	Description
User Id	UUIDv4	This is the database id for the user

Response

200

If could find user:

{
    "userId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO"
    "userDisplayName": "string"
    "userSteamId": "bigint"
    "userDiscordId": "bigint"
    "userFirstJoin": "2024-10-26T00:00:00.000Z"
    "userLastJoin": "2024-10-26T00:00:00.000Z"
    "userIpAddress": "string"
    "userHWID": "string"
}

If could not find user:

null

Does User With Discord Id Exist

GET /user/exists/discordId/[ Discord Id ]

This will return a boolean if the API can find a user with the discord id provided

Headers

Name	Value
Content-Type	application/json

Request

Name	Type	Description
Discord Id	string	This is the users discord id

Response

200

{
    "exists": boolean
}

Does User With Steam Id Exist

GET /user/exists/steamId/[ Steam Id ]

This will return a boolean if the API can find a user with the steam id provided

Headers

Name	Value
Content-Type	application/json

Request

Name	Type	Description
Steam Id	bigint	This is the users steam64id

Response

200

{
    "exists": boolean
}

Does User With User Id Exist

GET /user/exists/userId/[ User Id ]

This will return a boolean if the API can find a user with the user id provided

Headers

Name	Value
Content-Type	application/json

Request

Name	Type	Description
User Id	UUIDv4	This is the database id for the user

Response

200

{
    "exists": boolean
}

Update Last Join From Steam Id

POST /user/updateLastJoin/steamId/[ Steam Id ]

This method will update the users last join value from their steam64id

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Request

Name	Type	Description
Steam Id	bigint	This is the users steam64id

Response

200

{
    "updated": boolean
}

400

Update Last Join From User Id

GET /user/updateLastJoin/userId/[ User Id ]

This method will update the users last join value from their user Id

Headers

Name	Value
Content-Type	application/json
Authorization	<key>

Request

Name	Type	Description
User Id	UUIDv4	This is the database id for the user

Response

200

{
    "updated": boolean
}

400