Unista API Documentation 📚

*** LIVE ***

SECURITY 🔐

Payload Type, Size, Content Checker.
JWT authentication.
ACL authorization.
Rate Limiting protection. (Prevent brute force attacks)
All files are accessible only by Presigned URL (AWS S3) which will be expired after n minutes.
Define CORS policy to allow only specific domains.
Header security using Helmet package.
Passwords are hashed using in un-reversible algorithm bcrypt.
Strict endpoint validation system (IDs, etc).

API VERSIONING 📦

All routes are versioned by default GET - api/v1/courses

TECH STACK (main) 📚

NodeJS
ExpressJS
MongoDB
Mongoose

DEPLOYMENT STACK (CI/CD) 🚀

Docker
Kubernetes (AWS EKS)
AWS EC2
AWS S3
Travis CI
Nginx

Code Features 📌

CRUD (Create, Read, Update, Delete) for all resources using RESTful API design
Index Pagination - Search - Sort - Select - Filter
API Versioning (v1)
Best Practices & Clean Code (MVC, SOLID, DRY, KISS)
API Documentation
Scalable System (You can add as much features as you want without breaking the system)
Error Handling System (Genaric error handler middleware with Correct HTTP Status Code & Error message)

Unista Features 📌

TODOs 📝

Add Redis for caching
Enhance NodeJS performance My blog about node clustring
Add Chat system
Add Video conferencing system
Add Student activities system
Add Student to student learning system
Add Vote system

How we store and fetch files (AWS S3 PRESIGNED URL) 📁

Check my blog about different file upload solutions

STATISTICS 📈

API-Endpoint Routes: 157

Environment Variables 🌐

# ENV info
NODE_ENV="dev"
# PORT info
PORT_DEV="xxxxxxx"
PORT_PROD="xxxxxxx"
PORT_TEST="xxxxxxx"
# DB connection info
DB_USER_DEV="xxxxxxx"
DB_USER_PROD="xxxxxxx"
DB_USER_TEST="xxxxxxx"
DB_PASSWORD_DEV="xxxxxxx"
DB_PASSWORD_PROD="xxxxxxx"
DB_PASSWORD_TEST="xxxxxxx"
DB_HOST_DEV="xxxxxxx"
DB_HOST_PROD="xxxxxxx"
DB_HOST_TEST="xxxxxxx"
# CORS config
CORS_ORIGIN_DEV="xxxxxxx"
CORS_ORIGIN_PROD="xxxxxxx"
CORS_ORIGIN_TEST="xxxxxxx"
# REQ limit
REQUEST_LIMIT_TIMEOUT_DEV="xxxxxxx"
REQUEST_LIMIT_TIMEOUT_PROD="xxxxxxx"
REQUEST_LIMIT_TIMEOUT_TEST="xxxxxxx"
REQUEST_LIMIT_MAX_DEV="xxxxxxx"
REQUEST_LIMIT_MAX_PROD="xxxxxxx"
REQUEST_LIMIT_MAX_TEST="xxxxxxx"
# BCRYPT config
BCRYPT_SALT_ROUNDS_DEV="xxxxxxx"
BCRYPT_SALT_ROUNDS_PROD="xxxxxxx"
BCRYPT_SALT_ROUNDS_TEST="xxxxxxx"
BCRYPT_PEPPER_DEV="xxxxxxx"
BCRYPT_PEPPER_PROD="xxxxxxx"
BCRYPT_PEPPER_TEST="xxxxxxx"
# JWT config
JWT_SECRET_DEV="xxxxxxx"
JWT_SECRET_PROD="xxxxxxx"
JWT_SECRET_TEST="xxxxxxx"
JWT_EXPIRES_IN_DEV="xxxxxxx"
JWT_EXPIRES_IN_PROD="xxxxxxx"
JWT_EXPIRES_IN_TEST="xxxxxxx"
# URL
URL_DEV="xxxxxxx"
URL_TEST="xxxxxxx"
URL_PROD="xxxxxxx"
# SECRET KEYS
MASTER_SECRET_KEY_DEV="xxxxxxx"
MASTER_SECRET_KEY_TEST="xxxxxxx"
MASTER_SECRET_KEY_PROD="xxxxxxx"
# AWS
AWS_ACCESS_KEY_ID_DEV="xxxxxxx"
AWS_ACCESS_KEY_ID_TEST="xxxxxxx"
AWS_ACCESS_KEY_ID_PROD="xxxxxxx"
AWS_SECRET_ACCESS_KEY_DEV="xxxxxxx"
AWS_SECRET_ACCESS_KEY_TEST="xxxxxxx"
AWS_SECRET_ACCESS_KEY_PROD="xxxxxxx"
AWS_REGION_DEV="xxxxxxx"
AWS_REGION_TEST="xxxxxxx"
AWS_REGION_PROD="xxxxxxx"
AWS_BUCKET_NAME_DEV="xxxxxxx"
AWS_BUCKET_NAME_TEST="xxxxxxx"
AWS_BUCKET_NAME_PROD="xxxxxxx"
AWS_EXPIRES_IN_MINUTES_DEV="xxxxxxx"
AWS_EXPIRES_IN_MINUTES_TEST="xxxxxxx"
AWS_EXPIRES_IN_MINUTES_PROD="xxxxxxx"
RANDOM_CHARS_DEV="xxxxxxxxxxxxxxx"
RANDOM_CHARS_LENGTH_DEV="xxxxxxx"
RANDOM_CHARS_TEST="xxxxxxxxxxxxxxx"
RANDOM_CHARS_LENGTH_TEST="xxxxxxx"
RANDOM_CHARS_PROD="xxxxxxxxxxxxxxx"
RANDOM_CHARS_LENGTH_PROD="xxxxxxx"
API_ENDPOINT_DEV="xxxxxxx"
API_ENDPOINT_TEST="xxxxxxx"
API_ENDPOINT_PROD="xxxxxxx"
API_TOKEN_DEV="xxxxxxx"
API_TOKEN_TEST="xxxxxxx"
API_TOKEN_PROD="xxxxxxx"

Installation 📥

# Clone the repo
git clone
# Install dependencies
npm install
# Run the app
npm start
# Run the app in development mode
npm run dev:fast

Success Response Format ✅

{
  "status": "success",
  "message": "Success message",
  "data": {
    "user": {
      "id": "642debe976e91123782b7f42",
      "name": "John Doe"
    }
  }
}

Error Response Format ❌

{
  "status": "Error",
  "message": "Error message"
}

HINTS 📝

All index routes are paginated by default, you can pass page and limit as query params to change the pagination. Example: GET - api/v1/courses?page=2&limit=10

API DOCUMENTATION 📖

All Endpoints (overview) 📡

Authentication 🔐

Login ⭐

POST - api/v1/auth/login - Login Details

MASTER 🔑

UNIVERSITY ⭐

GET - api/v1/master/universities - Index Details
POST - api/v1/master/universities - Create Details
GET - api/v1/master/universities/:id - Show Details
PATCH - api/v1/master/universities/:id - Update Details
DELETE - api/v1/master/universities/:id - Delete Details

COLLAGE TYPE ⭐

POST - api/v1/master/collage-types - Create Details
GET - api/v1/master/collage-types - Index Details
GET - api/v1/master/collage-types/:id - Show Details
PATCH - api/v1/master/collage-types/:id - Update Details
DELETE - api/v1/master/collage-types/:id - Delete Details

COLLAGE ⭐

POST - api/v1/master/universities/:id/collages - Create Details
GET - api/v1/master/universities/:id/collages - Index Details
GET - api/v1/master/universities/:id/collages/:id - Show Details
PATCH - api/v1/master/universities/:id/collages/:id - Update Details
DELETE - api/v1/master/universities/:id/collages/:id - Delete Details

LEVEL ⭐

POST - api/v1/master/universities/:id/collages/levels - Create Details
GET - api/v1/master/universities/:id/collages/levels - Index Details
GET - api/v1/master/universities/:id/collages/levels/:id - Show Details
PATCH - api/v1/master/universities/:id/collages/levels/:id - Update Details
DELETE - api/v1/master/universities/:id/collages/levels/:id - Delete Details

PROFESSOR ⭐

POST - api/v1/master/universities/:id/collages/:id/professors - Create Details
GET - api/v1/master/universities/:id/collages/:id/professors - Index Details
GET - api/v1/master/universities/:id/collages/:id/professors/:id - Show Details
PATCH - api/v1/master/universities/:id/collages/:id/professors/:id - Update Details
DELETE - api/v1/master/universities/:id/collages/:id/professors/:id - Delete Details

ADMIN ⭐

POST - api/v1/master/universities/:id/collages/:id/levels/:id/admins - Create Details
GET - api/v1/master/universities/:id/collages/:id/levels/:id/admins - Index Details
GET - api/v1/master/universities/:id/collages/:id/levels/:id/admins/:id - Show Details
PATCH - api/v1/master/universities/:id/collages/:id/levels/:id/admins/:id - Update Details
DELETE - api/v1/master/universities/:id/collages/:id/levels/:id/admins/:id - Delete Details

ADMIN 👔

ACCESS PERMISSOIN ⭐

GET - api/v1/admin/:id - Show Details
PATCH - api/v1/admin/:id - Update Details

PROGRAM ⭐

POST - api/v1/admin/universities/:id/collages/:id/levels/:id/programs - Create Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs - Index Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id - Show Details
PATCH - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id - Update Details
DELETE - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id - Delete Details

DEPARTMENT ⭐

POST - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments - Create Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments - Index Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id - Show Details
PATCH - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id - Update Details
DELETE - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id - Delete Details

Student ⭐

POST - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students - Create Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students - Index Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students/:id - Show Details
PATCH - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students/:id - Update Details
DELETE - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students/:id - Delete Details

QUICK ACCESS ⭐

GET - api/v1/admin/:id/levels/:id - Show admin level Details

PROFESSOR 👨‍🏫

ACCESS PERMISSOIN ⭐

GET - api/v1/professor/:id - Show Details
PATCH - api/v1/professor/:id - Update Details

COURSE ⭐

POST - api/v1/professor/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/courses - Create Details
DELETE - api/v1/professor/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/courses/:id - Delete Details
GET - api/v1/professor/courses - Index Details
GET - api/v1/professor/courses/:id - Show Details
PATCH - api/v1/professor/courses/:id - Update Details

EBOOK ⭐

POST - api/v1/professor/courses/:id/ebook - Create Details
GET - api/v1/professor/courses/:id/ebook/:id - Show Details
PATCH - api/v1/professor/courses/:id/ebook/:id - Update Details
DELETE - api/v1/professor/courses/:id/ebook/:id - Delete Details

ASSISTANT ⭐

POST - api/v1/professor/universities/:id/collages/:id/courses/:id/assistants - Create Details
POST - api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id/attach - Attach Details
PATCH - api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id - Update Details
DELETE - api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id - Delete Details
GET - api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id - Show Details
GET - api/v1/professor/universities/:id/collages/:id/courses/:id/assistants - Index By Course Details
GET - api/v1/professor/universities/:id/collages/:id/assistants - Index By Collage Details

LECTURE ⭐

POST - api/v1/professor/courses/:id/lectures - Create Details
GET - api/v1/professor/courses/:id/lectures - Index Details
GET - api/v1/professor/courses/:id/lectures/:id - Show Details
PATCH - api/v1/professor/courses/:id/lectures/:id - Update Details
DELETE - api/v1/professor/courses/:id/lectures/:id - Delete Details

LECTURE RESOURCE ⭐

POST - api/v1/professor/courses/:id/lectures/:id/resources - Create Details
GET - api/v1/professor/courses/:id/lectures/:id/resources - Index Details
GET - api/v1/professor/courses/:id/lectures/:id/resources/:id - Show Details
PATCH - api/v1/professor/courses/:id/lectures/:id/resources/:id - Update Details
DELETE - api/v1/professor/courses/:id/lectures/:id/resources/:id - Delete Details

QUICK INDEX ⭐

GET - api/v1/professor/universities/:id/collages/:id/levels - levels Details
GET - api/v1/professor/universities/:id/collages/:id/levels/:id/programs - programs Details
GET - api/v1/professor/universities/:id/collages/:id/levels/:id/programs/:id/departments - departments Details

ATTENDANCE ( QR CODE & LOCATION ) ⭐

POST - api/v1/professor/courses/:id/lectures/:id/attendance - Create Details
GET - api/v1/professor/courses/:id/lectures/:id/attendance/:id - Show Details
GET - api/v1/professor/courses/:id/lectures/:id/attendance/:id/students - Index Students Details
DELETE - api/v1/professor/courses/:id/lectures/:id/attendance/:id/students/:id - Delete Student Details

COURSE ASSIGNMENT ⭐

POST - api/v1/professor/courses/:id/assignments - Create Details
GET - api/v1/professor/courses/:id/assignments - Index Details
GET - api/v1/professor/courses/:id/assignments/:id - Show Details
PATCH - api/v1/professor/courses/:id/assignments/:id - Update Details
DELETE - api/v1/professor/courses/:id/assignments/:id - Delete Details

COURSE ASSIGNMENT SUBMISSIONS ⭐

GET - api/v1/professor/courses/:id/assignments/:id/submissions - Index Details
GET - api/v1/professor/courses/:id/assignments/:id/submissions/:id - Show Details

EXAM ⭐

POST - api/v1/professor/courses/:id/exams - Create Details
POST - api/v1/professor/courses/:id/exams/:id/start-now - Start now Details
GET - api/v1/professor/courses/:id/exams - Index Details
GET - api/v1/professor/courses/:id/exams/:id - Show Details
PATCH - api/v1/professor/courses/:id/exams/:id - Update Details
DELETE - api/v1/professor/courses/:id/exams/:id - Delete Details

EXAM ENROLLMENTS ⭐

GET - api/v1/professor/courses/:id/exams/:id/enrollments - Index Details

EXAM SUBMISSIONS ⭐

GET - api/v1/professor/courses/:id/exams/:id/submissions - Index Details

EXAM QUESTIONS ( Text and/or Image or both ) ⭐

POST - api/v1/professor/courses/:id/exams/:id/questions - Create Details
GET - api/v1/professor/courses/:id/exams/:id/questions - Index Details
GET - api/v1/professor/courses/:id/exams/:id/questions/:id - Show Details
PATCH - api/v1/professor/courses/:id/exams/:id/questions/:id - Update Details
DELETE - api/v1/professor/courses/:id/exams/:id/questions/:id - Delete Details

EXAM QUESTION ANSWERS ⭐

PATCH - api/v1/professor/courses/:id/exams/:id/questions/:id/answers/:id - Update Details

ASSISTANT 👨‍🏫

ACCESS PERMISSOIN ⭐

GET - api/v1/assistant/:id - Show Details
PATCH - api/v1/assistant/:id - Update Details

COURSE ⭐

GET - api/v1/assistant/courses - Index Details
GET - api/v1/assistant/courses/:id - Show Details

SECTION ⭐

POST - api/v1/assistant/courses/:id/sections - Create Details
GET - api/v1/assistant/courses/:id/sections - Index Details
GET - api/v1/assistant/courses/:id/sections/:id - Show Details
PATCH - api/v1/assistant/courses/:id/sections/:id - Update Details
DELETE - api/v1/assistant/courses/:id/sections/:id - Delete Details

SECTION RESOURCES ⭐

POST - api/v1/assistant/courses/:id/sections/:id/resources - Create Details
GET - api/v1/assistant/courses/:id/sections/:id/resources - Index Details
GET - api/v1/assistant/courses/:id/sections/:id/resources/:id - Show Details
PATCH - api/v1/assistant/courses/:id/sections/:id/resources/:id - Update Details
DELETE - api/v1/assistant/courses/:id/sections/:id/resources/:id - Delete Details

