0 Fork 0

Files

T

SowinskiBraeden ca4020f0ee Update DOCUMENTATION.md

2022-06-10 12:29:29 -07:00

14 KiB

Raw Blame History

School Management API Documentation

The School Management API Documentation, defining all functions and their purpose. As well as how to use the API, how to properly call functions and provide the necessary fields.

Getting Started
General Functions
Creating Accounts
Log into Accounts
Get Account
Updating Account information - (Not Documented)
- Update Student...
- Name
- Grade Level
- Homeroom
- Locker
- YOG
- Password
- Email - (Not Documented)
- Address - (Not Documented)
- Photo - (Not Documented)
- Update Teacher...
- Name - (Not Documented)
- Homeroom - (Not Documented)
- Password - (Not Documented)
- Email - (Not Documented)
- Address - (Not Documented)
- Photo - (Not Documented)
- Update Admin...
- Name - (Coming Soon)
- Password - (Coming Soon)
- Email - (Coming Soon)
- Photo - (Coming Soon)

Getting Started

Installation & Deployment

The API is an all in one package and is simple and easy to deploy. Eliminating any long unforgiving configurations you may face in other software.

Clone the repo

$ git clone https://github.com/SowinskiBraeden/school-management-api
$ cd school-management-api

Rename .env.example to .env

Enter desired values into .env

mongoURI='your mongo URI'
dbo='school'
secret='your 256 bit secret'

# Suggested port for Production: 80
# Suggested port for Development: 8000
PORT='desired port'

# This is to enable the system to send emails
SYSTEM_EMAIL='your system email'
SYSTEM_PASSWORD='your system email password'

Run the system in your terminal
```
$ go run main.go
```

Or...

Build and compile the system into an executable
```
$ go build
```

Initializing the System

Upon running the system for the first time, you will be prompted to create an admin. In order to perform many actions with the API, an Admin account is required. You will be prompted to create your default admin account seen below...

Upon completing the initial setup and creating your default administrator for the system, it is ready to use and this box will appear below, displaying basic system details seen below...

General Functions

API Status

Method: GET

<API_URL>/api/v1/status

Returns:

Status 200: OK

JSON:

{
    "success": true,
    "message": "the API is active"
}

Creating Accounts

There are several account that can be registered into the system. As you may guess they are Administrators, Teachers and Students.

Creating Administrators

You can create Administrates- who will have permissions to perform majority of the actions in the API. It is common that there are more than one Administrator to help manage the system.

Method: POST
```
<API_URL>/admin/create
```
Required:
- Logged into an existing Admin account
- JSON:
```
{
    "firstname": "John",
    "lastname": "Doe",
    "dob": "01-01-1999",
    "email": "john_doe@example.com"
}
```
Returns:
- Status 200: OK
- JSON:
```
{
    "success": true,
    "message": "successfully inserted admin"
}
```

Registering a Teacher

Obviously a school management system will require teachers to manage and teach students. Teachers have an important role for the system.

Method: POST

<API_URL>/teacher/register

Required:

Logged into an existing Admin account

JSON:

{
    "firstname": "Homer",
    "middlename": "Jay",
    "lastname": "Simson",
    "dob": "12-05-1956",
    "email": "homerdog_simpson@example.com"
}

Returns:

Status 200: OK

JSON:

{
    "success": true,
    "message": "successfully inserted teacher"
}

Enrolling a Student

What is a school without students? A professional day, but not the point. Students when their application to the school has been accepted by an admin can be enrolled into the school.

Method: POST

<API_URL>/student/enroll

Required:

Logged into an existing Admin account

JSON:

{
    "firstname": "Bart",
    "middlename": "JoJo",
    "lastname": "Simpson",
    "age": 10,
    "gradelevel": 4,
    "dob": "17-12-1979",
    "province": "...",
    "city": "Springfield",
    "address": "742 Evergreen Terrace",
    "postal": "..."
}

Returns:

Status 200: OK

JSON:

{
    "success": true,
    "successfully inserted student"
}

Additional Information After creating an account
1. After successfully creating an account for another admin, teacher or student. A school email will be generated for them using their first and last name, each formatted differently based on the type of account.
2. All users are given a random ID used to sign into the system. Each ID is a random 6 digit number.
3. Students are given a random PEN (Personal Education Number). A random 12 digit number.
4. Accounts are given a default profile image. This can be updated in the future.
(Coming Soon) 5. All new users, once have verified their email, will receive and email containing their ID.

(Currently No verified email required) 6. All new users, once have verified their email, will receive and email containing their temporary password.

Log Into Accounts

Logging into Admin

Method: POST

<API_URL>/admin/login

Required:

JSON:

{
	"tid": "123456",
	"password": "myawesomepassword123"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "correct password"
}

Logging into Teacher

Method: POST

<API_URL>/teacher/login

Required:

JSON:

{
	"tid": "123456",
	"password": "myawesomepassword123"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "correct password"
}

Logging into Student

Method: POST

<API_URL>/student/login

Required:

JSON:

