SESC - Student Portal.postman_collection.json

{
	"info": {
		"_postman_id": "2d6b2867-67dd-4d85-8497-85df57d9e0ea",
		"name": "SESC - Student Portal",
		"description": "## ℹ️ Resources\n\n[http://localhost:8082/studentportal-docs/v1/swagger-ui/index.html](http://localhost:8082/studentportal-docs/v1/swagger-ui/index.html)",
		"schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json",
		"_exporter_id": "32686033"
	},
	"item": [
		{
			"name": "Auth",
			"item": [
				{
					"name": "Register",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"username\": \"tavi\",\n    \"password\": \"albert1234\",\n    \"email\" : \"tarkaa.albert@gmail.com\"\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": "{{base_url}}/auth/register"
					},
					"response": []
				},
				{
					"name": "Login",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"var jsonData = pm.response.json();",
									"var token = jsonData.data.authToken;",
									"",
									"pm.environment.set(\"auth_token\", token);",
									"",
									"var jsonData = pm.response.json();",
									"var studentID = jsonData.data.id;",
									"",
									"pm.environment.set(\"id\", studentID);"
								],
								"type": "text/javascript",
								"packages": {}
							}
						}
					],
					"request": {
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"username\": \"tavi\",\n    \"password\": \"albert1234\"\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": "{{base_url}}/auth/#"
					},
					"response": []
				}
			],
			"description": "**Register**: A POST request to /auth/register that allows a new user to register by providing a username, password, and email.\n\n**Login**: A POST request to /auth/# that authenticates a user by providing a username and password. The response includes an authentication token and the user's ID, which are stored as environment variables (auth_token and id, respectively) for use in subsequent requests.\n\n**Logout**: A POST request to /auth/logout that logs out the user.",
			"auth": {
				"type": "bearer",
				"bearer": {}
			},
			"event": [
				{
					"listen": "prerequest",
					"script": {
						"type": "text/javascript",
						"packages": {},
						"exec": [
							""
						]
					}
				},
				{
					"listen": "test",
					"script": {
						"type": "text/javascript",
						"packages": {},
						"exec": [
							""
						]
					}
				}
			]
		},
		{
			"name": "Student",
			"item": [
				{
					"name": "View Student Profile",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									""
								],
								"type": "text/javascript",
								"packages": {}
							}
						}
					],
					"request": {
						"auth": {
							"type": "bearer",
							"bearer": {
								"token": "{{auth_token}}"
							}
						},
						"method": "GET",
						"header": [],
						"url": "{{base_url}}/student/{{id}}"
					},
					"response": []
				},
				{
					"name": "Update Student Profile",
					"request": {
						"auth": {
							"type": "bearer",
							"bearer": {
								"token": "{{auth_token}}"
							}
						},
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"firstName\": \"codex\",\n    \"lastName\": \"alera\"\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": "{{base_url}}/student/update/{{id}}"
					},
					"response": []
				},
				{
					"name": "Get Graduation Status",
					"request": {
						"auth": {
							"type": "bearer",
							"bearer": {
								"token": "{{auth_token}}"
							}
						},
						"method": "GET",
						"header": [],
						"url": "{{base_url}}/student/getGraduationStatus/{{id}}"
					},
					"response": []
				}
			],
			"description": "**View Student Profile:** A GET request to /student/{{id}} that retrieves the profile of the student identified by the id environment variable (set during the login process).  \n  \n\n**Update Student Profile:** A POST request to /student/update/{{id}} that updates the student's first and last name."
		},
		{
			"name": "Enrollments",
			"item": [
				{
					"name": "Get data",
					"event": [
						{
							"listen": "test",
							"script": {
								"exec": [
									"pm.test(\"Status code is 200\", function () {",
									"    pm.response.to.have.status(200);",
									"});"
								],
								"type": "text/javascript",
								"packages": {}
							}
						}
					],
					"request": {
						"auth": {
							"type": "bearer",
							"bearer": {
								"token": "{{auth_token}}"
							}
						},
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{base_url}}/course/list?CourseName=labore",
							"host": [
								"{{base_url}}"
							],
							"path": [
								"course",
								"list"
							],
							"query": [
								{
									"key": "CourseName",
									"value": "labore"
								}
							]
						},
						"description": "This is a GET request and it is used to \"get\" data from an endpoint. There is no request body for a GET request, but you can use query parameters to help specify the resource you want data on (e.g., in this request, we have `id=1`).\n\nA successful GET response will have a `200 OK` status, and should include some kind of response body - for example, HTML web content or JSON data."
					},
					"response": []
				},
				{
					"name": "Enroll in Course",
					"request": {
						"auth": {
							"type": "bearer",
							"bearer": {
								"token": "{{auth_token}}"
							}
						},
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"courseCode\": \"SESC502\"\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": "{{base_url}}/course/enroll/{{id}}"
					},
					"response": []
				}
			],
			"description": "**Get data:** A GET request to /course/list that retrieves a list of courses. The CourseName query parameter can be used to filter the list by course name.\n\n**Enroll in Course:** A POST request to /course/enroll/{{id}} that enrolls the student (identified by the id environment variable) in a course specified by the courseCode in the request body."
		}
	],
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"key": "base_url",
			"value": "http://localhost:8082/api"
		},
		{
			"key": "Authorization: Bearer {{auth_token}}",
			"value": "",
			"type": "string"
		},
		{
			"key": "studentID: {{studentID}}",
			"value": "",
			"type": "string"
		}
	]
}