ATTENDANCE ( QR CODE & LOCATION ) ⭐

POST - api/v1/assistant/courses/:id/sections/:id/attendance - Create Details
GET - api/v1/assistant/courses/:id/sections/:id/attendance/:id - Show Details
GET - api/v1/assistant/courses/:id/sections/:id/attendance/:id/students - Index Students Details
DELETE - api/v1/assistant/courses/:id/sections/:id/attendance/:id/students/:id - Delete Student Details

ASSIGNMENT ⭐

POST - api/v1/assistant/courses/:id/sections/:id/assignments - Create Details
GET - api/v1/assistant/courses/:id/sections/:id/assignments - Index Details
GET - api/v1/assistant/courses/:id/sections/:id/assignments/:id - Show Details
PATCH - api/v1/assistant/courses/:id/sections/:id/assignments/:id - Update Details
DELETE - api/v1/assistant/courses/:id/sections/:id/assignments/:id - Delete Details

ASSIGNMENT SUBMISSIONS ⭐

GET - api/v1/assistant/courses/:id/sections/:id/assignments/:id/submissions - Index Details
GET - api/v1/assistant/courses/:id/sections/:id/assignments/:id/submissions/:id - Show Details

STUDENT 👨‍🎓

ACCESS PERMISSOIN ⭐

GET - api/v1/student/:id - Show Details

COURSE ⭐

GET - api/v1/student/courses - Index Details
GET - api/v1/student/courses/:id - Show Details
POST - api/v1/student/courses/:id/enroll - Enroll Details

COURSE EXAM ⭐

GET - api/v1/student/courses/:id/exams - Index Details
POST - api/v1/student/courses/:id/exams/:id/enroll - Enroll Details
POST - api/v1/student/courses/:id/exams/:id/submit - Submit Details

COURSE ASSIGNMENT ⭐

GET - api/v1/student/courses/:id/assignments - Index Details
GET - api/v1/student/courses/:id/assignments/:id - Show Details
POST - api/v1/student/courses/:id/assignments/:id/submit - Submit Details

COURSE ASSISTANTS ⭐

GET - api/v1/student/courses/:id/assistants - Index Details

SECTION ⭐

GET - api/v1/student/courses/:id/assistants/:id/sections - Index Details
GET - api/v1/student/courses/:id/assistants/:id/sections/:id - Show Details

SECTION RESOURCES ⭐

GET - api/v1/student/courses/:id/assistants/:id/sections/:id/resources - Index Details

SECTION ASSIGNMENT ⭐

GET - api/v1/student/courses/:id/assistants/:id/sections/:id/assignments - Index Details
GET - api/v1/student/courses/:id/assistants/:id/sections/:id/assignments/:id - Show Details
POST - api/v1/student/courses/:id/assistants/:id/sections/:id/assignments/:id/submit - Submit Details

SECTION ATTENDANCE ⭐

GET - api/v1/student/courses/:id/assistants/:id/sections/:id/attendance/:id - Show Details
POST - api/v1/student/courses/:id/assistants/:id/sections/:id/attendance/:id/attend - Attend Details

LECTURE ⭐

GET - api/v1/student/courses/:id/lectures - Index Details
GET - api/v1/student/courses/:id/lectures/:id - Show Details

LECTURE RESOURCES ⭐

GET - api/v1/student/courses/:id/lectures/:id/resources - Index Details

LECTURE ATTENDANCE ⭐

GET - api/v1/student/courses/:id/lectures/:id/attendance/:id - Show Details
POST - api/v1/student/courses/:id/lectures/:id/attendance/:id/attend - Attend Details

CONTACTS ⭐

GET - api/v1/contacts/:id - Show Details
PATCH - api/v1/contacts/:id - Update Details

STORAGE ⭐

POST - api/v1/storage/:id - Upload Details
GET - api/v1/storage/:id - Access Details

All Endpoints (in details) 📡

Authentication 🔐

Login 📥

HTTP Method: POST
Endpoint URL: api/v1/auth/login
Headers: Content-Type: application/json

Request Body:

{
  "username": "username-UNIQUE", // MIN: 2 - MAX: 50
  "password": "Pass44#", // MIN: 5 - MAX: 50
  "role": "master" // OPTIONS - master, admin, user, student, assistant
}

Success Response:

{
  "status": "success",
  "message": "Master logged in successfully",
  "data": {
    "role": "master",
    "id": "642de3f48fcd08239f55f69a",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8"
  }
}

Example - JS:

let headersList = {
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  username: 'mohamed475',
  password: 'hodla475',
  role: 'master',
});

let response = await fetch('http://localhost:3000/api/v1/auth/login', {
  method: 'POST',
  body: bodyContent,
  headers: headersList,
});

let data = await response.text();
console.log(data);

MASTER 🔑

UNIVERSITY ⭐