{
	"sid": "123456",
	"password": "myawesomepassword123"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "correct password"
}

Get Account

Get Admin Account

Method: GET

<API_URL>/admin

Required:

Logged into an admin account

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully logged into admin",
	"admin:" <admin object>
}

Get Teacher Account

Method: GET

<API_URL>/teacher

Required:

Logged into an teacher account

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully logged into teacher",
	"teacher:" <teacher object>
}

Get Student Account

Method: GET

<API_URL>/student

Required:

Logged into an admin account

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully logged into teacher",
	"student:" <student object>
}

Updating Account Information

Update Student Name

Method: POST

<API_URL>/student/updateName

Required:

Logged into an admin account

JSON:

{
    "sid": "123456",
    "firstname": "Lisa",
    "middlename": "Marie", // (OPTIONAL)
    "lastname": "Simpson"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully updated student"
}

Update Student Grade Level

Method: POST

<API_URL>/student/updateGradeLevel

Required:

Logged into an admin account

JSON":

{
    "sid": "123456",
    "gradelevel": 11
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully updated student"
}

Update Student Homeroom

Method: POST

<API_URL>/student/updateHomeroom

Required:

Logged into an admin account

JSON:

{
    "sid": "123456",
    "homeroom": "A123"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully updated student"
}

Update Student Locker

Method: POST

<API_URL>/student/updateLocker

Required:

Logged into an admin account

JSON:

{
    "sid": "123456",
    "lockernumber": "B123"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully updated student"
}

Update Student Year of Graduation

Method: POST

<API_URL>/student/updateYOG

Required:

Logged into an admin account

JSON:

{
    "sid": "123456",
    "yog": 2020
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully updated student"
}

Update Student Password

Method: POST

<API_URL>/student/updatePassword

Required:

Logged into students account

JSON:

{
	"password": "myOldPassword",
	"newpassword1": "myNewPassword",
	"newpassword2": "myNewPassword"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully updated student password"
}

Emails student an alert of password change

Update Student Email

Method: POST

<API_URL>/student/updateEmail

Required:

Logged into an admin account or
Logged into students account

JSON:

{
	"sid": "123456", // (Only required if signed in as admin)
	"email": "BartSimpsonsCoolEmail@example.com"
}

Returns:

Status 200: OK

JSON:

{
	"success": true,
	"message": "successfully updated"
}

Update Student Address

Method: POST
```
<API_URL>/student/
```
Required:
- Logged into an admin account
Returns:
- Status 200: OK
- JSON:
```
{
	"success": true,
	"message": "successfully updated"
}
```

Update Student Photo

Method: POST
```
<API_URL>/student/
```
Required:
- Logged into an admin account
Returns:
- Status 200: OK
- JSON:
```
{
	"success": true,
	"message": "successfully updated"
}
```

Update Teacher Name

Method: POST
```
<API_URL>/teacher/
```
Required:
- Logged into an admin account
Returns:
- Status 200: OK
- JSON:
```
{
	"success": true,
	"message": "successfully updated"
}
```

Update Teacher Homeroom

Method: POST
```
<API_URL>/teacher/
```
Required:
- Logged into an admin account
Returns:
- Status 200: OK
- JSON:
```
{
	"success": true,
	"message": "successfully updated"
}
```

Update Teacher Password

Method: POST
```
<API_URL>/teacher/
```
Required:
- Logged into an admin account
Returns:
- Status 200: OK
- JSON:
```
{
	"success": true,
	"message": "successfully updated"
}
```

Update Teacher Email

Method: POST
```
<API_URL>/teacher/
```
Required:
- Logged into an admin account
Returns:
- Status 200: OK
- JSON:
```
{
	"success": true,
	"message": "successfully updated"
}
```

Update Teacher Address

Method: POST
```
<API_URL>/teacher/
```
Required:
- Logged into an admin account
Returns:
- Status 200: OK
- JSON:
```
{
	"success": true,
	"message": "successfully updated"
}
```

Update Teacher Photo
Coming Soon...

Update Admin Name
Coming Soon...

Update Admin Password
Coming Soon...

Update Admin Email
Coming Soon...

Update Admin Photo
Coming Soon...

14 KiB Raw Blame History

School Management API Documentation

Contents

Getting Started

Installation & Deployment

Initializing the System

General Functions

API Status

Creating Accounts

Creating Administrators

Registering a Teacher

Enrolling a Student

Additional Information After creating an account

Log Into Accounts

Logging into Admin

Logging into Teacher

Logging into Student

Get Account

Get Admin Account

Get Teacher Account

Get Student Account

Updating Account Information

Update Student Name

Update Student Grade Level

Update Student Homeroom

Update Student Locker

Update Student Year of Graduation

Update Student Password

Update Student Email

Update Student Address

Update Student Photo

Update Teacher Name

Update Teacher Homeroom

Update Teacher Password

Update Teacher Email

Update Teacher Address

Update Teacher Photo

Update Admin Name

Update Admin Password

Update Admin Email

Update Admin Photo

14 KiB

Raw Blame History