API Documentation

Behold: our API documentation! 📚 Click on each endpoint to see more information. All API documenation follows the following format:

Class Name 🏛️

GET/POST/PUT/DELETE: /pathToEndpoint

Description

Description of what endpoint does

Parameters

type parameter description of parameter

Return Values

{ 
"id": "String",
"message": "String",
"additionalContact": "String",
"status": "Status" 
} 

Account 🏛️

POST: /api/account

Description

Allows a user to create an account. Must be logged in with an account with Authority 'Server' to access it.

Parameters

AccoutDto the account DTO object

Return Values

An account Dto object

{
    "username": "String",
    "password": "String",
    "firstname": "String",
    "lastname": "String"
}

Theme 🏛️

POST: /api/theme?name="String"

Description

Creates a theme associated to the account sending the request

Parameters

name a url parameter, the name of the string

Return Values

A response entity with a String confirmation message of creation