Index universities 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Universities retrieved successfully",
  "data": {
    "universitiesCount": 2,
    "universities": [
      {
        "_id": "642deaa976e91123782b7f16",
        "name": "alu",
        "city": "alexandria",
        "country": "egypt",
        "collages": [],
        "createdAt": "2023-04-05T21:39:53.253Z",
        "updatedAt": "2023-04-05T21:39:53.253Z",
        "id": "642deaa976e91123782b7f16"
      },
      {
        "_id": "642dea4b76e91123782b7f10",
        "name": "kfu",
        "city": "kafr elsheikh",
        "country": "egypt",
        "collages": [],
        "createdAt": "2023-04-05T21:38:19.512Z",
        "updatedAt": "2023-04-05T21:38:19.512Z",
        "id": "642dea4b76e91123782b7f10"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Create university 📌

HTTP Method: POST
Endpoint URL: api/v1/master/universities
Headers: Authorization

Request Body:

{
  "name": "ALU", // MIN: 2 - MAX: 50
  "city": "Alexandria", // MIN: 2 - MAX: 50
  "country": "egypt" // MIN: 2 - MAX: 50
}

Success Response: 201

{
  "status": "success",
  "message": "University created successfully",
  "data": {
    "university": {
      "id": "642df520c6fee003857cde93"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'ALU',
  city: 'Alexandria',
  country: 'Egypt',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show university 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:universityId
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "University retrieved successfully",
  "data": {
    "university": {
      "_id": "642deaa976e91123782b7f16",
      "name": "alu",
      "city": "alex",
      "country": "egypt",
      "collages": ["642deda276e91123782b7f94"],
      "createdAt": "2023-04-05T21:39:53.253Z",
      "updatedAt": "2023-04-05T21:56:24.813Z",
      "id": "642deaa976e91123782b7f16"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update university 📌

HTTP Method: PATCH
Endpoint URL: api/v1/master/universities/:universityId
Headers: Authorization

Request Body:

{
  "name": "ALU", // MIN: 2 - MAX: 50
  "city": "Alexandria", // MIN: 2 - MAX: 50
  "country": "egypt" // MIN: 2 - MAX: 50
}

Success Response: 200

{
  "status": "success",
  "message": "University updated successfully",
  "data": {
    "university": {
      "_id": "642deaa976e91123782b7f16",
      "name": "alu",
      "city": "alex",
      "country": "egypt",
      "collages": [],
      "createdAt": "2023-04-05T21:39:53.253Z",
      "updatedAt": "2023-04-05T21:41:25.137Z",
      "id": "642deaa976e91123782b7f16"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'alu',
  city: 'Alex',
  country: 'Egypt',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete university 📌

HTTP Method: DELETE
Endpoint URL: api/v1/master/universities/:universityId
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "University deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642df520c6fee003857cde93',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

COLLAGE TYPE ⭐

Create collage type 📌

HTTP Method: POST
Endpoint URL: api/v1/master/collage-types
Headers: Authorization

Request Body:

{
  "name": "Faculty of Engineering" // MIN: 2 - MAX: 50
}

Success Response: 201

{
  "status": "success",
  "message": "Collage type created successfully",
  "data": {
    "collageType": {
      "id": "642e33a399182e5e2d14ec47"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'engineering',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/collage-types',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);
let data = await response.text();
console.log(data);

Index collage types 📌

HTTP Method: GET
Endpoint URL: api/v1/master/collage-types
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Collage types fetched successfully",
  "data": {
    "collageTypesCount": 3,
    "collageTypes": [
      {
        "_id": "642e33a399182e5e2d14ec47",
        "name": "engineering"
      },
      {
        "_id": "642debc776e91123782b7f38",
        "name": "engineering"
      },
      {
        "_id": "642deb9c76e91123782b7f35",
        "name": "computer science"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/collage-types',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show collage type 📌

HTTP Method: GET
Endpoint URL: api/v1/master/collage-types/:collageTypeId
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Collage type fetched successfully",
  "data": {
    "collageType": {
      "_id": "642debc776e91123782b7f38",
      "name": "engineering",
      "createdAt": "2023-04-05T21:44:39.114Z",
      "updatedAt": "2023-04-05T21:44:39.114Z",
      "__v": 0
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/collage-types/642debc776e91123782b7f38',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update collage type 📌

HTTP Method: PATCH
Endpoint URL: api/v1/master/collage-types/:collageTypeId
Headers: Authorization

Request Body:

{
  "name": "Faculty of Engineering" // MIN: 2 - MAX: 50
}

Success Response: 200

{
  "status": "success",
  "message": "Collage type updated successfully",
  "data": {
    "collageType": {
      "_id": "642e33a399182e5e2d14ec47",
      "name": "type name",
      "createdAt": "2023-04-06T02:51:15.552Z",
      "updatedAt": "2023-04-06T03:11:29.284Z",
      "__v": 0
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'testf',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/collage-types/642e33a399182e5e2d14ec47',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete collage type 📌

HTTP Method: DELETE
Endpoint URL: api/v1/master/collage-types/:collageTypeId
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Collage type removed successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MjkwOTYsImV4cCI6MTY4MzMyMTA5Nn0.I1OSJJ3RywdmodyvYvRu2bN-2tEwPWbEEyceFCYmTS0',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/collage-types/642e33a399182e5e2d14ec47',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Collages ⭐

Create collage 📌

HTTP Method: POST
Endpoint URL: api/v1/master/universities/:id/collages
Headers: Authorization

Request Body:

{
  "name": "fuculty of engineering",
  "type": "642debc776e91123782b7f38"
}

Success Response: 201

{
  "status": "success",
  "message": "Collage created successfully",
  "data": {
    "collage": {
      "name": "fuculty of engineering",
      "university": "642deaa976e91123782b7f16",
      "levels": [],
      "type": "642debc776e91123782b7f38",
      "professors": [],
      "assistants": [],
      "_id": "642e3cb699182e5e2d14ec59",
      "createdAt": "2023-04-06T03:29:58.750Z",
      "updatedAt": "2023-04-06T03:29:58.750Z",
      "__v": 0,
      "id": "642e3cb699182e5e2d14ec59"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'fuculty of engineering',
  type: '642debc776e91123782b7f38',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index collages 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Collage fetched successfully",
  "data": {
    "collagesCount": 2,
    "collages": [
      {
        "_id": "642e3cb699182e5e2d14ec59",
        "name": "fuculty of engineering",
        "university": "642deaa976e91123782b7f16",
        "levels": [],
        "type": {
          "_id": "642debc776e91123782b7f38",
          "name": "engineering",
          "createdAt": "2023-04-05T21:44:39.114Z",
          "updatedAt": "2023-04-05T21:44:39.114Z",
          "__v": 0,
          "id": "642debc776e91123782b7f38"
        },
        "professors": [],
        "assistants": [],
        "createdAt": "2023-04-06T03:29:58.750Z",
        "updatedAt": "2023-04-06T03:29:58.750Z",
        "__v": 0,
        "id": "642e3cb699182e5e2d14ec59"
      },
      {
        "_id": "642deda276e91123782b7f94",
        "name": "fuculty of computer & information",
        "university": "642deaa976e91123782b7f16",
        "levels": ["642def5b76e91123782b7ff5"],
        "type": {
          "_id": "642deb9c76e91123782b7f35",
          "name": "computer science",
          "createdAt": "2023-04-05T21:43:56.305Z",
          "updatedAt": "2023-04-05T21:43:56.305Z",
          "__v": 0,
          "id": "642deb9c76e91123782b7f35"
        },
        "professors": ["642df3d32c8448c0a089af25"],
        "createdAt": "2023-04-05T21:52:34.815Z",
        "updatedAt": "2023-04-05T22:23:02.145Z",
        "__v": 6,
        "assistants": [],
        "id": "642deda276e91123782b7f94"
      }
    ],
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show collage 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Collage fetched successfully",
  "data": {
    "collage": {
      "_id": "642deda276e91123782b7f94",
      "name": "fuculty of computer & information",
      "university": "642deaa976e91123782b7f16",
      "levels": ["642def5b76e91123782b7ff5"],
      "type": {
        "_id": "642deb9c76e91123782b7f35",
        "name": "computer science",
        "createdAt": "2023-04-05T21:43:56.305Z",
        "updatedAt": "2023-04-05T21:43:56.305Z",
        "__v": 0,
        "id": "642deb9c76e91123782b7f35"
      },
      "professors": ["642df3d32c8448c0a089af25"],
      "assistants": [],
      "id": "642deda276e91123782b7f94"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642deda276e91123782b7f94',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update collage 📌

HTTP Method: PATCH
Endpoint URL: api/v1/master/universities/:id/collages/:id
Headers: Authorization

Request Body:

{
  "name": "fuculty of computer & information",
  "type": "642deb9c76e91123782b7f35"
}

Success Response: 200

{
  "status": "success",
  "message": "Collage updated successfully",
  "data": {
    "updatedCollage": {
      "_id": "642deda276e91123782b7f94",
      "name": "fuculty of computer & information",
      "university": "642deaa976e91123782b7f16",
      "levels": ["642def5b76e91123782b7ff5"],
      "type": "642deb9c76e91123782b7f35",
      "professors": ["642df3d32c8448c0a089af25"],
      "createdAt": "2023-04-05T21:52:34.815Z",
      "updatedAt": "2023-04-05T22:23:02.145Z",
      "__v": 6,
      "assistants": [],
      "id": "642deda276e91123782b7f94"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'fuculty of computer & information',
  type: '642deb9c76e91123782b7f35',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642deda276e91123782b7f94',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete collage 📌

HTTP Method: DELETE
Endpoint URL: api/v1/master/universities/:id/collages/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Collage removed successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642deda276e91123782b7f94',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

LEVEL ⭐

Create level 📌

HTTP Method: POST
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels
Headers: Authorization
Request Body:
```
{
  "name": "level 01"
}
```

Success Response: 201

{
  "status": "success",
  "message": "Level created successfully",
  "data": {
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'level 01',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index levels 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Levels fetched successfully",
  "data": {
    "levelsCount": 1,
    "levels": [
      {
        "_id": "642ee7f789a92ceeba6b7a4f",
        "name": "level 01",
        "programs": [],
        "collage": "642e3cb699182e5e2d14ec59",
        "university": "642deaa976e91123782b7f16",
        "admins": [],
        "createdAt": "2023-04-06T15:40:40.000Z",
        "updatedAt": "2023-04-06T15:40:40.000Z",
        "__v": 0,
        "id": "642ee7f789a92ceeba6b7a4f"
      }
    ],
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show level 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Level fetched successfully",
  "data": {
    "level": {
      "_id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01",
      "programs": [],
      "collage": "642e3cb699182e5e2d14ec59",
      "university": "642deaa976e91123782b7f16",
      "admins": [],
      "id": "642ee7f789a92ceeba6b7a4f"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update level 📌

HTTP Method: PATCH
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id
Headers: Authorization
Request Body:
```
{
  "name": "level 01"
}
```

Success Response: 200

{
  "status": "success",
  "message": "Level updated successfully",
  "data": {
    "level": {
      "_id": "642eea412a5ae844ca7b8f6f",
      "name": "updated level",
      "programs": [],
      "collage": "642e3cb699182e5e2d14ec59",
      "university": "642deaa976e91123782b7f16",
      "admins": [],
      "createdAt": "2023-04-06T15:50:25.890Z",
      "updatedAt": "2023-04-06T15:50:33.105Z",
      "__v": 0,
      "id": "642eea412a5ae844ca7b8f6f"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'updated level',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642eea412a5ae844ca7b8f6f',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete level 📌

HTTP Method: DELETE
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Level deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642eea412a5ae844ca7b8f6f',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

ADMIN ⭐

Create admin 📌

HTTP Method: POST
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id/admins
Headers: Authorization

Request Body:

{
  "name": "admin 02",
  "email": "admin02@mail.com", // UNIQUE
  "password": "adminpassword",
  "username": "uni-admin-02" // UNIQUE
}

Success Response: 200

{
  "status": "success",
  "message": "Admin created successfully",
  "data": {
    "admin": {
      "id": "642eed3c977ee3f83d97f332"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'admin 02',
  email: 'adminf02@mail.com',
  password: 'adminpassword',
  username: 'unfi-admin-02f',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/admins',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index admins 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id/admins
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Admins fetched successfully",
  "data": {
    "adminsCount": 2,
    "admins": [
      {
        "id": "642eed3c977ee3f83d97f332",
        "createdAt": "2023-04-06T16:03:08.499Z",
        "name": "admin 02"
      },
      {
        "id": "642eecde2a5ae844ca7b8f8a",
        "createdAt": "2023-04-06T16:01:34.509Z",
        "name": "admin 02"
      }
    ],
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/admins',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show admin 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id/admins/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Admin fetched successfully",
  "data": {
    "admin": {
      "id": "642eed3c977ee3f83d97f332",
      "createdAt": "2023-04-06T16:03:08.499Z",
      "name": "admin 02",
      "username": "unfi-admin-02f",
      "email": "adminf02@mail.com",
      "qrCode": "642eed3c977ee3f83d97f330"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/admins/642eed3c977ee3f83d97f332',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update admin 📌

HTTP Method: PATCH
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id/admins/:id
Headers: Authorization

Request Body:

{
  "name": "admin updated name",
  "email": "newemail@gmail.com"
}

Success Response: 200

{
  "status": "success",
  "message": "Admin updated successfully",
  "data": {
    "admin": {
      "id": "642eed3c977ee3f83d97f332",
      "createdAt": "2023-04-06T16:03:08.499Z",
      "name": "admin updated name",
      "username": "unfi-admin-02f",
      "email": "newemail@gmail.com",
      "qrCode": "642eed3c977ee3f83d97f330"
    },
    "university": "alu",
    "collage": "fuculty of engineering",
    "level": "level 01"
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'admooosna-MASTER',
  email: 'dsf@gmail.com',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/admins/642eed3c977ee3f83d97f332',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete admin 📌

HTTP Method: DELETE
Endpoint URL: api/v1/master/universities/:id/collages/:id/levels/:id/admins/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Admin deleted successfully  ",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/admins/642eed3c977ee3f83d97f332',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

PROFESSOR ⭐

Create professor 📌

HTTP Method: POST
Endpoint URL: api/v1/master/universities/:id/collages/:id/professors
Headers: Authorization

Request Body:

{
  "name": "Mohamed Yasser",
  "password": "passCode96$",
  "username": "iammohamedyasser",
  "academicId": "120120120120"
}

Success Response: 200

{
  "status": "success",
  "message": "Professor created successfully",
  "data": {
    "professor": {
      "id": "64304c1b3eea93f118839bff"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Mohamed Yasser',
  password: 'ljslk',
  username: 'mov47f5',
  academicId: '120120120120',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/professors',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index professors 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages/:id/professors
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Professors fetched successfully",
  "data": {
    "professorsCount": 1,
    "professors": [
      {
        "id": "64304c1b3eea93f118839bff",
        "createdAt": "2023-04-07T17:00:11.784Z",
        "name": "mohamed yasser",
        "academicId": "120120120120",
        "courses": []
      }
    ],
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/professors',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show professor 📌

HTTP Method: GET
Endpoint URL: api/v1/master/universities/:id/collages/:id/professors/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Professor fetched successfully",
  "data": {
    "professor": {
      "id": "64304c1b3eea93f118839bff",
      "name": "mohamed yasser",
      "username": "mov47f5",
      "academicId": "120120120120",
      "qrCode": "64304c1b3eea93f118839bfb",
      "courses": [],
      "assistants": [],
      "contacts": "64304c1b3eea93f118839bfd"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/professors/64304c1b3eea93f118839bff',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update professor 📌

HTTP Method: PATCH
Endpoint URL: api/v1/master/universities/:id/collages/:id/professors/:id
Headers: Authorization

Request Body:

{
  "name": "Dr. Ahmed Elashry",
  "academicId": "99999999999"
}

Success Response: 200

{
  "status": "success",
  "message": "Professor updated successfully",
  "data": {
    "professor": {
      "id": "64304c1b3eea93f118839bff",
      "name": "Dr. Ahmed Elashry",
      "academicId": "99999999999"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'ali ali',
  academicId: '99999999999',
});

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/professors/64304c1b3eea93f118839bff',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete professor 📌

HTTP Method: DELETE
Endpoint URL: api/v1/master/universities/:id/collages/:id/professors/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Professor deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQyZGUzZjQ4ZmNkMDgyMzlmNTVmNjlhIiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2ODA3MzEyMjYsImV4cCI6MTY4MzMyMzIyNn0.WvDflGIDlExCao6mXYFjpEuD4dKpcfVd6sGxMeMo8F8',
};

let response = await fetch(
  'http://localhost:3000/api/v1/master/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/professors/64304c1b3eea93f118839bff',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

ADMIN 👔

PROGRAM ⭐

Create program 📌

HTTP Method: POST
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs
Headers: Authorization

Request Body:

{
  "name": "private", // [private, public]
  "tuitionFees": "1000",
  "currency": "EGP" // [EGP, USD, EUR]
}

Success Response: 201

{
  "status": "success",
  "message": "Program created successfully",
  "data": {
    "program": {
      "name": "private",
      "tuitionFees": {
        "value": 1000,
        "currency": "EGP"
      },
      "departments": [],
      "collage": "642e3cb699182e5e2d14ec59",
      "level": "642ee7f789a92ceeba6b7a4f",
      "university": "642deaa976e91123782b7f16",
      "_id": "643052c63eea93f118839c53",
      "createdAt": "2023-04-07T17:28:38.180Z",
      "updatedAt": "2023-04-07T17:28:38.180Z",
      "__v": 0,
      "id": "643052c63eea93f118839c53"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'private',
  tuitionFees: '1000',
  currency: 'EGP',
});

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index programs 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Programs fetched successfully",
  "data": {
    "programsCount": 1,
    "programs": [
      {
        "tuitionFees": {
          "value": 1000,
          "currency": "EGP"
        },
        "_id": "643052a83eea93f118839c46",
        "name": "public",
        "departments": [],
        "collage": "642e3cb699182e5e2d14ec59",
        "level": "642ee7f789a92ceeba6b7a4f",
        "university": "642deaa976e91123782b7f16",
        "createdAt": "2023-04-07T17:28:08.091Z",
        "updatedAt": "2023-04-07T17:28:08.091Z",
        "__v": 0,
        "id": "643052a83eea93f118839c46"
      }
    ],
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show program 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Programs fetched successfully",
  "data": {
    "programsCount": 1,
    "programs": [
      {
        "tuitionFees": {
          "value": 1000,
          "currency": "EGP"
        },
        "_id": "643052a83eea93f118839c46",
        "name": "public",
        "departments": [],
        "collage": "642e3cb699182e5e2d14ec59",
        "level": "642ee7f789a92ceeba6b7a4f",
        "university": "642deaa976e91123782b7f16",
        "createdAt": "2023-04-07T17:28:08.091Z",
        "updatedAt": "2023-04-07T17:28:08.091Z",
        "__v": 0,
        "id": "643052a83eea93f118839c46"
      }
    ],
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update program 📌

HTTP Method: PATCH
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id
Headers: Authorization

Request Body: name, tuitionFees

{
  "name": "public", // [public, private]
  "tuitionFees": "900",
  "currency": "USD" // [USD, EGP, EUR]
}

Success Response: 200

{
  "status": "success",
  "message": "Program updated successfully",
  "data": {
    "program": {
      "id": "643052c63eea93f118839c53",
      "name": "public",
      "tuitionFees": {
        "value": 900,
        "currency": "USD"
      }
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'public',
  tuitionFees: '900',
  currency: 'USD',
});

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052c63eea93f118839c53',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete program 📌

HTTP Method: DELETE
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Program deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052c63eea93f118839c53',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

POST - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments - Create Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments - Index Details
GET - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id - Show Details
PATCH - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id - Update Details
DELETE - api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id - Delete Details

DEPARTMENT ⭐

Create department 📌

HTTP Method: POST
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments
Headers: Authorization

Request Body: name

{
  "name": "computer science",
  "extraTuitionFees": "1000",
  "currency": "USD" // [USD, EGP, EUR]
}

Success Response: 201

{
  "status": "success",
  "message": "Department created successfully",
  "data": {
    "department": {
      "id": "64305ac8ee3e783bbc680624"
    },
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'computer science',
  extraTuitionFees: '1000',
  currency: 'egp',
});

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index departments 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Departments fetched successfully",
  "data": {
    "departmentsCount": 1,
    "departments": [
      {
        "extraTuitionFees": {
          "value": 1000,
          "currency": "EGP"
        },
        "_id": "6430596c112031c1dbfc3fd8",
        "name": "computer science",
        "courses": [],
        "program": "643052a83eea93f118839c46",
        "level": "642ee7f789a92ceeba6b7a4f",
        "collage": "642e3cb699182e5e2d14ec59",
        "university": "642deaa976e91123782b7f16",
        "students": [],
        "createdAt": "2023-04-07T17:57:00.104Z",
        "updatedAt": "2023-04-07T17:57:00.104Z",
        "__v": 0,
        "id": "6430596c112031c1dbfc3fd8"
      }
    ],
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show department 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Department fetched successfully",
  "data": {
    "department": {
      "extraTuitionFees": {
        "value": 1000,
        "currency": "EGP"
      },
      "_id": "6430596c112031c1dbfc3fd8",
      "name": "computer science",
      "courses": [],
      "program": "643052a83eea93f118839c46",
      "level": "642ee7f789a92ceeba6b7a4f",
      "collage": "642e3cb699182e5e2d14ec59",
      "university": "642deaa976e91123782b7f16",
      "students": [],
      "createdAt": "2023-04-07T17:57:00.104Z",
      "updatedAt": "2023-04-07T17:57:00.104Z",
      "__v": 0,
      "id": "6430596c112031c1dbfc3fd8"
    },
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update department 📌

HTTP Method: PATCH
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id
Headers: Authorization

Request Body: name, extraTuitionFees

{
  "name": "Information System",
  "extraTuitionFees": "100000",
  "currency": "EUR" // [EGP, USD, EUR]
}

Success Response: 200

{
  "status": "success",
  "message": "Department updated successfully",
  "data": {
    "department": {
      "id": "643059a6112031c1dbfc3fed",
      "name": "se",
      "extraTuitionFees": {
        "value": 100000,
        "currency": "EUR"
      }
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Information System',
  extraTuitionFees: '100000',
  currency: 'EUR',
});

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/643059a6112031c1dbfc3fed',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete department 📌

HTTP Method: DELETE
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Department deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/64305ac8ee3e783bbc680624',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Student ⭐

Create student 📌

HTTP Method: POST
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students
Headers: Authorization

Request Body:

{
  "name": "Mohamed Yasser",
  "password": "passCodee75&",
  "username": "mohamedyasser459f",
  "academicId": "9879873833"
}

Success Response: 201

{
  "status": "success",
  "message": "Student created successfully",
  "data": {
    "student": {
      "id": "6430629f9cd224306d04b332"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "department": {
      "id": "6430596c112031c1dbfc3fd8",
      "name": "computer science"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Mohamed Yasser',
  password: 'passCodee75&',
  username: 'mohamedyasser459f',
  academicId: '9879873833',
});

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8/students',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index students 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Students fetched successfully",
  "data": {
    "studentsCount": 1,
    "students": [
      {
        "id": "643061a4ee3e783bbc680640",
        "createdAt": "2023-04-07T18:32:04.111Z",
        "name": "mohamed yasser",
        "academicId": "9879873833",
        "courses": []
      }
    ],
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "department": {
      "id": "6430596c112031c1dbfc3fd8",
      "name": "computer science"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8/students',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show student 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Student fetched successfully",
  "data": {
    "student": {
      "id": "643061a4ee3e783bbc680640",
      "createdAt": "2023-04-07T18:32:04.111Z",
      "name": "mohamed yasser",
      "academicId": "9879873833",
      "courses": [],
      "qrCode": "643061a3ee3e783bbc68063c"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "department": {
      "id": "6430596c112031c1dbfc3fd8",
      "name": "computer science"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8/students/643061a4ee3e783bbc680640',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update student 📌

HTTP Method: PATCH
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students/:id
Headers: Authorization

Request Body: name, academicId

{
  "name": "mohamed yasser",
  "academicId": "9879873833"
}

Success Response: 200

{
  "status": "success",
  "message": "Student updated successfully",
  "data": {
    "student": {
      "id": "6430629f9cd224306d04b332",
      "name": "mohamed yasser",
      "academicId": "9879873833"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: '999',
  academicId: '999999999',
});

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8/students/6430629f9cd224306d04b332',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete student 📌

HTTP Method: DELETE
Endpoint URL: api/v1/admin/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/students/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Student deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8/students/6430629f9cd224306d04b332',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

QUICK ACCESS ⭐

Show admin level 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/:id/levels/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Admin level fetched successfully",
  "data": {
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01",
      "programs": ["643052a83eea93f118839c46"]
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/643052073eea93f118839c3e/levels/642ee7f789a92ceeba6b7a4f',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

ACCESS PERMISSOIN ⭐

Show admin 📌

HTTP Method: GET
Endpoint URL: api/v1/admin/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Admin fetched successfully",
  "data": {
    "admin": {
      "id": "643052073eea93f118839c3e",
      "createdAt": "2023-04-07T17:25:27.277Z",
      "name": "admin 02",
      "username": "unfi-admin-02f",
      "email": "adminf02@mail.com",
      "qrCode": "643052073eea93f118839c3c"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
};

let response = await fetch(
  'http://localhost:3000/api/v1/admin/643052073eea93f118839c3e',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update admin 📌

HTTP Method: PATCH
Endpoint URL: api/v1/admin/:id
Headers: Authorization

Request Body:

{
  "name": "Mohamed Yasser",
  "email": "unista-ali@gmail.com"
}

Success Response: 200

{
  "status": "success",
  "message": "Admin updated successfully",
  "data": {
    "admin": {
      "id": "643052073eea93f118839c3e",
      "name": "mohamed yasser",
      "email": "unista-ali@gmail.com"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMDUyMDczZWVhOTNmMTE4ODM5YzNlIiwicm9sZSI6ImFkbWluIn0sImlhdCI6MTY4MDg4ODM1NywiZXhwIjoxNjgzNDgwMzU3fQ.q2ECpclT0R9BoCeVq4korwQxVpS0D3E5AvFeH2y7kYo',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Mohamed Yasser',
  email: 'unista-ali@gmail.com',
});

let response = await fetch(
  'http://localhost:3000/api/v1/admin/643052073eea93f118839c3e',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

PROFESSOR 👨‍🏫

GET - api/v1/professor/:id - Show Details
PATCH - api/v1/professor/:id - Update Details

ACCESS PERMISSOIN ⭐

Show professor 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/:id
Headers: Authorization
Request Body: None

Success Response: 200

{
  "status": "success",
  "message": "Professor fetched successfully",
  "data": {
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-08T01:46:45.356Z",
      "name": "mohamed yasser",
      "username": "mov47f5",
      "academicId": "120120120120",
      "qrCode": "6430c7854e29a1ff8375d1e3",
      "courses": [],
      "contacts": "6430c7854e29a1ff8375d1e5"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/6430c7854e29a1ff8375d1e7',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update professor 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/:id
Headers: Authorization

Request Body:

{
  "name": "Dr. Mohamed Yasser",
  "academicId": "4354353453453"
}

Success Response: 200

{
  "status": "success",
  "message": "Professor updated successfully",
  "data": {
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser",
      "academicId": "4354353453453"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Dr. Mohamed Yasser',
  academicId: '4354353453453',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/6430c7854e29a1ff8375d1e7',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

COURSE ⭐

Create course 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/courses
Headers: Authorization

Request Body:

{
  "name": "Machine Learning",
  "code": "CS45",
  "semester": "first" // [first, second, summer]
}

Success Response: 201

{
  "status": "success",
  "message": "Course created successfully",
  "data": {
    "course": {
      "id": "6430cc574e29a1ff8375d202"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'machine learning',
  code: 'CS45',
  semester: 'first',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8/courses',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete course 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/universities/:id/collages/:id/levels/:id/programs/:id/departments/:id/courses/:id
Headers: Authorization

Success Response: 200

{
  "status": "success",
  "message": "Course deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments/6430596c112031c1dbfc3fd8/courses/6430cc574e29a1ff8375d202',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index courses 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses
Headers: Authorization

Success Response: 200

{
  "status": "success",
  "message": "Courses fetched successfully",
  "data": {
    "coursesCount": 1,
    "courses": [
      {
        "_id": "6430ce43c3ca49b01012f8ca",
        "name": "machine learning",
        "code": "cs45",
        "semester": "first",
        "professor": "6430c7854e29a1ff8375d1e7",
        "assistants": [],
        "students": [],
        "lectures": [],
        "sections": [],
        "assignments": [],
        "exams": [],
        "department": "6430596c112031c1dbfc3fd8",
        "program": "643052a83eea93f118839c46",
        "level": "642ee7f789a92ceeba6b7a4f",
        "collage": "642e3cb699182e5e2d14ec59",
        "university": "642deaa976e91123782b7f16",
        "createdAt": "2023-04-08T02:15:31.406Z",
        "updatedAt": "2023-04-08T02:15:31.406Z",
        "__v": 0,
        "id": "6430ce43c3ca49b01012f8ca"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch('http://localhost:3000/api/v1/professor/courses', {
  method: 'GET',
  headers: headersList,
});

let data = await response.text();
console.log(data);

Show course 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id
Headers: Authorization

Success Response: 200

{
  "status": "success",
  "message": "Course fetched successfully",
  "data": {
    "course": {
      "_id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning",
      "code": "cs45",
      "semester": "first",
      "professor": {
        "_id": "6430c7854e29a1ff8375d1e7",
        "name": "dr. mohamed yasser"
      },
      "assistants": [],
      "students": [],
      "lectures": [],
      "sections": [],
      "assignments": [],
      "exams": [],
      "department": {
        "_id": "6430596c112031c1dbfc3fd8",
        "name": "computer science"
      },
      "program": {
        "_id": "643052a83eea93f118839c46",
        "name": "public"
      },
      "level": {
        "_id": "642ee7f789a92ceeba6b7a4f",
        "name": "level 01"
      },
      "collage": {
        "_id": "642e3cb699182e5e2d14ec59",
        "name": "fuculty of engineering"
      },
      "university": {
        "_id": "642deaa976e91123782b7f16",
        "name": "alu"
      },
      "createdAt": "2023-04-08T02:15:31.406Z",
      "updatedAt": "2023-04-08T02:15:31.406Z",
      "__v": 0
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update course 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id
Headers: Authorization

Body:

{
  "name": "updated",
  "code": "SE99",
  "semester": "second"
}

Success Response: 200

{
  "status": "success",
  "message": "Course updated successfully",
  "data": {
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning",
      "code": "cs45",
      "semester": "first"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'machine learning',
  code: 'CS45',
  semester: 'first',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

EBOOK ⭐

Create ebook 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/ebook
Headers: Authorization

Body:

{
  "name": "Machine Learning Course Ebook" // File should be of type pdf
}

Success Response: 201

{
  "status": "success",
  "message": "Upload successful",
  "data": {
    "eBook": {
      "path": "courses/6430ce43c3ca49b01012f8ca/eBook/e1116f01-6e04-4fb8-8f3a-c2e50ba19752.pdf",
      "type": "application/pdf",
      "name": "Machine Learning Course Ebook",
      "owner": "6430c7854e29a1ff8375d1e7",
      "_id": "6430d28595394133234b0ca5",
      "createdAt": "2023-04-08T02:33:41.785Z",
      "updatedAt": "2023-04-08T02:33:41.785Z",
      "__v": 0,
      "id": "6430d28595394133234b0ca5"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Machine Learning Course Ebook',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/ebook',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show ebook 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/ebook/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "EBook found",
  "data": {
    "eBook": {
      "_id": "6430d28595394133234b0ca5",
      "path": "courses/6430ce43c3ca49b01012f8ca/eBook/e1116f01-6e04-4fb8-8f3a-c2e50ba19752.pdf",
      "type": "application/pdf",
      "name": "Machine Learning Course Ebook",
      "owner": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-08T02:33:41.785Z",
      "updatedAt": "2023-04-08T02:33:41.785Z",
      "__v": 0,
      "id": "6430d28595394133234b0ca5"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/ebook/6430d28595394133234b0ca5',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update ebook 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id/ebook/:id
Headers: Authorization

Body:

{
  "name": "Machine Learning Course Ebook Updated"
}

Success Response: 200

{
  "status": "success",
  "message": "eBook updated",
  "data": {
    "eBook": {
      "_id": "6430d28595394133234b0ca5",
      "path": "courses/6430ce43c3ca49b01012f8ca/eBook/e1116f01-6e04-4fb8-8f3a-c2e50ba19752.pdf",
      "type": "application/pdf",
      "name": "Machine Learning Course Ebook Updated",
      "owner": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-08T02:33:41.785Z",
      "updatedAt": "2023-04-08T02:43:30.478Z",
      "__v": 0,
      "id": "6430d28595394133234b0ca5"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Machine Learning Course Ebook Updated',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/ebook/6430d28595394133234b0ca5',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete ebook 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/courses/:id/ebook/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "eBook deleted",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/ebook/6430d28595394133234b0ca5',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

ASSISTANT ⭐

Create assistant 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/universities/:id/collages/:id/courses/:id/assistants
Headers: Authorization

Body:

{
  "name": "Mohamed Yasser",
  "academicId": "9887593780045",
  "username": "mohamed-user-09",
  "password": "passCode090"
}

Success Response: 201

{
  "status": "success",
  "message": "Assistant created successfully",
  "data": {
    "assistant": {
      "id": "6430e04795394133234b0ccd"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Mohamed Yasser',
  academicId: '9887593780045',
  username: 'mohamed-user-09',
  password: 'passCode090',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/courses/6430ce43c3ca49b01012f8ca/assistants',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Attach assistant 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id/attach
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assistant attached successfully",
  "data": {
    "assistant": {
      "id": "6430e04795394133234b0ccd",
      "courses": ["6430ce43c3ca49b01012f8ca", "6430e37e95394133234b0cdf"]
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/courses/6430e37e95394133234b0cdf/assistants/6430e04795394133234b0ccd/attach',
  {
    method: 'POST',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update assistant 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id
Headers: Authorization

Body:

{
  "name": "Mohamed Yasser",
  "academicId": "9887593780045"
}

Success Response: 200

{
  "status": "success",
  "message": "Assistant updated successfully",
  "data": {
    "assistant": {
      "id": "6430e04795394133234b0ccd",
      "name": "mohamed yasser",
      "academicId": "9887593780045"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Mohamed Yasser',
  academicId: '9887593780045',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/courses/6430ce43c3ca49b01012f8ca/assistants/6430e04795394133234b0ccd',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assistant fetched successfully",
  "data": {
    "assistant": {
      "id": "6430e04795394133234b0ccd",
      "name": "mohamed yasser",
      "academicId": "9887593780045",
      "username": "mohamed-user-09",
      "qrCode": "6430e04795394133234b0ccb",
      "courses": ["6430ce43c3ca49b01012f8ca", "6430e37e95394133234b0cdf"],
      "createdBy": "6430c7854e29a1ff8375d1e7",
      "contacts": "6430e04795394133234b0ccc"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/courses/6430ce43c3ca49b01012f8ca/assistants/6430e04795394133234b0ccd',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete assistant 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/universities/:id/collages/:id/courses/:id/assistants/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assistant deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/courses/6430ce43c3ca49b01012f8ca/assistants/6430e04795394133234b0ccd',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index assistants by course 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/universities/:id/collages/:id/courses/:id/assistants
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assistants fetched successfully",
  "data": {
    "assistantsCount": 1,
    "assistants": [
      {
        "id": "6430ed28e0848ccfef40807a",
        "name": "mohamed yasser",
        "academicId": "9887593780045",
        "courses": ["6430ce43c3ca49b01012f8ca"],
        "createdBy": "6430c7854e29a1ff8375d1e7"
      }
    ],
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/courses/6430ce43c3ca49b01012f8ca/assistants',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index assistants by collage 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/universities/:id/collages/:id/assistants
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assistants fetched successfully",
  "data": {
    "assistants": [
      {
        "id": "6430ed28e0848ccfef40807a",
        "name": "mohamed yasser",
        "academicId": "9887593780045",
        "courses": ["6430ce43c3ca49b01012f8ca"]
      }
    ],
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/assistants',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

LECTURE ⭐

Create lecture 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/lectures
Headers: Authorization

Body:

{
  "name": "Lecture 01",
  "number": 1
}

Success Response: 201

{
  "status": "success",
  "message": "Lecture created successfully",
  "data": {
    "lecture": {
      "id": "6431e66759a6e5eec1297319"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Lecture 01',
  number: 1,
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index lectures 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/lectures
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Lectures fetched successfully",
  "data": {
    "lecturesCount": 1,
    "lectures": [
      {
        "id": "6431e66759a6e5eec1297319",
        "_id": "6431e66759a6e5eec1297319",
        "name": "lecture 01",
        "number": 1,
        "resources": [],
        "course": "6430ce43c3ca49b01012f8ca",
        "professor": "6430c7854e29a1ff8375d1e7",
        "createdAt": "2023-04-08T22:10:47.415Z",
        "updatedAt": "2023-04-08T22:10:47.415Z",
        "__v": 0
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show lecture 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/lectures/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Lecture found",
  "data": {
    "lecture": {
      "_id": "6431e66759a6e5eec1297319",
      "name": "lecture 01",
      "number": 1,
      "resources": [],
      "course": "6430ce43c3ca49b01012f8ca",
      "professor": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-08T22:10:47.415Z",
      "updatedAt": "2023-04-08T22:10:47.415Z",
      "__v": 0,
      "id": "6431e66759a6e5eec1297319"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/6431e66759a6e5eec1297319',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update lecture 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id/lectures/:id
Headers: Authorization

Body:

{
  "name": "Lecture 03",
  "number": 3
}

Success Response: 200

{
  "status": "success",
  "message": "Lecture updated successfully",
  "data": {
    "lecture": {
      "id": "6431e66759a6e5eec1297319",
      "name": "lecture 03",
      "number": 3
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Lecture 03',
  number: 3,
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/6431e66759a6e5eec1297319',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete lecture 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/courses/:id/lectures/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Lecture deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/6431e66759a6e5eec1297319',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

POST - api/v1/professor/courses/:id/lectures/:id/resources - Create Details
GET - api/v1/professor/courses/:id/lectures/:id/resources - Index Details
GET - api/v1/professor/courses/:id/lectures/:id/resources/:id - Show Details
PATCH - api/v1/professor/courses/:id/lectures/:id/resources/:id - Update Details
DELETE - api/v1/professor/courses/:id/lectures/:id/resources/:id - Delete Details

LECTURE RESOURCE ⭐

Create lecture resource 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/resources
Headers: Authorization

Body:

{
  "name": "lecture 01 - resource",
  "type": "png" // Allowed types // allowed types without mime type [jpeg, png, pdf, doc, xls, docx, xlsx, pptx, mp3, mp4]
}

Success Response: 201

{
  "status": "success",
  "message": "Lecture resource created",
  "data": {
    "storage": {
      "path": "courses/6430ce43c3ca49b01012f8ca/lecture/64322cf88becbaa1fe44e152/resources/69a736e6-a1d8-4595-8053-c5740b955ca9.png",
      "type": "image/png",
      "name": "lecture 01 - resource",
      "owner": "6430c7854e29a1ff8375d1e7",
      "_id": "64322db139cfdf68bb8fe285",
      "createdAt": "2023-04-09T03:14:57.404Z",
      "updatedAt": "2023-04-09T03:14:57.404Z",
      "__v": 0,
      "id": "64322db139cfdf68bb8fe285"
    },
    "lecture": {
      "_id": "64322cf88becbaa1fe44e152",
      "name": "lecture 01",
      "number": 1,
      "resources": ["64322db139cfdf68bb8fe285"],
      "course": "6430ce43c3ca49b01012f8ca",
      "professor": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-09T03:11:52.100Z",
      "updatedAt": "2023-04-09T03:14:57.522Z",
      "__v": 1,
      "id": "64322cf88becbaa1fe44e152"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'lecture 01 - resource',
  type: 'png',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/64322cf88becbaa1fe44e152/resources',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index lecture resources 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/resources
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Resources fetched successfully",
  "data": {
    "resources": [
      {
        "_id": "64322db139cfdf68bb8fe285",
        "type": "image/png",
        "name": "lecture 01 - resource",
        "id": "64322db139cfdf68bb8fe285"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/64322cf88becbaa1fe44e152/resources',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show lecture resource 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/resources/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Resource fetched successfully",
  "data": {
    "resource": {
      "_id": "64322db139cfdf68bb8fe285",
      "path": "courses/6430ce43c3ca49b01012f8ca/lecture/64322cf88becbaa1fe44e152/resources/69a736e6-a1d8-4595-8053-c5740b955ca9.png",
      "type": "image/png",
      "name": "new resource name",
      "owner": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-09T03:14:57.404Z",
      "updatedAt": "2023-04-09T03:18:33.343Z",
      "__v": 0,
      "id": "64322db139cfdf68bb8fe285"
    },
    "lecture": {
      "id": "64322cf88becbaa1fe44e152",
      "name": "lecture 01"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/64322cf88becbaa1fe44e152/resources/64322db139cfdf68bb8fe285',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update lecture resource 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/resources/:id
Headers: Authorization
Body: name
```
{
  "name": "new resource name"
}
```

Success Response: 200

{
  "status": "success",
  "message": "Resource updated successfully",
  "data": {
    "resource": {
      "_id": "64322db139cfdf68bb8fe285",
      "path": "courses/6430ce43c3ca49b01012f8ca/lecture/64322cf88becbaa1fe44e152/resources/69a736e6-a1d8-4595-8053-c5740b955ca9.png",
      "type": "image/png",
      "name": "new resource name",
      "owner": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-09T03:14:57.404Z",
      "updatedAt": "2023-04-09T03:18:33.343Z",
      "__v": 0,
      "id": "64322db139cfdf68bb8fe285"
    },
    "lecture": {
      "id": "64322cf88becbaa1fe44e152",
      "name": "lecture 01"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'new resource name',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/64322cf88becbaa1fe44e152/resources/64322db139cfdf68bb8fe285',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete lecture resource 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/resources/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Resource removed successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/64322cf88becbaa1fe44e152/resources/64322db139cfdf68bb8fe285',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

QUICK Index ⭐

Index levels professor 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/universities/:id/collages/:id/levels
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Levels fetched successfully",
  "data": {
    "levels": [
      {
        "id": "642ee7f789a92ceeba6b7a4f",
        "name": "level 01"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index programs professor 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/universities/:id/collages/:id/levels/:id/programs
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Programs fetched successfully",
  "data": {
    "programs": [
      {
        "id": "643052a83eea93f118839c46",
        "name": "public"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index departments professor 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/universities/:id/collages/:id/levels/:id/programs/:id/departments
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Departments fetched successfully",
  "data": {
    "departments": [
      {
        "id": "6430596c112031c1dbfc3fd8",
        "name": "computer science"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/universities/642deaa976e91123782b7f16/collages/642e3cb699182e5e2d14ec59/levels/642ee7f789a92ceeba6b7a4f/programs/643052a83eea93f118839c46/departments',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

ATTENDANCE ⭐

Create attendance 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/attendance
Headers: Authorization

Body:

{
  "distanceInMeters": 100,
  "durationInMinutes": 2,
  "lat": "30.9977",
  "lng": "29.7432"
}

Success Response: 200

{
  "status": "success",
  "message": "Attendance created successfully.",
  "data": {
    "attendance": {
      "students": [],
      "lecture": "64322cf88becbaa1fe44e152",
      "distanceInMeters": 100,
      "creatorCoordinates": {
        "lat": "30.9977",
        "lng": "29.7432"
      },
      "durationInMinutes": 2,
      "expiredAt": "2023-04-09T15:16:39.557Z",
      "randomAccessKey": "W0oGmjIXsW",
      "_id": "6432d65f19c58a344497f49c",
      "createdAt": "2023-04-09T15:14:39.571Z",
      "updatedAt": "2023-04-09T15:14:39.571Z",
      "__v": 0,
      "id": "6432d65f19c58a344497f49c"
    },
    "lecture": {
      "id": "64322cf88becbaa1fe44e152",
      "name": "lecture 01"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  distanceInMeters: 100,
  durationInMinutes: 2,
  lat: '30.9977',
  lng: '29.7432',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/64322cf88becbaa1fe44e152/attendance',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show attendance 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/attendance/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Attendance fetched successfully",
  "data": {
    "attendance": {
      "creatorCoordinates": {
        "lat": "30.9977",
        "lng": "29.7432"
      },
      "_id": "6432d88c19c58a344497f4ba",
      "students": [],
      "lecture": "6432d85e19c58a344497f4b4",
      "distanceInMeters": 100,
      "durationInMinutes": 2,
      "expiredAt": "2023-04-09T15:25:56.657Z",
      "randomAccessKey": "yUvrasLv20",
      "createdAt": "2023-04-09T15:23:56.658Z",
      "updatedAt": "2023-04-09T15:23:56.658Z",
      "__v": 0,
      "id": "6432d88c19c58a344497f4ba"
    },
    "isExpired": true
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/6432d85e19c58a344497f4b4/attendance/6432d88c19c58a344497f4ba',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index attendance students 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/attendance/:id/students
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Students fetched successfully",
  "data": {
    "students": [],
    "isExpired": true
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/6432d85e19c58a344497f4b4/attendance/6432d88c19c58a344497f4ba/students',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete attendance student 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/courses/:id/lectures/:id/attendance/:id/students/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Student removed successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/lectures/6432d85e19c58a344497f4b4/attendance/6432d88c19c58a344497f4ba/students/6432d85e19c58a344497f4b4',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

COURSE ASSIGNMENT ⭐

Create course assignment 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/assignments
Headers: Authorization

Body:

{
  "title": "Python CGI",
  "contentText": "In this assignment you should create a full python server side application and apply all CGI concepts we have learned in the lecture and section",
  "dueToDays": 7
}

Success Response: 201

{
  "status": "success",
  "message": "Assignment created",
  "data": {
    "assignment": {
      "id": "6432dd2ddde93cf76c5dadc8"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  title: 'Python CGI',
  contentText:
    'In this assignment you should create a full python server side application and apply all CGI concepts we have learned in the lecture and section',
  dueToDays: 7,
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/assignments',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index course assignments 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/assignments
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignments fetched successfully",
  "data": {
    "assignmentsCount": 1,
    "assignments": [
      {
        "id": "6432dd2ddde93cf76c5dadc8",
        "_id": "6432dd2ddde93cf76c5dadc8",
        "title": "python cgi",
        "contentText": "In this assignment you should create a full python server side application and apply all CGI concepts we have learned in the lecture and section",
        "contentImage": "6432dd2ddde93cf76c5dadc7",
        "dueDate": "2023-04-16T15:43:41.808Z",
        "professor": "6430c7854e29a1ff8375d1e7",
        "course": "6430ce43c3ca49b01012f8ca",
        "submissions": [],
        "createdAt": "2023-04-09T15:43:42.052Z",
        "updatedAt": "2023-04-09T15:43:42.052Z",
        "__v": 0
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/assignments',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show course assignment 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/assignments/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignments fetched successfully",
  "data": {
    "assignmentsCount": 1,
    "assignments": [
      {
        "id": "6432dd2ddde93cf76c5dadc8",
        "_id": "6432dd2ddde93cf76c5dadc8",
        "title": "python cgi",
        "contentText": "In this assignment you should create a full python server side application and apply all CGI concepts we have learned in the lecture and section",
        "contentImage": "6432dd2ddde93cf76c5dadc7",
        "dueDate": "2023-04-16T15:43:41.808Z",
        "professor": "6430c7854e29a1ff8375d1e7",
        "course": "6430ce43c3ca49b01012f8ca",
        "submissions": [],
        "createdAt": "2023-04-09T15:43:42.052Z",
        "updatedAt": "2023-04-09T15:43:42.052Z",
        "__v": 0
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/assignments/6432dd2ddde93cf76c5dadc8',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update course assignment 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id/assignments/:id
Headers: Authorization

Body:

{
  "title": "New title",
  "contentText": "New content text",
  "dueToDays": 10
}

Success Response: 200

{
  "status": "success",
  "message": "The assignment updated successfully",
  "data": {
    "assignment": {
      "_id": "6432dd2ddde93cf76c5dadc8",
      "title": "new title",
      "contentText": "New content text",
      "contentImage": "6432dd2ddde93cf76c5dadc7",
      "dueDate": "2023-04-19T15:52:40.136Z",
      "professor": "6430c7854e29a1ff8375d1e7",
      "course": "6430ce43c3ca49b01012f8ca",
      "submissions": [],
      "createdAt": "2023-04-09T15:43:42.052Z",
      "updatedAt": "2023-04-09T15:52:40.249Z",
      "__v": 0,
      "id": "6432dd2ddde93cf76c5dadc8"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  title: 'New title',
  contentText: 'New content text',
  dueToDays: 10,
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/assignments/6432dd2ddde93cf76c5dadc8',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete course assignment 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/courses/:id/assignments/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignment removed successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/assignments/6432dd2ddde93cf76c5dadc8',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

GET - api/v1/professor/courses/:id/assignments/:id/submissions - Index Details
GET - api/v1/professor/courses/:id/assignments/:id/submissions/:id - Show Details

COURSE ASSIGNMENT SUBMISSIONS ⭐

Index course assignment submissions 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/assignments/:id/submissions
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Submissions fetched successfully",
  "data": {
    "submissionsCount": 0,
    "submissions": []
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/assignments/6432e0d4dde93cf76c5dade9/submissions',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show course assignment submission 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/assignments/:id/submissions/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Submission fetched successfully",
  "data": {
    "submission": {
      "grade": 0,
      "feedback": "",
      "assignment": "6432e0d4dde93cf76c5dade9",
      "student": "6430ce43c3ca49b01012f8ca",
      "createdAt": "2023-04-09T15:43:42.052Z",
      "updatedAt": "2023-04-09T15:52:40.249Z",
      "__v": 0,
      "id": "6432e0d4dde93cf76c5dade9"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430ce43c3ca49b01012f8ca/assignments/6432e0d4dde93cf76c5dade9/submissions/6432e0d4dde93cf76c5dade9',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

EXAM ⭐

Create exam 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/exams
Headers: Authorization

Body:

{
  "name": "Exam 01",
  "startAtDay": "6",
  "startAtMonth": "4",
  "startAtYear": "2023",
  "startAtHour": "12",
  "startAtMinute": "30",
  "durationInMinutes": "20"
}

Success Response: 201

{
  "status": "success",
  "message": "Exam created successfully.",
  "data": {
    "exam": {
      "name": "exam 01",
      "startAt": "2023-04-10T10:30:00.000Z",
      "durationInMinutes": 20,
      "endAt": "2023-04-10T10:50:00.000Z",
      "course": "6430e37e95394133234b0cdf",
      "questions": [],
      "totalScore": 0,
      "submissions": [],
      "enrollments": [],
      "professor": "6430c7854e29a1ff8375d1e7",
      "_id": "6432e33bdde93cf76c5dae02",
      "createdAt": "2023-04-09T16:09:31.782Z",
      "updatedAt": "2023-04-09T16:09:31.782Z",
      "__v": 0
    },
    "course": {
      "id": "6430e37e95394133234b0cdf",
      "name": "image processing"
    },
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Exam 01',
  startAtDay: '10',
  startAtMonth: '4',
  startAtYear: '2023',
  startAtHour: '12',
  startAtMinute: '30',
  durationInMinutes: '20',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index exams 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/exams
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Exams fetched successfully",
  "data": {
    "examsCount": 1,
    "exams": [
      {
        "id": "6432e33bdde93cf76c5dae02",
        "_id": "6432e33bdde93cf76c5dae02",
        "name": "exam 01",
        "startAt": "2023-04-10T10:30:00.000Z",
        "durationInMinutes": 20,
        "endAt": "2023-04-10T10:50:00.000Z",
        "course": "6430e37e95394133234b0cdf",
        "questions": [],
        "totalScore": 0,
        "submissions": [],
        "enrollments": [],
        "professor": "6430c7854e29a1ff8375d1e7",
        "createdAt": "2023-04-09T16:09:31.782Z",
        "updatedAt": "2023-04-09T16:09:31.782Z",
        "__v": 0
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show exam 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/exams/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Exam fetched successfully",
  "data": {
    "exam": {
      "id": "6432e33bdde93cf76c5dae02",
      "_id": "6432e33bdde93cf76c5dae02",
      "name": "exam 01",
      "startAt": "2023-04-10T10:30:00.000Z",
      "durationInMinutes": 20,
      "endAt": "2023-04-10T10:50:00.000Z",
      "course": "6430e37e95394133234b0cdf",
      "questions": [],
      "totalScore": 0,
      "submissions": [],
      "enrollments": [],
      "professor": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-09T16:09:31.782Z",
      "updatedAt": "2023-04-09T16:09:31.782Z",
      "__v": 0
    },
    "course": {
      "id": "6430e37e95394133234b0cdf",
      "name": "image processing"
    },
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6432e33bdde93cf76c5dae02',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update exam 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id/exams/:id
Headers: Authorization

Body:

{
  "name": "exam 99",
  "startAtDay": "6",
  "startAtMonth": "10",
  "startAtYear": "2023",
  "startAtHour": "15",
  "startAtMinute": "10",
  "durationInMinutes": "20"
}

Success Response: 200

{
  "status": "success",
  "message": "Exam updated successfully.",
  "data": {
    "exam": {
      "id": "6432e33bdde93cf76c5dae02",
      "name": "exam 99",
      "startAt": "2023-10-06T13:10:00.000Z",
      "endAt": "2023-10-06T13:30:00.000Z",
      "durationInMinutes": 20
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'exam 99',
  startAtDay: '6',
  startAtMonth: '10',
  startAtYear: '2023',
  startAtHour: '15',
  startAtMinute: '10',
  durationInMinutes: '20',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6432e33bdde93cf76c5dae02',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete exam 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/courses/:id/exams/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Exam deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6432e33bdde93cf76c5dae02',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Start now exam 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/exams/:id/start-now
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Exam will start now.",
  "data": {
    "exam": {
      "id": "6432e59cdde93cf76c5dae17",
      "name": "exam 01"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6432e59cdde93cf76c5dae17/start-now',
  {
    method: 'PATCH',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

EXAM SUBMISSIONS ⭐

Index exam submissions 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/exams/:id/submissions
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Exam submissions fetched successfully",
  "data": {
    "examSubmissionsCount": 0,
    "examSubmissions": [],
    "exam": {
      "id": "6432e59cdde93cf76c5dae17",
      "name": "exam 01"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6432e59cdde93cf76c5dae17/submissions',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

GET - api/v1/professor/courses/:id/exams/:id/enrollments - Index Details

EXAM ENROLLMENTS ⭐

Index exam enrollments 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/exams/:id/enrollments
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Exam enrollments fetched successfully",
  "data": {
    "examEnrollmentsCount": 0,
    "examEnrollments": [],
    "exam": {
      "id": "6432e59cdde93cf76c5dae17",
      "name": "exam 01"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6432e59cdde93cf76c5dae17/enrollments',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

EXAM QUESTIONS ( Text and/or Image or both ) ⭐

Create exam question 📌

HTTP Method: POST
Endpoint URL: api/v1/professor/courses/:id/exams/:id/questions
Headers: Authorization

Body:

{
  "contentText": "Question 2",
  "contentImage": "true",
  "score": "7",
  "answersArray": ["answer 1", "answer 2", "answer 3"],
  "correctAnswerIndex": "1" // 0 based index [0, 1, 2, 3, ...]
}

Success Response: 201

{
  "status": "success",
  "message": "Question created successfully",
  "data": {
    "question": {
      "contentText": "Question 2",
      "contentImage": "64330490101ff077ea74633f",
      "answers": [
        "64330490101ff077ea746341",
        "64330490101ff077ea746343",
        "64330490101ff077ea746345"
      ],
      "score": 7,
      "course": "6430e37e95394133234b0cdf",
      "professor": "6430c7854e29a1ff8375d1e7",
      "exam": "6433047d101ff077ea746339",
      "_id": "64330490101ff077ea746340",
      "correctAnswer": "64330490101ff077ea746343",
      "createdAt": "2023-04-09T18:31:44.840Z",
      "updatedAt": "2023-04-09T18:31:44.840Z",
      "__v": 0,
      "id": "64330490101ff077ea746340"
    },
    "exam": {
      "id": "6433047d101ff077ea746339",
      "name": "exam 01"
    },
    "course": {
      "id": "6430e37e95394133234b0cdf",
      "name": "image processing"
    },
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  contentText: 'Question 2',
  contentImage: 'true',
  score: '7',
  answersArray: ['answer 1', 'answer 2', 'answer 3'],
  correctAnswerIndex: '1',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6433047d101ff077ea746339/questions',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index exam questions 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/exams/:id/questions
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Questions fetched successfully",
  "data": {
    "questionsCount": 1,
    "questions": [
      {
        "id": "64330490101ff077ea746340",
        "contentText": "Question 2",
        "score": 7
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6433047d101ff077ea746339/questions',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show exam question 📌

HTTP Method: GET
Endpoint URL: api/v1/professor/courses/:id/exams/:id/questions/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Question fetched successfully",
  "data": {
    "question": {
      "id": "64330490101ff077ea746340",
      "contentText": "Question 2",
      "contentImage": "64330490101ff077ea74633f",
      "score": 7,
      "answers": [
        {
          "id": "64330490101ff077ea746341",
          "contentText": "answer 1"
        },
        {
          "id": "64330490101ff077ea746343",
          "contentText": "answer 2"
        },
        {
          "id": "64330490101ff077ea746345",
          "contentText": "answer 3"
        }
      ],
      "correctAnswerId": "64330490101ff077ea746343"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6433047d101ff077ea746339/questions/64330490101ff077ea746340',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update exam question 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id/exams/:id/questions/:id
Headers: Authorization

Body:

{
  "contentText": "this is a question!!",
  "score": "5",
  "correctAnswerId": "64330490101ff077ea746341"
}

Success Response: 200

{
  "status": "success",
  "message": "question updated successfully",
  "data": {
    "question": {
      "id": "64330490101ff077ea746340",
      "contentText": "this is a question!!",
      "score": 5,
      "correctAnswer": "64330490101ff077ea746341"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  contentText: 'this is a question!!',
  score: '5',
  correctAnswerId: '64330490101ff077ea746341',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6433047d101ff077ea746339/questions/64330490101ff077ea746340',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete exam question 📌

HTTP Method: DELETE
Endpoint URL: api/v1/professor/courses/:id/exams/:id/questions/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Question deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
};

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6433047d101ff077ea746339/questions/64330490101ff077ea746340',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

PATCH - api/v1/professor/courses/:id/exams/:id/questions/:id/answers/:id - Update Details

EXAM QUESTION ANSWERS ⭐

Update exam question answer 📌

HTTP Method: PATCH
Endpoint URL: api/v1/professor/courses/:id/exams/:id/questions/:id/answers/:id
Headers: Authorization
Body:
```
{
  "contentText": "new answer"
}
```

Success Response: 200

{
  "status": "success",
  "message": "Answer updated successfully",
  "data": {
    "answer": {
      "id": "6433086febda70cf0481c977",
      "contentText": "new answer"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGM3ODU0ZTI5YTFmZjgzNzVkMWU3Iiwicm9sZSI6InByb2Zlc3NvciJ9LCJpYXQiOjE2ODA5MTg0MjgsImV4cCI6MTY4MzUxMDQyOH0.tsqXjcQK_OSHtX8Q9cM__7Kcj6CLCMm2u2hkp3qoMEU',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  contentText: 'new answer',
});

let response = await fetch(
  'http://localhost:3000/api/v1/professor/courses/6430e37e95394133234b0cdf/exams/6433047d101ff077ea746339/questions/6433086febda70cf0481c976/answers/6433086febda70cf0481c977',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

ASSISTANT 👨‍🏫

ACCESS PERMISSOIN ⭐

Show assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "assistant fetched successfully",
  "data": {
    "assistant": {
      "id": "6430ed28e0848ccfef40807a",
      "createdAt": "2023-04-08T04:27:20.066Z",
      "name": "mohamed yasser",
      "username": "mohamed-user-09",
      "academicId": "9887593780045",
      "qrCode": "6430ed28e0848ccfef408078",
      "courses": ["6430ce43c3ca49b01012f8ca"],
      "contacts": "6430ed28e0848ccfef408079"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/6430ed28e0848ccfef40807a',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update assistant 📌

HTTP Method: PATCH
Endpoint URL: api/v1/assistant/:id
Headers: Authorization

Body:

{
  "name": "my new name",
  "academicId": "878978798978"
}

Success Response: 200

{
  "status": "success",
  "message": "assistant updated successfully",
  "data": {
    "assistant": {
      "id": "6430ed28e0848ccfef40807a",
      "name": "my new name",
      "academicId": "878978798978"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'my new name',
  academicId: '878978798978',
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/6430ed28e0848ccfef40807a',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

GET - api/v1/assistant/courses - Index Details
GET - api/v1/assistant/courses/:id - Show Details

COURSE ⭐

Index courses assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Courses fetched successfully",
  "data": {
    "coursesCount": 1,
    "courses": [
      {
        "id": "6430ce43c3ca49b01012f8ca",
        "name": "machine learning",
        "code": "cs45",
        "createdAt": "2023-04-08T02:15:31.406Z",
        "updatedAt": "2023-04-09T15:59:16.604Z"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch('http://localhost:3000/api/v1/assistant/courses', {
  method: 'GET',
  headers: headersList,
});

let data = await response.text();
console.log(data);

Show course assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Course fetched successfully",
  "data": {
    "course": {
      "_id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning",
      "code": "cs45",
      "semester": "first",
      "professor": {
        "_id": "6430c7854e29a1ff8375d1e7",
        "name": "dr. mohamed yasser"
      },
      "assistants": ["6430ed28e0848ccfef40807a"],
      "students": [],
      "lectures": [
        "64322cf88becbaa1fe44e152",
        "6432d82919c58a344497f4a7",
        "6432d85e19c58a344497f4b4",
        "6432e0cadde93cf76c5dade3"
      ],
      "sections": [],
      "assignments": ["6432e0d4dde93cf76c5dade9"],
      "exams": [],
      "department": {
        "_id": "6430596c112031c1dbfc3fd8",
        "name": "computer science"
      },
      "program": {
        "_id": "643052a83eea93f118839c46",
        "name": "public"
      },
      "level": {
        "_id": "642ee7f789a92ceeba6b7a4f",
        "name": "level 01"
      },
      "collage": {
        "_id": "642e3cb699182e5e2d14ec59",
        "name": "fuculty of engineering"
      },
      "university": {
        "_id": "642deaa976e91123782b7f16",
        "name": "alu"
      },
      "createdAt": "2023-04-08T02:15:31.406Z",
      "updatedAt": "2023-04-09T15:59:16.604Z",
      "__v": 12
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

SECTION ⭐

Create section assistant 📌

HTTP Method: POST
Endpoint URL: api/v1/assistant/courses/:id/sections
Headers: Authorization

Body:

{
  "name": "Section 02",
  "number": 2
}

Success Response: 201

{
  "status": "success",
  "message": "Section created successfully",
  "data": {
    "section": {
      "id": "64333b450ea788a84c9579e6"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'Section 02',
  number: 2,
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index sections assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Sections fetched successfully",
  "data": {
    "sectionsCount": 2,
    "sections": [
      {
        "_id": "64333b450ea788a84c9579e6",
        "name": "section 02",
        "number": 2,
        "resources": [],
        "assistant": "6430ed28e0848ccfef40807a",
        "course": "6430ce43c3ca49b01012f8ca",
        "assignments": [],
        "createdAt": "2023-04-09T22:25:09.218Z",
        "updatedAt": "2023-04-09T22:25:09.218Z",
        "__v": 0
      },
      {
        "_id": "64333b152d1b672a2ee9a1a0",
        "name": "section 01",
        "number": 1,
        "resources": [],
        "assistant": "6430ed28e0848ccfef40807a",
        "course": "6430ce43c3ca49b01012f8ca",
        "assignments": [],
        "createdAt": "2023-04-09T22:24:21.364Z",
        "updatedAt": "2023-04-09T22:24:21.364Z",
        "__v": 0
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show section assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Section fetched successfully",
  "data": {
    "section": {
      "_id": "64333b450ea788a84c9579e6",
      "name": "section 02",
      "number": 2,
      "resources": [],
      "assistant": "6430ed28e0848ccfef40807a",
      "course": "6430ce43c3ca49b01012f8ca",
      "assignments": [],
      "createdAt": "2023-04-09T22:25:09.218Z",
      "updatedAt": "2023-04-09T22:25:09.218Z",
      "__v": 0
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update section assistant 📌

HTTP Method: PATCH
Endpoint URL: api/v1/assistant/courses/:id/sections/:id
Headers: Authorization

Body:

{
  "name": "New section name",
  "number": 6
}

Success Response: 200

{
  "status": "success",
  "message": "Section fetched successfully",
  "data": {
    "section": {
      "_id": "64333b450ea788a84c9579e6",
      "name": "section 02",
      "number": 2,
      "resources": [],
      "assistant": "6430ed28e0848ccfef40807a",
      "course": "6430ce43c3ca49b01012f8ca",
      "assignments": [],
      "createdAt": "2023-04-09T22:25:09.218Z",
      "updatedAt": "2023-04-09T22:25:09.218Z",
      "__v": 0
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'New section name',
  number: 6,
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete section assistant 📌

HTTP Method: DELETE
Endpoint URL: api/v1/assistant/courses/:id/sections/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Section fetched successfully",
  "data": {
    "section": {
      "_id": "64333b450ea788a84c9579e6",
      "name": "section 02",
      "number": 2,
      "resources": [],
      "assistant": "6430ed28e0848ccfef40807a",
      "course": "6430ce43c3ca49b01012f8ca",
      "assignments": [],
      "createdAt": "2023-04-09T22:25:09.218Z",
      "updatedAt": "2023-04-09T22:25:09.218Z",
      "__v": 0
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

POST - api/v1/assistant/courses/:id/sections/:id/attendance - Create Details
GET - api/v1/assistant/courses/:id/sections/:id/attendance/:id - Show Details
GET - api/v1/assistant/courses/:id/sections/:id/attendance/:id/students - Index Students Details
DELETE - api/v1/assistant/courses/:id/sections/:id/attendance/:id/students/:id - Delete Student Details

ATTENDANCE ( QR CODE & LOCATION ) ⭐

Create attendance assistant 📌

HTTP Method: POST
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/attendance
Headers: Authorization

Body:

{
  "distanceInMeters": 100,
  "durationInMinutes": 60,
  "lat": "31.205753",
  "lng": "29.924526"
}

Success Response: 201

{
  "status": "success",
  "message": "Attendance created successfully.",
  "data": {
    "attendance": {
      "students": [],
      "section": "64333b450ea788a84c9579e6",
      "distanceInMeters": 100,
      "creatorCoordinates": {
        "lat": "31.205753",
        "lng": "29.924526"
      },
      "durationInMinutes": 60,
      "expiredAt": "2023-04-10T04:41:28.704Z",
      "randomAccessKey": "CHDC5wyn0c",
      "_id": "64338568efee0439e703eecf",
      "createdAt": "2023-04-10T03:41:28.711Z",
      "updatedAt": "2023-04-10T03:41:28.711Z",
      "__v": 0,
      "id": "64338568efee0439e703eecf"
    },
    "section": {
      "id": "64333b450ea788a84c9579e6",
      "name": "section 02"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  distanceInMeters: 100,
  durationInMinutes: 60,
  lat: '31.205753',
  lng: '29.924526',
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/attendance',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show attendance assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/attendance/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Attendance created successfully.",
  "data": {
    "attendance": {
      "students": [],
      "section": "64333b450ea788a84c9579e6",
      "distanceInMeters": 100,
      "creatorCoordinates": {
        "lat": "31.205753",
        "lng": "29.924526"
      },
      "durationInMinutes": 60,
      "expiredAt": "2023-04-10T04:41:28.704Z",
      "randomAccessKey": "CHDC5wyn0c",
      "_id": "64338568efee0439e703eecf",
      "createdAt": "2023-04-10T03:41:28.711Z",
      "updatedAt": "2023-04-10T03:41:28.711Z",
      "__v": 0,
      "id": "64338568efee0439e703eecf"
    },
    "section": {
      "id": "64333b450ea788a84c9579e6",
      "name": "section 02"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/attendance/64338568efee0439e703eecf',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index attendance assistant students 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/attendance/:id/students
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Students fetched successfully",
  "data": {
    "students": []
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/attendance/64338568efee0439e703eecf/students',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete attendance assistant student 📌

HTTP Method: DELETE
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/attendance/:id/students/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Student deleted successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/attendance/64338568efee0439e703eecf/students/6430ce43c3ca49b01012f8ca',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

POST - api/v1/assistant/courses/:id/sections/:id/assignments - Create Details
GET - api/v1/assistant/courses/:id/sections/:id/assignments - Index Details
GET - api/v1/assistant/courses/:id/sections/:id/assignments/:id - Show Details
PATCH - api/v1/assistant/courses/:id/sections/:id/assignments/:id - Update Details
DELETE - api/v1/assistant/courses/:id/sections/:id/assignments/:id - Delete Details

ASSIGNMENT ⭐

Create section assignment assistant 📌

HTTP Method: POST
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/assignments
Headers: Authorization

Body: title, description, dueDate, file

{
  "title": "this is new assignment for the section",
  "contentText": "in this assignment you should create static website using htm, css, js",
  "dueToDays": 5
}

Success Response: 201

{
  "status": "success",
  "message": "Assignment created",
  "data": {
    "assignment": {
      "title": "this is new assignment for the section",
      "contentText": "in this assignment you should create static website using htm, css, js",
      "contentImage": "64338862b26563cf63a1934c",
      "dueDate": "2023-04-15T03:54:10.618Z",
      "assistant": "6430ed28e0848ccfef40807a",
      "course": "6430ce43c3ca49b01012f8ca",
      "section": "64333b450ea788a84c9579e6",
      "submissions": [],
      "_id": "64338862b26563cf63a1934d",
      "createdAt": "2023-04-10T03:54:10.749Z",
      "updatedAt": "2023-04-10T03:54:10.749Z",
      "__v": 0
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  title: 'this is new assignment for the section',
  contentText:
    'in this assignment you should create static website using htm, css, js',
  dueToDays: 5,
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/assignments',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index section assignments assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/assignments
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignments fetched successfully",
  "data": {
    "assignmentsCount": 1,
    "assignments": [
      {
        "id": "64338862b26563cf63a1934d",
        "_id": "64338862b26563cf63a1934d",
        "title": "this is new assignment for the section",
        "contentText": "in this assignment you should create static website using htm, css, js",
        "contentImage": "64338862b26563cf63a1934c",
        "dueDate": "2023-04-15T03:54:10.618Z",
        "assistant": "6430ed28e0848ccfef40807a",
        "course": "6430ce43c3ca49b01012f8ca",
        "section": "64333b450ea788a84c9579e6",
        "submissions": [],
        "createdAt": "2023-04-10T03:54:10.749Z",
        "updatedAt": "2023-04-10T03:54:10.749Z",
        "__v": 0
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/assignments',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show section assignment assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/assignments/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignment fetched successfully",
  "data": {
    "assignment": {
      "_id": "64338862b26563cf63a1934d",
      "title": "this is new assignment for the section",
      "contentText": "in this assignment you should create static website using htm, css, js",
      "contentImage": "64338862b26563cf63a1934c",
      "dueDate": "2023-04-15T03:54:10.618Z",
      "assistant": "6430ed28e0848ccfef40807a",
      "course": "6430ce43c3ca49b01012f8ca",
      "section": "64333b450ea788a84c9579e6",
      "submissions": [],
      "createdAt": "2023-04-10T03:54:10.749Z",
      "updatedAt": "2023-04-10T03:54:10.749Z",
      "__v": 0,
      "id": "64338862b26563cf63a1934d"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    },
    "section": {
      "id": "64333b450ea788a84c9579e6",
      "name": "section 02"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/assignments/64338862b26563cf63a1934d',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update section assignment assistant 📌

HTTP Method: PATCH
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/assignments/:id
Headers: Authorization

Body:

{
  "title": "section assignment new title",
  "contentText": "this is updated content text",
  "dueToDays": 9
}

Success Response: 200

{
  "status": "success",
  "message": "The assignment updated successfully",
  "data": {
    "assignment": {
      "_id": "64338862b26563cf63a1934d",
      "title": "section assignment new title",
      "contentText": "this is updated content text",
      "contentImage": "64338862b26563cf63a1934c",
      "dueDate": "2023-04-19T03:56:33.568Z",
      "assistant": "6430ed28e0848ccfef40807a",
      "course": "6430ce43c3ca49b01012f8ca",
      "section": "64333b450ea788a84c9579e6",
      "submissions": [],
      "createdAt": "2023-04-10T03:54:10.749Z",
      "updatedAt": "2023-04-10T03:56:33.688Z",
      "__v": 0,
      "id": "64338862b26563cf63a1934d"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  title: 'section assignment new title',
  contentText: 'this is updated content text',
  dueToDays: 9,
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/assignments/64338862b26563cf63a1934d',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete section assignment assistant 📌

HTTP Method: DELETE
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/assignments/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignment removed successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/assignments/64338862b26563cf63a1934d',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

SECTION RESOURCES ⭐

Create section resource assistant 📌

HTTP Method: POST
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/resources
Headers: Authorization

Body:

{
  "name": "section resource for the whiteboard",
  "type": "png" // Allowed types // allowed types without mime type [jpeg, png, pdf, doc, xls, docx, xlsx, pptx, mp3, mp4]
}

Success Response: 201

{
  "status": "success",
  "message": "Section resource created",
  "data": {
    "storage": {
      "path": "courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/resources/4625dabc-5a1c-4696-a7a4-1dcc1bd4499d.png",
      "type": "image/png",
      "name": "section resource for the whiteboard",
      "owner": "6430ed28e0848ccfef40807a",
      "_id": "64338b889d30e909adbe568a",
      "createdAt": "2023-04-10T04:07:36.651Z",
      "updatedAt": "2023-04-10T04:07:36.651Z",
      "__v": 0,
      "id": "64338b889d30e909adbe568a"
    },
    "section": {
      "_id": "64333b450ea788a84c9579e6",
      "name": "section 02",
      "number": 2,
      "resources": ["64338b889d30e909adbe568a"],
      "assistant": "6430ed28e0848ccfef40807a",
      "course": "6430ce43c3ca49b01012f8ca",
      "assignments": [],
      "createdAt": "2023-04-09T22:25:09.218Z",
      "updatedAt": "2023-04-10T04:07:36.769Z",
      "__v": 3,
      "attendance": "64338568efee0439e703eecf",
      "id": "64333b450ea788a84c9579e6"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'section resource for the whiteboard',
  type: 'png',
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/resources',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Index section resources assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/resources
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Resources fetched successfully",
  "data": {
    "resources": [
      {
        "_id": "64338b889d30e909adbe568a",
        "type": "image/png",
        "name": "section resource for the whiteboard",
        "id": "64338b889d30e909adbe568a"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/64199f7356f349d3513ab2b9/sections/641b0a475fc1040d89eb8a04/resources',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show section resource assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/resources/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Resource fetched successfully",
  "data": {
    "resource": {
      "_id": "64338b889d30e909adbe568a",
      "path": "courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/resources/4625dabc-5a1c-4696-a7a4-1dcc1bd4499d.png",
      "type": "image/png",
      "name": "section resource for the whiteboard",
      "owner": "6430ed28e0848ccfef40807a",
      "createdAt": "2023-04-10T04:07:36.651Z",
      "updatedAt": "2023-04-10T04:07:36.651Z",
      "__v": 0,
      "id": "64338b889d30e909adbe568a"
    },
    "section": {
      "id": "64333b450ea788a84c9579e6",
      "name": "section 02"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/resources/64338b889d30e909adbe568a',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update section resource assistant 📌

HTTP Method: PATCH
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/resources/:id
Headers: Authorization
Body:
```
{
  "name": "new resource name"
}
```

Success Response: 200

{
  "status": "success",
  "message": "Resource updated successfully",
  "data": {
    "resource": {
      "_id": "64338b889d30e909adbe568a",
      "path": "courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/resources/4625dabc-5a1c-4696-a7a4-1dcc1bd4499d.png",
      "type": "image/png",
      "name": "new resource name",
      "owner": "6430ed28e0848ccfef40807a",
      "createdAt": "2023-04-10T04:07:36.651Z",
      "updatedAt": "2023-04-10T04:15:02.005Z",
      "__v": 0,
      "id": "64338b889d30e909adbe568a"
    },
    "section": {
      "id": "64333b450ea788a84c9579e6",
      "name": "section 02"
    },
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  name: 'new resource name',
});

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/resources/64338b889d30e909adbe568a',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Delete section resource assistant 📌

HTTP Method: DELETE
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/resources/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Resource removed successfully",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/resources/64338b889d30e909adbe568a',
  {
    method: 'DELETE',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

ASSIGNMENT SUBMISSIONS ⭐

Index section assignment submissions assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/assignments/:id/submissions
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Submissions fetched successfully",
  "data": {
    "submissionsCount": 0,
    "submissions": []
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/assignments/64338e5c9d30e909adbe56ab/submissions',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show section assignment submission assistant 📌

HTTP Method: GET
Endpoint URL: api/v1/assistant/courses/:id/sections/:id/assignments/:id/submissions/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Submission fetched successfully",
  "data": {
    "submission": {
      "id": "64338e5c9d30e909adbe56ab",
      "student": {
        "id": "6430ce43c3ca49b01012f8ca",
        "name": "Ahmed"
      },
      "assignment": {
        "id": "6430ce43c3ca49b01012f8ca",
        "name": "assignment 01"
      },
      "section": {
        "id": "6430ce43c3ca49b01012f8ca",
        "name": "section 02"
      },
      "course": {
        "id": "6430ce43c3ca49b01012f8ca",
        "name": "machine learning"
      },
      "grade": 0,
      "submittedAt": "2021-09-30T12:00:00.000Z",
      "submittedFiles": [
        {
          "id": "6430ce43c3ca49b01012f8ca",
          "name": "file 01"
        }
      ]
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMGVkMjhlMDg0OGNjZmVmNDA4MDdhIiwicm9sZSI6ImFzc2lzdGFudCJ9LCJpYXQiOjE2ODEwNzM5MzYsImV4cCI6MTY4MzY2NTkzNn0.OLgmho2JmORrkQ7Ct45E9NmUoDWFjd021fxnAsIIpyk',
};

let response = await fetch(
  'http://localhost:3000/api/v1/assistant/courses/6430ce43c3ca49b01012f8ca/sections/64333b450ea788a84c9579e6/assignments/64338e5c9d30e909adbe56ab/submissions/6430ce43c3ca49b01012f8ca',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

STUDENT 👨‍🎓

GET - api/v1/student/:id - Show Details

ACCESS PERMISSOIN ⭐

Show student access permission 📌

HTTP Method: GET
Endpoint URL: api/v1/student/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "student fetched successfully",
  "data": {
    "student": {
      "id": "64339e899d30e909adbe56cc",
      "createdAt": "2023-04-10T05:28:41.127Z",
      "name": "mohamed yasser",
      "username": "mohamedyasser459rf",
      "academicId": "9879873833",
      "qrCode": "64339e889d30e909adbe56c8",
      "courses": [],
      "contacts": "64339e899d30e909adbe56ca"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    },
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "department": {
      "id": "6430596c112031c1dbfc3fd8",
      "name": "computer science"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/64339e899d30e909adbe56cc',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

COURSE ⭐

Index courses student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Courses fetched successfully.",
  "data": {
    "courses": [
      {
        "id": "6430ce43c3ca49b01012f8ca",
        "name": "machine learning",
        "code": "cs45",
        "professor": {
          "_id": "6430c7854e29a1ff8375d1e7",
          "name": "dr. mohamed yasser"
        },
        "isEnrolled": false
      },
      {
        "id": "6430e37e95394133234b0cdf",
        "name": "image processing",
        "code": "cs45",
        "professor": {
          "_id": "6430c7854e29a1ff8375d1e7",
          "name": "dr. mohamed yasser"
        },
        "isEnrolled": false
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch('http://localhost:3000/api/v1/student/courses', {
  method: 'GET',
  headers: headersList,
});

let data = await response.text();
console.log(data);

Show course student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Course fetched successfully.",
  "data": {
    "course": {
      "id": "6430ce43c3ca49b01012f8ca",
      "name": "machine learning",
      "code": "cs45"
    },
    "professor": {
      "id": "6430c7854e29a1ff8375d1e7",
      "name": "dr. mohamed yasser"
    },
    "university": {
      "id": "642deaa976e91123782b7f16",
      "name": "alu"
    },
    "collage": {
      "id": "642e3cb699182e5e2d14ec59",
      "name": "fuculty of engineering"
    },
    "department": {
      "id": "6430596c112031c1dbfc3fd8",
      "name": "computer science"
    },
    "program": {
      "id": "643052a83eea93f118839c46",
      "name": "public"
    },
    "level": {
      "id": "642ee7f789a92ceeba6b7a4f",
      "name": "level 01"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430ce43c3ca49b01012f8ca',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Enroll course student 📌

HTTP Method: POST
Endpoint URL: api/v1/student/courses/:id/enroll
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Student enrolled in course successfully.",
  "data": {}
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430ce43c3ca49b01012f8ca/enroll',
  {
    method: 'POST',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

COURSE EXAM ⭐

Index course exams student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/exams
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Exams fetched successfully",
  "data": {
    "exams": [
      {
        "id": "6432e59cdde93cf76c5dae17",
        "name": "exam 01",
        "startAt": "2023-04-09T16:20:00.000Z",
        "endAt": "2023-04-09T16:40:00.000Z",
        "durationInMinutes": 20,
        "isActive": false
      },
      {
        "id": "6433047d101ff077ea746339",
        "name": "exam 01",
        "startAt": "2023-04-10T10:30:00.000Z",
        "endAt": "2023-04-10T10:50:00.000Z",
        "durationInMinutes": 20,
        "isActive": false
      },
      {
        "id": "64349c56162ca94a690b312e",
        "name": "exam 01",
        "startAt": "2023-04-10T23:33:00.000Z",
        "endAt": "2023-04-11T01:33:00.000Z",
        "durationInMinutes": 120,
        "isActive": true
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({});

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/exams',
  {
    method: 'GET',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Enroll course exam student 📌

HTTP Method: POST
Endpoint URL: api/v1/student/courses/:id/exams/:id/enroll
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Enrolled in exam successfully",
  "data": {
    "exam": {
      "id": "64349c56162ca94a690b312e",
      "name": "exam 01",
      "startAt": "2023-04-10T23:33:00.000Z",
      "endAt": "2023-04-11T01:33:00.000Z",
      "questions": [
        {
          "id": "64349ca2162ca94a690b3140",
          "contentText": "Question 1",
          "contentImage": "64349ca2162ca94a690b313f",
          "score": 7,
          "answers": [
            {
              "id": "64349ca2162ca94a690b3141",
              "contentText": "answer 1"
            },
            {
              "id": "64349ca2162ca94a690b3143",
              "contentText": "answer 2"
            },
            {
              "id": "64349ca2162ca94a690b3145",
              "contentText": "answer 3"
            }
          ]
        },
        {
          "id": "64349cb4162ca94a690b314e",
          "contentText": "Question 2",
          "contentImage": "64349cb4162ca94a690b314d",
          "score": 9,
          "answers": [
            {
              "id": "64349cb4162ca94a690b314f",
              "contentText": "answer 1"
            },
            {
              "id": "64349cb4162ca94a690b3151",
              "contentText": "answer 2"
            },
            {
              "id": "64349cb4162ca94a690b3153",
              "contentText": "answer 3"
            }
          ]
        }
      ]
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzNDllMWI3MDVhMTRjMjdhYWU1MTI3Iiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTY5OTYxLCJleHAiOjE2ODM3NjE5NjF9.BwcErknbAN7_5RbJ0tqNjFehR-qCIPrI0lRr9xqZPCE',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/exams/64349c56162ca94a690b312e/enroll',
  {
    method: 'POST',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Submit course exam student 📌

HTTP Method: POST
Endpoint URL: api/v1/student/courses/:id/exams/:id/submit
Headers: Authorization

Body:

{
  "questionsWithAnswers": [
    "{question: '64349ca2162ca94a690b3140', answer: '64349ca2162ca94a690b3143'}",
    "{question: '64349cb4162ca94a690b314e', answer: '64349cb4162ca94a690b314f'}"
  ]
}

Success Response: 201

{
  "status": "success",
  "message": "Exam submitted successfully.",
  "data": {
    "totalScore": 16,
    "studentScore": 16
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzNDllMWI3MDVhMTRjMjdhYWU1MTI3Iiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTY5OTYxLCJleHAiOjE2ODM3NjE5NjF9.BwcErknbAN7_5RbJ0tqNjFehR-qCIPrI0lRr9xqZPCE',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  questionsWithAnswers: [
    "{question: '64349ca2162ca94a690b3140', answer: '64349ca2162ca94a690b3143'}",
    "{question: '64349cb4162ca94a690b314e', answer: '64349cb4162ca94a690b314f'}",
  ],
});

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/exams/64349c56162ca94a690b312e/submit',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

COURSE ASSIGNMENT ⭐

Index course assignments student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assignments
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignments fetched successfully",
  "assignments": [
    {
      "id": "6434a25263372d0aa8ecba3f",
      "title": "python cgi",
      "isExpired": false,
      "dueDate": "2023-04-17T23:57:06.076Z"
    }
  ]
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assignments',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show course assignments student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assignments/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignment fetched successfully",
  "assignment": {
    "id": "6434a25263372d0aa8ecba3f",
    "title": "python cgi",
    "contentText": "In this assignment you should create a full python server side application and apply all CGI concepts we have learned in the lecture and section",
    "contentImage": "6434a25263372d0aa8ecba3e",
    "dueDate": "2023-04-17T23:57:06.076Z",
    "isExpired": false
  },
  "professor": {
    "id": "6430c7854e29a1ff8375d1e7",
    "name": "dr. mohamed yasser"
  },
  "course": {
    "id": "6430e37e95394133234b0cdf",
    "name": "image processing"
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assignments/6434a25263372d0aa8ecba3f',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Submit course assignment student 📌

HTTP Method: POST
Endpoint URL: api/v1/student/courses/:id/assignments/:id/submit
Headers: Authorization

Body:

{
  "note": "this is student note",
  "fileType": "png"
}

Success Response: 201

{
  "status": "success",
  "message": "Assignment submitted successfully",
  "data": {
    "assignmentSubmission": {
      "file": "6434a2ac63372d0aa8ecba4f",
      "note": "this is student note",
      "assignment": "6434a25263372d0aa8ecba3f",
      "student": "64339e899d30e909adbe56cc",
      "course": "6430e37e95394133234b0cdf",
      "_id": "6434a2ac63372d0aa8ecba50",
      "createdAt": "2023-04-10T23:58:36.116Z",
      "updatedAt": "2023-04-10T23:58:36.116Z",
      "__v": 0,
      "id": "6434a2ac63372d0aa8ecba50"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  note: 'this is student note',
  fileType: 'png',
});

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assignments/6434a25263372d0aa8ecba3f/submit',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

GET - api/v1/student/courses/:id/assistants - Index Details

COURSE ASSISTANTS ⭐

Index course assistants student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assistants
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assistants fetched successfully.",
  "data": {
    "assistants": [
      {
        "id": "6434a4d063372d0aa8ecba6d",
        "name": "mohamed yasser"
      },
      {
        "id": "6434a4ff63372d0aa8ecba7e",
        "name": "mohamed yasser"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

SECTION ⭐

Index sections student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Sections fetched successfully.",
  "data": {
    "sections": [
      {
        "id": "6434a6a363372d0aa8ecbaa5",
        "name": "section 02"
      }
    ],
    "assistant": {
      "id": "6434a64263372d0aa8ecba8f",
      "name": "mo"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show section student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Section found",
  "data": {
    "section": {
      "_id": "6434a6a363372d0aa8ecbaa5",
      "name": "section 02",
      "number": 2,
      "resources": [],
      "assistant": "6434a64263372d0aa8ecba8f",
      "course": "6430e37e95394133234b0cdf",
      "assignments": [],
      "createdAt": "2023-04-11T00:15:31.694Z",
      "updatedAt": "2023-04-11T00:15:31.694Z",
      "__v": 0
    },
    "assistant": {
      "id": "6434a64263372d0aa8ecba8f",
      "name": "mo"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections/6434a6a363372d0aa8ecbaa5',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

SECTION RESOURCES ⭐

Index section resources student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections/:id/resources
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Section resources fetched successfully",
  "data": {
    "resources": [
      {
        "_id": "6434abd1e7b70ce6c7e5d3af",
        "path": "courses/6430e37e95394133234b0cdf/sections/6434a6a363372d0aa8ecbaa5/resources/bc192957-fb34-4ef6-96ce-13fdb1ce0c78.png",
        "type": "image/png",
        "name": "section resource for the whiteboard",
        "owner": "6434a64263372d0aa8ecba8f",
        "createdAt": "2023-04-11T00:37:37.347Z",
        "updatedAt": "2023-04-11T00:37:37.347Z",
        "__v": 0,
        "id": "6434abd1e7b70ce6c7e5d3af"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections/6434a6a363372d0aa8ecbaa5/resources',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

SECTION ASSIGNMENT ⭐

Index section assignments student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections/:id/assignments
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignments fetched successfully",
  "assignments": [
    {
      "id": "6434ada7e7b70ce6c7e5d3cd",
      "title": "this is new assignment for the section",
      "isExpired": false,
      "dueDate": "2023-04-16T00:45:27.915Z"
    }
  ]
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections/6434a6a363372d0aa8ecbaa5/assignments',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show section assignment student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections/:id/assignments/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Assignment fetched successfully",
  "assignment": {
    "id": "6434ada7e7b70ce6c7e5d3cd",
    "title": "this is new assignment for the section",
    "contentText": "in this assignment you should create static website using htm, css, js",
    "contentImage": "6434ada7e7b70ce6c7e5d3cc",
    "dueDate": "2023-04-16T00:45:27.915Z",
    "isExpired": false
  },
  "assistant": {
    "id": "6434a64263372d0aa8ecba8f",
    "name": "mo"
  },
  "section": {
    "id": "6434a6a363372d0aa8ecbaa5",
    "name": "section 02"
  },
  "course": {
    "id": "6430e37e95394133234b0cdf",
    "name": "image processing"
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections/6434a6a363372d0aa8ecbaa5/assignments/6434ada7e7b70ce6c7e5d3cd',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Submit section assignment student 📌

HTTP Method: POST
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections/:id/assignments/:id/submit
Headers: Authorization

Body:

{
  "note": "this is student note",
  "fileType": "png"
}

Success Response: 201

{
  "status": "success",
  "message": "Assignment submitted successfully",
  "data": {
    "assignmentSubmission": {
      "file": "6434aeec91da347928a86084",
      "note": "this is student note",
      "assignment": "6434ada7e7b70ce6c7e5d3cd",
      "student": "64339e899d30e909adbe56cc",
      "course": "6430e37e95394133234b0cdf",
      "section": "6434a6a363372d0aa8ecbaa5",
      "_id": "6434aeec91da347928a86085",
      "createdAt": "2023-04-11T00:50:52.142Z",
      "updatedAt": "2023-04-11T00:50:52.142Z",
      "__v": 0,
      "id": "6434aeec91da347928a86085"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  note: 'this is student note',
  fileType: 'png',
});

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections/6434a6a363372d0aa8ecbaa5/assignments/6434ada7e7b70ce6c7e5d3cd/submit',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

SECTION ATTENDANCE ⭐

Show section attendance student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections/:id/attendance/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Attendance fetched successfully.",
  "data": {
    "attendance": {
      "id": "6434b4e9b8a4dc5e28d1c321",
      "isAttended": true
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections/6434a6a363372d0aa8ecbaa5/attendance/6434b4e9b8a4dc5e28d1c321',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Attend section attendance student 📌

HTTP Method: POST
Endpoint URL: api/v1/student/courses/:id/assistants/:id/sections/:id/attendance/:id/attend
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Attended section successfully.",
  "data": {
    "attendance": {
      "id": "6434b4e9b8a4dc5e28d1c321",
      "isAttended": true
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzNGI2ZWNjY2Q3YWIyZTUwOGIyYTliIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTc2MzE5LCJleHAiOjE2ODM3NjgzMTl9.7ezCeW-eVpO5yepCy6UH41vHQmF7Kvux8HybKeg-T_w',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  randomAccessKey: 'en0JNha0iU',
  lat: '31.205753',
  lng: '29.924526',
});

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/assistants/6434a64263372d0aa8ecba8f/sections/6434a6a363372d0aa8ecbaa5/attendance/6434b4e9b8a4dc5e28d1c321/attend',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

LECTURE ⭐

Index lectures student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/lectures
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Lectures fetched successfully.",
  "data": {
    "lectures": [
      {
        "id": "6434b916ccd7ab2e508b2ac3",
        "name": "lecture 03",
        "number": 3
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/lectures',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Show lecture student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/lectures/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Lecture fetched successfully.",
  "data": {
    "lecture": {
      "id": "6434b916ccd7ab2e508b2ac3",
      "name": "lecture 03",
      "number": 3,
      "resources": [],
      "createdAt": "2023-04-11T01:34:14.436Z"
    },
    "attendance": {}
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/lectures/6434b916ccd7ab2e508b2ac3',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

LECTURE RESOURCES ⭐

Index lecture resources student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/lectures/:id/resources
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Lecture resources fetched successfully",
  "data": {
    "resources": [
      {
        "_id": "6434be45b5d96421078c210a",
        "path": "courses/6430e37e95394133234b0cdf/lecture/6434b916ccd7ab2e508b2ac3/resources/c4e01461-414b-4f38-9c2f-a4b114ad4dc3.png",
        "type": "image/png",
        "name": "lecture 01 - resource",
        "owner": "6430c7854e29a1ff8375d1e7",
        "createdAt": "2023-04-11T01:56:21.752Z",
        "updatedAt": "2023-04-11T01:56:21.752Z",
        "__v": 0,
        "id": "6434be45b5d96421078c210a"
      }
    ]
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/lectures/6434b916ccd7ab2e508b2ac3/resources',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

GET - api/v1/student/courses/:id/lectures/:id/attendance/:id - Show Details
POST - api/v1/student/courses/:id/lectures/:id/attendance/:id/attend - Attend Details

LECTURE ATTENDANCE ⭐

Show lecture attendance student 📌

HTTP Method: GET
Endpoint URL: api/v1/student/courses/:id/lectures/:id/attendance/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Attendance fetched successfully.",
  "data": {
    "attendance": {
      "id": "6434c0f21c684c5985ccaf70",
      "isAttended": true
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
};

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/lectures/6434b916ccd7ab2e508b2ac3/attendance/6434c0f21c684c5985ccaf70',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Attend lecture attendance student 📌

HTTP Method: POST
Endpoint URL: api/v1/student/courses/:id/lectures/:id/attendance/:id/attend
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Student attended successfully.",
  "data": {
    "attendance": {
      "id": "6434c0f21c684c5985ccaf70",
      "isAttended": true
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  randomAccessKey: 'lY4RWSzvxD',
  lat: '30.9977',
  lng: '29.7432',
});

let response = await fetch(
  'http://localhost:3000/api/v1/student/courses/6430e37e95394133234b0cdf/lectures/6434b916ccd7ab2e508b2ac3/attendance/6434c0f21c684c5985ccaf70/attend',
  {
    method: 'POST',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

CONTACTS ⭐

Show contact 📌

HTTP Method: GET
Endpoint URL: api/v1/contacts/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Contact updated successfully",
  "data": {
    "contact": {
      "phoneNumber": {
        "code": "20",
        "number": "1224440417"
      },
      "whatsapp": {
        "code": "20",
        "number": "1224440417"
      },
      "_id": "64339e899d30e909adbe56ca",
      "createdAt": "2023-04-10T05:28:41.012Z",
      "updatedAt": "2023-04-11T02:26:40.467Z",
      "__v": 0,
      "email": "hi@gmail.com",
      "facebook": "www.facebook.com",
      "twitter": "iammo26",
      "telegram": "iammo26"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  email: 'hi@gmail.com',
  phoneCode: '20',
  phoneNumber: '1224440417',
  facebookLink: 'www.facebook.com',
  twitterUsername: 'iammo26',
  whatsappCode: '20',
  WhatsappNumber: '1224440417',
  telegramUsername: 'iammo26',
});

let response = await fetch(
  'http://localhost:3000/api/v1/contacts/64339e899d30e909adbe56ca',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Update contact 📌

HTTP Method: PATCH
Endpoint URL: api/v1/contacts/:id
Headers: Authorization

Body:

{
  "email": "hi@gmail.com",
  "phoneCode": "20",
  "phoneNumber": "1224440417",
  "facebookLink": "www.facebook.com",
  "twitterUsername": "iammo26",
  "whatsappCode": "20",
  "WhatsappNumber": "1224440417",
  "telegramUsername": "iammo26"
}

Success Response: 200

{
  "status": "success",
  "message": "Contact updated successfully",
  "data": {
    "contact": {
      "phoneNumber": {
        "code": "20",
        "number": "1224440417"
      },
      "whatsapp": {
        "code": "20",
        "number": "1224440417"
      },
      "_id": "64339e899d30e909adbe56ca",
      "createdAt": "2023-04-10T05:28:41.012Z",
      "updatedAt": "2023-04-11T02:26:40.467Z",
      "__v": 0,
      "email": "hi@gmail.com",
      "facebook": "www.facebook.com",
      "twitter": "iammo26",
      "telegram": "iammo26"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjQzMzllODk5ZDMwZTkwOWFkYmU1NmNjIiwicm9sZSI6InN0dWRlbnQifSwiaWF0IjoxNjgxMTA0NzA0LCJleHAiOjE2ODM2OTY3MDR9.ov6EA3_jla0KlwXgRnx1LOKUfapQ6qbVqgFeSqGvZ2Q',
  'Content-Type': 'application/json',
};

let bodyContent = JSON.stringify({
  email: 'hi@gmail.com',
  phoneCode: '20',
  phoneNumber: '1224440417',
  facebookLink: 'www.facebook.com',
  twitterUsername: 'iammo26',
  whatsappCode: '20',
  WhatsappNumber: '1224440417',
  telegramUsername: 'iammo26',
});

let response = await fetch(
  'http://localhost:3000/api/v1/contacts/64339e899d30e909adbe56ca',
  {
    method: 'PATCH',
    body: bodyContent,
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

STORAGE ⭐

Upload storage 📌

HTTP Method: POST
Endpoint URL: api/v1/storage/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Uploadable url generated successfully",
  "data": {
    "storage": {
      "_id": "6434be45b5d96421078c210a",
      "path": "courses/6430e37e95394133234b0cdf/lecture/6434b916ccd7ab2e508b2ac3/resources/c4e01461-414b-4f38-9c2f-a4b114ad4dc3.png",
      "type": "image/png",
      "name": "lecture 01 - resource",
      "owner": "6430c7854e29a1ff8375d1e7",
      "createdAt": "2023-04-11T01:56:21.752Z",
      "updatedAt": "2023-04-11T01:56:21.752Z",
      "__v": 0,
      "id": "6434be45b5d96421078c210a"
    },
    "uploadUrl": "https://unista-dev.s3.amazonaws.com/courses/6430e37e95394133234b0cdf/lecture/6434b916ccd7ab2e508b2ac3/resources/c4e01461-414b-4f38-9c2f-a4b114ad4dc3.png?Content-Type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZUKGZYJVW6D5G2HU%2F20230411%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230411T015658Z&X-Amz-Expires=300&X-Amz-Signature=86e208064373f14210632d48731a419a6f6771291fd24a366673816d080ce92f&X-Amz-SignedHeaders=host",
    "accessUrl": "https://unista-dev.s3.amazonaws.com/courses/6430e37e95394133234b0cdf/lecture/6434b916ccd7ab2e508b2ac3/resources/c4e01461-414b-4f38-9c2f-a4b114ad4dc3.png?AWSAccessKeyId=AKIAZUKGZYJVW6D5G2HU&Expires=1681178518&Signature=7O4kzrVY1yNOz0CKi26zYqLBZLM%3D"
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjNlN2M0M2EwZTc4YmVkNzdiMGNhMzg1Iiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2Nzg5NTkzMjAsImV4cCI6MTY4MTU1MTMyMH0.kqKSNP7bBAyo2KtstKA7ESMqCmh0_4Csm6sdXy9k3-o',
};

let response = await fetch(
  'http://localhost:3000/api/v1/storage/6434be45b5d96421078c210a',
  {
    method: 'POST',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

Access storage 📌

HTTP Method: GET
Endpoint URL: api/v1/storage/:id
Headers: Authorization
Body: None

Success Response: 200

{
  "status": "success",
  "message": "Accessable url generated successfully",
  "data": {
    "url": "https://unista-dev.s3.amazonaws.com/courses/6430e37e95394133234b0cdf/assignments/6434ada7e7b70ce6c7e5d3cd/submissions/76941587-e0f8-495b-879f-af5941a1670b.png?AWSAccessKeyId=AKIAZUKGZYJVW6D5G2HU&Expires=1681174845&Signature=xKQ1DjxtU%2FW9OxuYQ7QVnwVzLnA%3D",
    "storage": {
      "_id": "6434aeec91da347928a86084",
      "path": "courses/6430e37e95394133234b0cdf/assignments/6434ada7e7b70ce6c7e5d3cd/submissions/76941587-e0f8-495b-879f-af5941a1670b.png",
      "type": "image/png",
      "name": "76941587-e0f8-495b-879f-af5941a1670b.png",
      "createdAt": "2023-04-11T00:50:52.021Z",
      "updatedAt": "2023-04-11T00:50:52.021Z",
      "__v": 0,
      "id": "6434aeec91da347928a86084"
    }
  }
}

Example - JS:

let headersList = {
  Accept: '*/*',
  Authorization:
    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjoiNjNlN2M0M2EwZTc4YmVkNzdiMGNhMzg1Iiwicm9sZSI6Im1hc3RlciJ9LCJpYXQiOjE2Nzg5NTkzMjAsImV4cCI6MTY4MTU1MTMyMH0.kqKSNP7bBAyo2KtstKA7ESMqCmh0_4Csm6sdXy9k3-o',
};

let response = await fetch(
  'http://localhost:3000/api/v1/storage/6434aeec91da347928a86084',
  {
    method: 'GET',
    headers: headersList,
  }
);

let data = await response.text();
console.log(data);

devbymo/unista-api-doc

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Packages