This endpoint allows new users to register by providing their account details. Upon successful registration, the user will be created in the system with the specified attributes.
\nThe purpose of this request is to create a new user account in the system. Users must provide the necessary information to establish their account, which will be stored in the database.
\nMethod: POST
URL: http://localhost:3000/api/v1/auth/register
Request Body:
The request should contain a JSON object with the following parameters:
username (string): The desired username for the new account.email (string): The email address associated with the account.role (string): The role of the user, such as \"student\".phone (string): The phone number of the user.password (string): The password for the account.confirmPassword (string): A confirmation of the password to ensure it matches the original.Example Request Body:
\n{\n \"username\": \"exampleUser\",\n \"email\": \"example@example.com\",\n \"role\": \"student\",\n \"phone\": \"+01234567890\",\n \"password\": \"yourPassword\",\n \"confirmPassword\": \"yourPassword\"\n}\nUpon successful registration, the response will typically include a confirmation message along with the details of the newly created user account. The structure of the response may include:
\nstatus (string): The status of the registration process.message (string): A success message indicating that the user has been registered.data (object): An object containing the details of the registered user, such as:username (string): The username of the registered user.email (string): The email of the registered user.phone (string): The phone number of the registered user.role (string): The role assigned to the user.createdAt (string): The timestamp of when the user was created.studentInformation (object): Contains additional information specific to students, including:address (object): The address of the student, which includes:country (string): The country of the student.isActive (boolean): Indicates whether the user account is active._id (string): The unique identifier for the user account.Example Response:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"data\": {\n \"username\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"role\": \"\",\n \"createdAt\": \"\",\n \"studentInformation\": {\n \"address\": {\n \"country\": \"\"\n }\n },\n \"isActive\": true,\n \"_id\": \"\"\n }\n}\nThis endpoint allows users to authenticate by logging into their account. It accepts user credentials (email and password) and returns user-related information upon successful login.
\nPOST/api/v1/auth/loginThe request body must be in JSON format and contain the following parameters:
\n{\n \"email\": \"user@example.com\",\n \"password\": \"your_password\"\n}\nOn a successful login, the server will respond with a JSON object that includes the following fields:
\n{\n \"status\": \"success\",\n \"message\": \"Login successful\",\n \"data\": {\n \"id\": \"user_id\",\n \"role\": \"user_role\"\n }\n}\nThis endpoint allows users to obtain a new access token using a refresh token. It is typically used when the access token has expired, enabling users to maintain their session without needing to log in again.
\nMethod: POST
URL: http://localhost:3000/api/v1/auth/refresh-token
Upon a successful request, the API will return a response with a status code of 200 and a content type of application/json. The response will include the following structure:
\nThis endpoint is used to log out a user from the application. It is typically called when a user wants to terminate their session and ensure that their account is no longer accessible from the current device. Logging out helps maintain user security by invalidating the authentication token associated with the user's session.
\nhttp://localhost:3000/api/v1/auth/logoutThe request body should be sent in the form of application/x-www-form-urlencoded. The following parameter is expected:
token (string): The authentication token of the user that needs to be invalidated upon logout. This token is required to identify the user's session that is to be terminated.On successful logout, the server will respond with a JSON object containing the following structure:
\nstatus (string): Indicates the success or failure of the logout operation.message (string): A message providing additional information about the logout process.{\n \"status\": \"\",\n \"message\": \"\"\n}\nThis endpoint is crucial for maintaining user security by ensuring that sessions can be terminated effectively.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","auth","logout"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"97983a41-3558-47a2-9d21-c1a3dfd255be"},{"name":"Email verification","id":"b109a097-1ea0-4c22-941a-6a5d3cd06731","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:3000/api/v1/auth/verify-email/ece5964953651cc97311e6b19593288ab83d91f97d958f1f7ae1507f8d259112","description":"This endpoint is used to verify a user's email address. It is part of the authentication process, ensuring that the email provided by the user is valid and can be linked to their account.
\nPOSThttp://localhost:3000/api/v1/auth/verify-email/{verificationToken}verificationToken (string): A unique token generated for the email verification process. This token is included in the URL and is essential for identifying the user whose email is being verified.The response will typically include a confirmation of the email verification status. The exact structure of the response may vary, but it is generally expected to return a JSON object indicating whether the verification was successful or if there were any errors encountered during the process.
\n{\n \"success\": true,\n \"message\": \"Email verified successfully.\"\n}\nIn case of an error, the response may look like:
\n{\n \"success\": false,\n \"message\": \"Invalid verification token.\"\n}\nEnsure that the request is made with the correct verification token to receive the appropriate response.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","auth","verify-email","ece5964953651cc97311e6b19593288ab83d91f97d958f1f7ae1507f8d259112"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"b109a097-1ea0-4c22-941a-6a5d3cd06731"},{"name":"Forgot password","id":"79ea10d8-daad-47e3-a667-8a519ae19f22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"y1nz@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/auth/forgot-password","description":"This endpoint allows users to initiate a password reset process by submitting their registered email address. Upon successful submission, the system will process the request and respond accordingly.
\nMethod: POST
\nURL: http://localhost:3000/api/v1/auth/forgot-password
To reset a password, users must send a request to this endpoint with their registered email address. The system will then send a password reset link to the provided email if it is associated with a valid account.
\nThe request body must be in JSON format and should contain the following fields:
\nExample Request Body:
\n{\n \"email\": \"user@example.com\"\n}\nThe response structure will vary based on the success or failure of the password reset request.
\nSuccess Response:
\nStatus Code: 200 OK
\nBody: A confirmation message indicating that the password reset link has been sent to the provided email address. The body will contain:
\nError Response:
\nStatus Code: 400 Bad Request (or other relevant error codes)
\nBody: An error message detailing the reason for the failure, such as \"Invalid email address\" or \"User not found\".
\nEnsure that the email provided is registered in the system to receive the password reset instructions.
\nThe password must meet any security requirements set by the application (e.g., minimum length, complexity).
\nThis endpoint allows users to authenticate via their Google account. By sending a GET request to /api/v1/auth/google, users will be redirected to Google's authentication page. Upon successful authentication, users will be redirected back to the application with the necessary credentials for further access.
Successful authentication will provide the user with access to the application.
\nIn case of failure, appropriate error messages will be returned.
\nEnsure that the application is configured with the correct Google OAuth credentials for seamless integration.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","auth","google"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"db81c37a-d3d1-45bb-8d51-15a184fd1145"}],"id":"18cfbe63-26d0-4130-9854-f93a54c80038","_postman_id":"18cfbe63-26d0-4130-9854-f93a54c80038","description":""},{"name":"Centers","item":[{"name":"Create center","id":"d1de36d7-5eef-41b1-86e5-04a040ad8ae0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Cairo Learning Hub sub\",\r\n \"description\": \"Premier educational center in downtown Cairo offering various courses\",\r\n \"ownerId\": \"685b6878ad4693238cd4bfcd\",\r\n \"website\": \"https://cairolearninghub.edu.eg\",\r\n \"categories\": \"Programming\",\r\n \"contact\": {\r\n \"email\": \"info@cairolearninghub.edu.eg\",\r\n \"phone\": \"+20223456789\",\r\n \"address\": \"Downtown Cairo, Tahrir Square\"\r\n },\r\n \"socialMedia\": {\r\n \"facebook\": \"cairolearninghub\",\r\n \"linkedin\": \"company/cairolearninghub\",\r\n \"instagram\": \"cairolearninghub\"\r\n },\r\n \"isActive\": true\r\n }","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/centers","description":"This endpoint allows users to add a new center to the system. The request must include relevant information about the center in the body to ensure successful creation.
\nMethod: POST
\nURL: http://localhost:3000/api/v1/centers
The request body should be sent in application/json format and must include the following parameters:
name (text): The name of the center.
description (text): A brief description of the center's purpose or services offered.
ownerId (text): The unique identifier of the owner of the center.
website (text): The URL of the center's website.
categories (text): The categories that the center falls under.
contact (object): An object containing contact details:
email (text): The email address for inquiries.
phone (text): The phone number for contact.
address (text): The physical address of the center.
socialMedia (object): An object containing social media links:
facebook (text): The Facebook page of the center.
linkedin (text): The LinkedIn profile of the center.
instagram (text): The Instagram handle of the center.
isActive (boolean): A flag indicating whether the center is currently active.
Upon successful creation of a center, the server will respond with a JSON object that includes the following fields:
\nid: A unique identifier for the newly created center.
name: The name of the center.
description: The description provided during the request.
ownerId: The unique identifier of the owner of the center.
website: The URL of the center's website.
categories: The categories that the center falls under.
contact: An object containing the contact details provided.
socialMedia: An object containing the social media links provided.
isActive: The status of the center's activity.
createdAt: Timestamp indicating when the center was created.
updatedAt: Timestamp indicating when the center was last updated.
{\n \"id\": \"12345\",\n \"name\": \"Community Center\",\n \"description\": \"A place for community gatherings and events.\",\n \"ownerId\": \"685b6878ad4693238cd4bfcd\",\n \"website\": \"https://communitycenter.edu\",\n \"categories\": \"Community Services\",\n \"contact\": {\n \"email\": \"info@communitycenter.edu\",\n \"phone\": \"+1234567890\",\n \"address\": \"123 Main St, Anytown, USA\"\n },\n \"socialMedia\": {\n \"facebook\": \"communitycenter\",\n \"linkedin\": \"company/communitycenter\",\n \"instagram\": \"communitycenter\"\n },\n \"isActive\": true,\n \"createdAt\": \"2023-10-01T12:00:00Z\",\n \"updatedAt\": \"2023-10-01T12:00:00Z\"\n}\nMake sure to provide all required fields in the request body to ensure successful creation of the center.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","centers"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1de36d7-5eef-41b1-86e5-04a040ad8ae0"},{"name":"Get all centers","id":"109f7e16-29ba-4502-9db5-7afc72136483","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/centers/","description":"This endpoint allows users to retrieve a list of centers from the API. It is a simple HTTP GET request that does not require any parameters in the request body.
\nhttp://localhost:3000/api/v1/centers/Upon a successful request, the API will return a JSON response with the following structure:
\nemail: The email contact of the center.phone: The phone contact of the center.facebook: The Facebook link of the center.results will be 0, and the documents array may be empty.Make sure to handle any potential errors based on the API's error response structure.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","centers",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"109f7e16-29ba-4502-9db5-7afc72136483"},{"name":"Update center","id":"6f66a552-5aee-45ad-9f82-40a6c07e729d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"contact\": {\r\n \"email\": \"info@cairo-coding.edu.eg\",\r\n \"phone\": \"+20 2 12345678\"\r\n },\r\n \"socialMedia\": {\r\n \"facebook\": \"https://facebook.com/CairoCoding\"\r\n },\r\n \"_id\": \"685d05bca4345ccd25ae14fe\",\r\n \"name\": \"Cairo Coding Nasr academy\",\r\n \"description\": \"Premier technology education center in Egypt offering courses in software development, AI, and cybersecurity in both Arabic and English.\",\r\n \"website\": \"https://cairo-coding-academy.edu.eg\",\r\n \"numberOfBranches\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/centers/685d05bca4345ccd25ae14fe/","description":"This endpoint allows you to update the details of a specific center identified by its unique ID. It is particularly useful for modifying existing information related to a center in the system, such as its name, description, website, contact information, social media links, and active status. This operation is essential for maintaining accurate and up-to-date information about educational centers.
\nThe request body must be sent in application/json format and should include the following parameters:
name (text): The name of the center.
\ndescription (text): A detailed description of the center's services and facilities.
\nwebsite (text): The official website of the center.
\ncontact (object): An object containing the contact details of the center.
\nemail (text): The email address for contacting the center.
\nphone (text): The phone number for contacting the center.
\nsocialMedia (object): An object containing the social media links for the center.
\nnumberOfBranches (integer): The number of branches the center has.
\nisActive (boolean): A flag indicating whether the center is currently active.
\nUpon successful completion of the request, the response will contain the updated center information in JSON format. The structure of the response will include:
\n_id: The unique identifier of the center.
\nname: The updated name of the center.
\ndescription: The updated description of the center.
\nwebsite: The updated website of the center.
\ncontact: The updated contact details of the center.
\nemail: The updated email address for contacting the center.
\nphone: The updated phone number for contacting the center.
\nsocialMedia: The updated social media links for the center.
\nnumberOfBranches: The updated number of branches of the center.
\nisActive: The updated active status of the center.
\ncreatedAt: The timestamp when the center was created.
\nupdatedAt: The timestamp when the center was last updated.
\nIn case of an error, the response will provide an error message detailing the issue encountered during the update process.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","centers","685d05bca4345ccd25ae14fe",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f66a552-5aee-45ad-9f82-40a6c07e729d"},{"name":"Delete center","id":"79c750c0-e3c5-4847-acc4-c88908dad084","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:3000/api/v1/centers/685d05bca4345ccd25ae14fe","description":"This endpoint is used to delete a specific center identified by its unique identifier (ID). It is a part of the center management API, allowing users to remove a center from the system.
\nid (string): The unique identifier of the center that you wish to delete. In this example, the ID is 685d05bca4345ccd25ae14fe.Upon successful deletion, the API will respond with a status code indicating the result of the operation. The expected response includes:
\n204 No Content - This indicates that the request was successful and that the center has been deleted. There will be no content returned in the response body.<response>\n <status>204</status>\n</response>\nThis endpoint allows you to add a new branch to an existing center identified by its unique ID. The request is made using the HTTP POST method to the specified URL. This operation is essential for expanding the services offered by a center by establishing additional branches.
\nThe request body must be sent in raw JSON format and should include the following parameters:
Upon a successful request, the server will respond with the details of the newly created branch. The response will typically include:
\n{\n \"id\": \"new_branch_id\",\n \"name\": \"Branch Name\",\n \"address\": {\n \"street\": \"Branch Street\",\n \"city\": \"Branch City\",\n \"postalCode\": \"Branch Postal Code\",\n \"country\": \"Branch Country\"\n },\n \"geoLocation\": {\n \"type\": \"Point\",\n \"coordinates\": [longitude, latitude]\n },\n \"phone\": \"Branch Contact Number\",\n \"operatingHours\": [\n {\n \"day\": \"Saturday\",\n \"start\": \"10:00\",\n \"close\": \"18:00\"\n }\n ],\n \"isActive\": true,\n \"created_at\": \"timestamp\",\n \"updated_at\": \"timestamp\"\n}\nEnsure that all required fields are provided in the request body to successfully create a new branch.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","centers","685d05bca4345ccd25ae14fe","branches"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d405b4d-10a7-4c6e-b5b1-77d3398703b2"},{"name":"Get branches","id":"3d47a8c7-9b85-4d3b-bf98-f5809a094ee1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/centers/685d05bca4345ccd25ae14fe/branches","description":"This endpoint retrieves a list of branches associated with a specific center identified by its unique ID.
\nhttp://localhost:3000/api/v1/centers/{centerId}/branchescenterId (string): The unique identifier of the center whose branches are to be fetched.The response will contain a JSON object with the following structure:
\nbranchId (string): The unique identifier for the branch.branchName (string): The name of the branch.location (string): The physical location of the branch.contactNumber (string): The contact number for the branch.{\n \"status\": \"success\",\n \"data\": [\n {\n \"branchId\": \"12345\",\n \"branchName\": \"Main Branch\",\n \"location\": \"123 Main St\",\n \"contactNumber\": \"123-456-7890\"\n },\n {\n \"branchId\": \"67890\",\n \"branchName\": \"Secondary Branch\",\n \"location\": \"456 Secondary St\",\n \"contactNumber\": \"987-654-3210\"\n }\n ]\n}\nThis endpoint is useful for applications that need to display or manage the branches of a specific center.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","centers","685d05bca4345ccd25ae14fe","branches"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d47a8c7-9b85-4d3b-bf98-f5809a094ee1"}],"id":"3aa96574-745b-44fc-b871-537847e1f3ad","_postman_id":"3aa96574-745b-44fc-b871-537847e1f3ad","description":""},{"name":"Branches","item":[{"name":"Get branch","id":"32f98cb1-f09b-4c87-b703-c173f8f57817","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/branches/685d0681e63d8f3f217b87d6","description":"This endpoint retrieves detailed information about a specific branch identified by its unique identifier.
\nhttp://localhost:3000/api/v1/branches/{branchId}branchId (string): The unique identifier of the branch you wish to retrieve details for. In this example, it is 685d0681e63d8f3f217b87d6.Upon a successful request, the response will include detailed information about the branch. The expected response format typically includes:
\nid: The unique identifier of the branch.name: The name of the branch.location: The physical address or location of the branch.contact: Contact information for the branch.branchId provided in the request is valid and corresponds to an existing branch in the database.This endpoint allows you to update specific information about a branch identified by its unique ID.
\nHTTP Method: PATCH
Endpoint: /api/v1/branches/{branchId}
Path Parameter:
branchId (string): The unique identifier for the branch you wish to update.The request body must be in JSON format and can include the following parameter:
\nphone (string): The new phone number for the branch. This should be provided in a valid format.Example Request Body:
\n{\n \"phone\": \"+2 20214234\"\n}\nUpon a successful update, the server will respond with a status code indicating the success of the operation, typically a 200 OK status. The response may include the updated branch information, confirming that the changes have been applied.
Expected Response Structure:
\nstatus (string): Indicates the result of the operation (e.g., \"success\").data (object): Contains the updated branch details.This endpoint is useful for maintaining accurate and up-to-date contact information for branches in your system.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","branches","685d0681e63d8f3f217b87d6"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c462cf69-4a22-4bb0-8baf-2fe1cea52927"},{"name":"Delete Branch","id":"2363e425-11df-4ffd-a74f-917ae00d6d0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:3000/api/v1/branches/685d05bca4345ccd25ae14fe","description":"This endpoint is used to delete a specific branch identified by its unique ID. The ID is provided as part of the URL path.
\nhttp://localhost:3000/api/v1/branches/{branchId}{branchId} with the actual ID of the branch you wish to delete.Upon successful deletion, the API will return a response indicating the status of the operation. The response typically includes:
\n204 No Content if the deletion is successful.In case the branch ID does not exist, the API may return an error response with an appropriate message and an error code.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","branches","685d05bca4345ccd25ae14fe"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2363e425-11df-4ffd-a74f-917ae00d6d0b"},{"name":"Near branches","id":"b20ec939-3ad7-4ca4-abf3-3ba3719d4c45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/branches/nearby?lat=30.3&lng=30.9&radius=49.5&page=1","description":"This endpoint retrieves a list of branches that are located near a specified geographical point. The results can be filtered based on a defined search radius and can be paginated for easier navigation.
\nThe response will contain a list of branches within the specified radius of the given latitude and longitude. Each branch object in the response will typically include details such as branch name, address, and contact information.
\npage parameter.This endpoint allows you to retrieve a list of courses associated with a specific branch identified by its unique ID.
\nhttp://localhost:3000/api/v1/branches/{branchId}/coursesbranchId (string, required): The unique identifier of the branch for which you want to fetch the associated courses. In this example, the branch ID is 686602d45f05862e0fc63749.Upon a successful request, the server will return a list of courses associated with the specified branch. The response will typically include the following:
\nbranchId is valid and corresponds to an existing branch in the system.This endpoint allows you to add a new course to a specific branch identified by its unique ID. The request is made via an HTTP POST method, and it requires a JSON payload containing the details of the course to be added.
\nThe request body must be in JSON format and include the following parameters:
\nUpon a successful request, the API will return a response indicating the status of the operation. The response will typically include:
\nMake sure to validate the request data before sending it to ensure that all required fields are included and correctly formatted.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","branches","686a442dd8b74973a812e5fa","courses"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d9404be-bc1a-40ac-8333-8afdcf5eae18"},{"name":"Branch Instructors","id":"e85cfc44-50cc-493e-b698-16af53709971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/branches/686a442dd8b74973a812e5fa/instructors","description":"This endpoint retrieves a list of instructors associated with a specific branch identified by its unique ID.
\nGET/api/v1/branches/{id}/instructorsid (string): The unique identifier of the branch for which the instructors are being requested.On a successful request, the response will contain a list of instructors associated with the specified branch. The expected response format is typically JSON, containing an array of instructor objects, each with relevant details.
\n{\n \"instructors\": [\n {\n \"id\": \"instructor_id_1\",\n \"name\": \"Instructor Name 1\",\n \"subject\": \"Subject 1\"\n },\n {\n \"id\": \"instructor_id_2\",\n \"name\": \"Instructor Name 2\",\n \"subject\": \"Subject 2\"\n }\n ]\n}\nEnsure to replace {id} in the endpoint with the actual branch ID you wish to query.
This endpoint allows you to retrieve the details of the currently authenticated user. It is a simple HTTP GET request that does not require any request parameters.
\nhttp://localhost:3000/api/v1/users/meUpon a successful request, the server will return a response containing the user's information. The expected response structure typically includes the following fields:
\nid: Unique identifier for the user.name: The name of the user.email: The email address associated with the user account.createdAt: Timestamp indicating when the user account was created.updatedAt: Timestamp indicating the last time the user account was updated.This endpoint allows authenticated users to update their own user information. Specifically, it enables the modification of the user's username.
\nhttp://localhost:3000/api/v1/users/meusername (string): The new username for the user. This parameter is required to update the user's username.{\n \"username\": \"newUsername\"\n}\nUpon a successful update, the API will respond with a status code indicating success (typically 200 OK) and may return the updated user information, confirming the change.
\nThis endpoint is essential for users who wish to customize their profile and maintain accurate account information.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","users","me"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"af21bfca-184d-4eff-91b8-5d9833379b76"},{"name":"Change password","id":"3db7f1f2-d9a7-4799-b617-5a61537cdd08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"oldPassword\" : \"123123\",\r\n \"newPassword\" : \"1212\",\r\n \"newConfirmPassword\" : \"1212\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/users/me/change-password","description":"This endpoint allows users to change their password. It requires the user to provide their current password along with the new password and a confirmation of the new password in the request body.
\nMethod: PATCH
\nURL: http://localhost:3000/api/v1/users/me/change-password
Request Body (raw JSON):
\noldPassword (string): The current password of the user that needs to be verified before allowing the change.
newPassword (string): The new password that the user wishes to set. This should meet any specified security requirements (e.g., minimum length, complexity).
newConfirmPassword (string): A confirmation of the new password to ensure that it matches the newPassword.
Upon a successful request, the server will respond with a confirmation of the password change. The expected response will typically include:
\nA success message indicating that the password has been changed successfully.
\nA status code indicating the success of the operation.
\nEnsure that the oldPassword provided is correct; otherwise, the password change will not be permitted.
The new password should meet any specified security requirements (e.g., minimum length, complexity).
\nIf the request fails, appropriate error messages will be returned to indicate the reason for failure (e.g., incorrect old password, new passwords do not match, weak new password).
\nThis endpoint allows users to deactivate their account. Upon successful deactivation, the user's account will be marked as inactive, and they will no longer have access to the services associated with the account.
\nhttp://localhost:3000/api/v1/users/me/deactivate-accountThe request body must be sent in application/x-www-form-urlencoded format and should include the following parameters:
On successful account deactivation, the API will return a JSON response with the following structure:
\n{\n \"status\": \"success\",\n \"message\": \"Your account has been successfully deactivated.\",\n \"data\": {\n \"deactivatedAt\": \"2023-10-01T12:00:00Z\"\n }\n}\nThis endpoint allows the client to submit detailed information about a student. It is used to create or update a student's profile in the system.
\nhttp://localhost:3000/api/v1/students/informationThe request body must be in JSON format and should include the following structure:
\n{\n \"studentInformation\": {\n \"ssn\": \"string\", // The Social Security Number of the student.\n \"birthDate\": \"string\", // The birth date of the student in YYYY-MM-DD format.\n \"gender\": \"string\", // The gender of the student (e.g., Male, Female).\n \"address\": {\n \"street\": \"string\", // The street address of the student.\n \"city\": \"string\", // The city where the student resides.\n \"country\": \"string\" // The country where the student resides.\n },\n \"interestings\": \"string\" // The interests or hobbies of the student.\n }\n}\nThe response will contain information confirming the successful addition of the student's information. The structure of the response may vary based on the implementation but typically includes:
\nssn should be unique for each student.birthDate must follow the specified date format.This endpoint allows you to retrieve a list of courses available in the system.
\nhttp://localhost:3000/api/v1/coursesThis endpoint does not require any request parameters.
\nOn a successful request, the server will respond with a JSON object containing an array of courses. Each course object may include details such as:
\nid: Unique identifier for the coursetitle: Title of the coursedescription: Brief description of the courseduration: Duration of the courseinstructor: Name of the instructorThe response will have a status code of 200 OK if the request is successful.
Method: GET
URL: http://localhost:3000/api/v1/courses/Full-Stack-Web-Development
This endpoint retrieves detailed information about a specific course, in this case, the \"Full-Stack Web Development\" course. It is useful for users who want to obtain comprehensive details regarding the course structure, content, and other relevant information.
\nThis endpoint does not require any input parameters in the request. The course identifier is included directly in the URL.
\nThe response will include detailed information about the requested course. The expected structure of the response typically includes the following keys:
\nid: Unique identifier for the course.title: The title of the course.description: A detailed description of what the course covers.duration: The total duration of the course.modules: An array of modules included in the course, each containing:moduleId: Unique identifier for the module.moduleName: Name of the module.content: Description of the content covered in the module.instructor: Information about the instructor, including:name: The name of the instructor.bio: A brief biography of the instructor.The response will be returned in JSON format.
\n{\n \"id\": \"12345\",\n \"title\": \"Full-Stack Web Development\",\n \"description\": \"Learn to build full-stack applications using modern technologies.\",\n \"duration\": \"12 weeks\",\n \"modules\": [\n {\n \"moduleId\": \"1\",\n \"moduleName\": \"HTML & CSS\",\n \"content\": \"Introduction to web development.\"\n },\n {\n \"moduleId\": \"2\",\n \"moduleName\": \"JavaScript\",\n \"content\": \"Learn JavaScript programming.\"\n }\n ],\n \"instructor\": {\n \"name\": \"John Doe\",\n \"bio\": \"Experienced web developer and educator.\"\n }\n}\nThis endpoint allows you to update the instructor details for a specific course identified by its name. In this case, the course is \"Full-Stack-Web-Development\".
\nhttp://localhost:3000/api/v1/courses/Full-Stack-Web-DevelopmentThe request body should be in JSON format and must include the following structure:
\n{\n \"instructorDetails\": {\n \"fullname\": \"string\", // Full name of the instructor\n \"bio\": \"string\", // A brief biography of the instructor\n \"specialties\": [\"string\"], // An array of specialties related to the instructor's expertise\n \"contactEmail\": \"string\", // Email address for contacting the instructor\n \"socialMedia\": { // Social media handles of the instructor\n \"linkedIn\": \"string\", // LinkedIn profile identifier\n \"twitter\": \"string\" // Twitter handle\n }\n }\n}\nUpon a successful update, the response will typically include a confirmation message or the updated instructor details. The exact structure of the response may vary, but it generally contains:
\ninstructorDetails object reflecting the changes made.Make sure to provide valid data in the request body to ensure the update is processed correctly.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","courses","Full-Stack-Web-Development"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"7cf5c80c-712b-47b7-b910-3d493a904e1c"},{"name":"Delete course","id":"e620aed1-0cfb-435f-8f38-963eba09d40b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:3000/api/v1/courses/Digital-Marketing-Fundamentals","description":"This endpoint is used to delete a specific course from the system. The course to be deleted is identified by its name, which is passed as a path parameter in the URL.
\ncourseName (string): The name of the course that you wish to delete. In this case, it is Digital-Marketing-Fundamentals.This DELETE request does not require a request body. No additional parameters are needed to complete the deletion.
\nUpon successful deletion, the API will return a response indicating the result of the operation. The response typically includes:
\nUse this endpoint when you need to remove a course from the database. Ensure that the specified course name is correct to avoid errors.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","courses","Digital-Marketing-Fundamentals"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"e620aed1-0cfb-435f-8f38-963eba09d40b"}],"id":"00513209-c472-4c05-a1fd-9e7af3225e0c","_postman_id":"00513209-c472-4c05-a1fd-9e7af3225e0c","description":""},{"name":"Instructors","item":[{"name":"Instructor courses","id":"26ad4796-74eb-46dd-b19e-65a6f5b07f07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:3000/api/v1/instructors/Omar-Hassan-Saif/courses","description":"This endpoint retrieves a list of courses associated with a specific instructor.
\nGET/api/v1/instructors/{instructorName}/coursesinstructorName (string): The name of the instructor whose courses you want to retrieve. In this example, the instructor's name is Karim-Mahmoud-ElKhalily.The response will return a JSON object containing an array of courses related to the specified instructor. Each course object typically includes details such as course ID, title, description, and other relevant information.
\n200 OK on successful retrieval.Example of a course object in the response:
\n{\n \"courseId\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n // other course properties\n}\nEnsure that the instructor's name is correctly formatted in the URL to receive the appropriate course data.
\n","urlObject":{"protocol":"http","port":"3000","path":["api","v1","instructors","Omar-Hassan-Saif","courses"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"26ad4796-74eb-46dd-b19e-65a6f5b07f07"}],"id":"ea22a413-dc2f-4220-b86f-f7617eecedb5","_postman_id":"ea22a413-dc2f-4220-b86f-f7617eecedb5","description":""},{"name":"Notifications","item":[{"name":"Get notifications","id":"ea32b449-f3e5-478c-a19b-46a6ffa711c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:3000/api/v1/notifications","description":"This endpoint retrieves a list of notifications for the authenticated user.
\nOn a successful request, the server will return a JSON object containing the following:
\nstatus: A string indicating the success or failure of the request.
\ndata: An array of notification objects, each containing:
\nid: A unique identifier for the notification.
\ntitle: The title of the notification.
\nmessage: The content of the notification.
\ntimestamp: The time when the notification was created.
\nEnsure that the user is authenticated before making the request.
\nIf there are no notifications, the data array will be empty.
Handle any potential errors gracefully, as the server may return different status codes based on the request's outcome.
\n