Creative Arts Institute API

Back-end API for the Creative Arts Institute application to manage training programs, courses, reviews, users, and authentication.

Training Programs 7

Training programs CRUD functionality

Get All Training Programs  |  GET   {{URL}}/api/v1/training-programs

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Get Training Programs In Radius  |  GET   {{URL}}/api/v1/training-programs/radius/E1 7EZ/3

Description

Get training programs within a specific radius.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

raw

Create New Training Program  |  POST   {{URL}}/api/v1/training-programs

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "title": "Foundation Design Program", "description": "This foundation design program is designed to provide a strong and balanced understanding of the fundamentals of good design, as well as the principles, techniques, and best practices that make up the bedrock of the entire industry.", "phone": "(111) 111-1111", "email": "enroll@foundationdesign.com", "address": "967 Queen Street Llandrindod Wells LD21 7CJ", "careers": ["Digital Artist", "3D Character Modeller"] }
raw

Update Training Program  |  PUT   {{URL}}/api/v1/training-programs/650be519ee12dcc538fca21a

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "name": "Foundation Design Program", "email": "enroll@foundationdesign.com", "careers": [ "Digital Artist", "Other" ], }
formdata

Upload Training Program Photo  |  PUT   {{URL}}/api/v1/training-programs/5d713995b721c3bb38c1f5d0/photo

Description

Upload a photo for a specific training program in the database.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
KeyValueDescription
file

Courses 6

Create, read, update, and delete courses.

Get All Courses  |  GET   {{URL}}/api/v1/courses

Description

Get all courses from the database

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Get Courses In Training Program  |  GET   {{URL}}/api/v1/training-programs/5d713995b721c3bb38c1f5d0/courses

Description

Get courses in a specific training program.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Get Single Course  |  GET   {{URL}}/api/v1/courses/651ac7cfc13340e5753c828a

Description

Get a single course from the database

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

raw

Create New Course  |  POST   {{URL}}/api/v1/training-programs/651ac756c13340e5753c8286/courses

Description

Create a new course for a specific bootcamp

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "title": "Unreal Engine Art & Design", "description": "This course has been designed to give students an overview of blenders main tools to use 3D software to create 2D images. Students will be able to create impressive scenes suitable for presentation.", "weeks": 8, "tuition": 700, "minimumSkill": "Advanced" }
raw

Update Course  |  PUT   {{URL}}/api/v1/courses/6514420e2fce0a5340f9c968

Description

Update a specific course.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "title": "Art Foundations For Beginners", "tuition": 600 }
raw

Delete Course  |  DELETE   {{URL}}/api/v1/courses/6514420e2fce0a5340f9c968

Description

Delete a specific course from the database.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Authentication 8

Authentication for users, such as logging in, registering, etc

raw

Get Current User  |  GET   {{URL}}/api/v1/auth/me

Description

Get the currently logged in user.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

raw

Logout User  |  GET   {{URL}}/api/v1/auth/logout

Description

Logout a user from the platform, and clear cookies.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

raw

Register User  |  POST   {{URL}}/api/v1/auth/register

Description

Registers a new user and saves them to the database

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "name": "Markus Smith", "email": "markus@gmail.com", "password": "SuperSecurePassword", "role": "user" }
raw

Login User  |  POST   {{URL}}/api/v1/auth/login

Description

Login a user in from the database.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "email": "markus@gmail.com", "password": "SuperSecurePassword" }
raw

Forgot Password  |  POST   {{URL}}/api/v1/auth/forgotpassword/

Description

Generate a reset password token and send it to the users email.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "email": "markus@gmail.com" }
raw

Reset Password  |  PUT   {{URL}}/api/v1/auth/resetpassword/79ffc226a7258ca4bad1f35e5da219ce4da4c1ab

Description

Reset a users password using the token provided from the forgot password email.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "password": "SuperSecurePassword" }
raw

Update User Details  |  PUT   {{URL}}/api/v1/auth/updateDetails

Description

Update the username and email of a user.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "name": "Markus Smith", "email": "smith@gmail.com" }
raw

Update User Password  |  PUT   {{URL}}/api/v1/auth/updatepassword

Description

Allows user to update their password, after providing their current password.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "currentPassword": "CurrentSuperSecurePassword", "newPassword": "NewSuperSecurePassword" }

Users 5

User CRUD functionality for admins only.

raw

Get All Users  |  GET   {{URL}}/api/v1/users

Description

Get all the users in the database (admin).

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

raw

Get Single User  |  GET   {{URL}}/api/v1/users/651ac60a63f65c20d4c1ac3c

Description

Get a single user from the database (admin).

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

raw

Create New User  |  POST   {{URL}}/api/v1/users

Description

Create a new user and add them to the database (admin).

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "name": "Markus Smith", "email": "markus@gmail.com", "password": "SuperSecurePassword", "role": "user" }
raw

Update User  |  PUT   {{URL}}/api/v1/users/651ae41e58232828696c27fd

Description

Update a user in the database (admin).

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Body
{ "name": "Markus Smith", "email": "smith@gmail.com", "password": "UpdatedSuperSecurePassword" }
raw

Delete User  |  DELETE   {{URL}}/api/v1/users/651ae41e58232828696c27fd

Description

Delete a user from the database permanently (admin).

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Reviews 5

Provides CRUD funcitonality for reviews.

Get Reviews For Training Program  |  GET   {{URL}}/api/v1/training-programs/650be4f6ee12dcc538fca216/reviews

Description

Get all the reviews for a specific training program.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Get Single Review  |  GET   {{URL}}/api/v1/reviews/5d7a514b5d2c12c7449be022

Description

Get a single review for a training program.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

raw

Create Review  |  POST   {{URL}}/api/v1/training-programs/650be4f6ee12dcc538fca216/reviews

Description

Create a review for a specific training program.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Content-Typeapplication/json

JSON Type

Body
{ "title": "Very good training program", "body": "Taught me good art practices, would recommend", "rating": "10" }
raw

Update Review  |  PUT   {{URL}}/api/v1/reviews/651cad355ddca5f2594542db

Description

Update a specific review on a training program.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Content-Typeapplication/json

JSON Type

Body
{ "title": "Decent training program", "body": "Taught me decent art practices, would recommend", "rating": "7" }
raw

Delete Review  |  DELETE   {{URL}}/api/v1/reviews/651cad355ddca5f2594542db

Description

Delete a specific review from a training program.

Headers
KeyValueDescription
Content-Typeapplication/json

JSON Type

Content-Typeapplication/json

JSON Type