Postman allows you to test your APIs using simple Javascript code. You can evaluate your response body, headers, cookies, and more using the ChaiJS BDD syntax.
\nThis template guides you through the process of setting up an integration test to ensure that all individual components of an API function together seamlessly.
\nBy setting up requests in the order of the operation, we can test the flow of data to and from the endpoints and ensure they work together as expected. We also verify that the data persists between requests on the back end.
\nStep 1: Check out the requests' documentation to learn more about -
\nStep 2: Run this collection by clicking on \"Run\".
\nStep 3: To customize this template, replace the request URLs with your API endpoints and add or edit the tests if needed.
\nThis returns a token that you can use to retrieve information later on.
We have included a test to confirm if a token is returned. We have also added test scripts to copy the token to the token collection variable. This makes it easy for us to reuse this token in other requests in the collection.
This request uses the saved token collection variable to access a secret 'name' stored against that token.
In this request, we used the token collection variable as a query param to fetch the name generated for that token. We have added a test to check that a name is correctly returned.
This request un-registers a token by using the token collection variable in the POST body.
\nWe also added a test to ensure the response has a 200 OK status code.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","v1","users","student","dashboard"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"328269ab-8db1-4c12-a15e-8f3455a2af66","name":"Role Access","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/v1/users/student/dashboard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"46","enabled":true},{"key":"ETag","value":"W/\"2e-hFUKYJOKyBdxiQTdxXmK2ppm+ik\"","enabled":true},{"key":"Date","value":"Sat, 23 Mar 2024 18:11:43 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Welcome To University Course Web\"\n}"}],"_postman_id":"480f6fe2-85ad-41d2-a560-aec8c3579785"},{"name":"Role Access Faculty","id":"3179f0e4-dcba-454d-bf9c-5c303843be35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"http://localhost:8080/api/v1/users/faculty/dashboard","urlObject":{"protocol":"http","port":"8080","path":["api","v1","users","faculty","dashboard"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d9cef37e-03f8-4e0b-835e-d0310b8e6c1c","name":"Role Access Faculty","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"http://localhost:8080/api/v1/users/faculty/dashboard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"53","enabled":true},{"key":"ETag","value":"W/\"35-2nWBgD9L0yQLQit3ejD/z5Wom98\"","enabled":true},{"key":"Date","value":"Sun, 24 Mar 2024 09:43:19 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Access Granted You are a Faculty member\"\n}"}],"_postman_id":"3179f0e4-dcba-454d-bf9c-5c303843be35"},{"name":"Role Access Admin","id":"587f7c5b-fdc8-463d-8aee-f12167cfe8e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"http://localhost:8080/api/v1/users/admin/dashboard","urlObject":{"protocol":"http","port":"8080","path":["api","v1","users","admin","dashboard"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"c3f417e2-eed5-4e83-bed0-42c89a71d3ca","name":"Role Access Admin","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"http://localhost:8080/api/v1/users/admin/dashboard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"50","enabled":true},{"key":"ETag","value":"W/\"32-3p8KUGjUhaoMNS8udoXvmLnkf4w\"","enabled":true},{"key":"Date","value":"Sun, 24 Mar 2024 09:43:59 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Access Granted You are in Admin mode\"\n}"}],"_postman_id":"587f7c5b-fdc8-463d-8aee-f12167cfe8e9"}],"id":"4636aac9-ad03-485f-ad9e-6926a5c4b2d6","description":"Register User
\nLogin User
\nRole Access With JWT Token
\nEnable Admins to assign Faculty to courses.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","v1","courses","65ffea6e4963d5b51cd03932","assign-faculty"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"05931710-3af8-4a66-a72f-93dc827b8193","name":"Assign Faculty to a course","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"faculty\": \"Computing\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/v1/courses/65fdf6aca1ae1df79aee99aa/assign-faculty"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"53","enabled":true},{"key":"ETag","value":"W/\"35-yeii0CM+WGfpCwRjlOPoNvGKtWA\"","enabled":true},{"key":"Date","value":"Fri, 22 Mar 2024 21:27:06 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Faculty assigned to course successfully\"\n}"}],"_postman_id":"a57a886c-ba69-40ac-85fd-bac0992dcfa7"},{"name":"Delete a course by ID","event":[{"listen":"test","script":{"id":"b907783e-aa98-45bd-b204-188f9518c037","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Response contains success message\", function () {\r"," var jsonData = pm.response.json();\r"," pm.expect(jsonData.message).to.equal(\"Course deleted successfull!\");\r","});\r",""],"type":"text/javascript","packages":{}}}],"id":"774cee60-a1e1-436e-8238-4e077e1c0b98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/v1/courses/65ff25edc1b057129ebd602d","urlObject":{"protocol":"http","port":"8080","path":["api","v1","courses","65ff25edc1b057129ebd602d"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"61d0ebaa-0cc4-4b49-add2-748a26e79a18","name":"Delete a course by ID","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/v1/courses/65ff25edc1b057129ebd602d"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"http://localhost:8080","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests","enabled":true},{"key":"Cross-Origin-Opener-Policy","value":"same-origin","enabled":true},{"key":"Cross-Origin-Resource-Policy","value":"same-origin","enabled":true},{"key":"Origin-Agent-Cluster","value":"?1","enabled":true},{"key":"Referrer-Policy","value":"no-referrer","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-DNS-Prefetch-Control","value":"off","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"X-XSS-Protection","value":"0","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"41","enabled":true},{"key":"ETag","value":"W/\"29-gccwjs/VAEaFeQ/LVZbkoIQ49J4\"","enabled":true},{"key":"Date","value":"Sun, 24 Mar 2024 13:12:55 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Course deleted successfull!\"\n}"}],"_postman_id":"774cee60-a1e1-436e-8238-4e077e1c0b98"}],"id":"934f88e0-234b-4a95-b988-2392f7d97675","description":"Create Course
\nView Course
\nView Course By ID
\nUpdate Course By ID
\nDelete Course BY ID
\nAssign Faculty Access only For Adimn And Faculty
\nCheck if classroom exists.
\nCalculate total capacity of selected resources.
\nCheck if total resource capacity exceeds classroom capacity.
\nCheck if classroom is already booked for the specified date and time.
\nCheck if any of the resources are already booked for the specified date and time.
\n","urlObject":{"protocol":"http","port":"8080","path":["api","v1","bookings"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"168c899b-4a09-4b3f-8ee4-f393cf56a741","name":"New Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"classroomID\": \"65fe07ae3965e8cef983a622\", // Replace with a valid Classroom ObjectId\r\n \"resources\": [\"65fe07d93965e8cef983a626\", \"65fe07c63965e8cef983a624\"], // Replace with valid Resource ObjectIds\r\n \"date\": \"2024-04-01\",\r\n \"startTime\": \"09:00 AM\",\r\n \"endTime\": \"12:00 PM\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/v1/bookings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"280","enabled":true},{"key":"ETag","value":"W/\"118-Y4N3gnHP7wqgu/7WV9SqqqIGaDA\"","enabled":true},{"key":"Date","value":"Fri, 22 Mar 2024 22:45:19 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Booking created successfully\",\n \"booking\": {\n \"classroom\": \"65fe07ae3965e8cef983a622\",\n \"resources\": [\n \"65fe07d93965e8cef983a626\",\n \"65fe07c63965e8cef983a624\"\n ],\n \"date\": \"2024-04-01T00:00:00.000Z\",\n \"startTime\": \"09:00 AM\",\n \"endTime\": \"12:00 PM\",\n \"_id\": \"65fe09ff3965e8cef983a638\",\n \"__v\": 0\n }\n}"}],"_postman_id":"417661d7-6dec-45fb-b817-4bcac1907538"},{"name":"Read booking by ID","event":[{"listen":"test","script":{"id":"c2a9363d-b36d-4fac-8507-bf9ae7802cdb","exec":["// Status code test for successful retrieval\r","pm.test(\"Status code is 200 for successful retrieval\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","\r","\r","// Response content test for successful retrieval\r","pm.test(\"Response contains retrieved booking object\", function () {\r"," pm.expect(pm.response.json()).to.be.an(\"object\").and.to.have.property(\"_id\");\r"," // Add more assertions based on the structure of the booking object if needed\r","});\r",""],"type":"text/javascript","packages":{}}}],"id":"32ffb247-a633-4d68-a825-60a45973377d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/api/v1/bookings/65fe09ff3965e8cef983a638","urlObject":{"protocol":"http","port":"8080","path":["api","v1","bookings","65fe09ff3965e8cef983a638"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"0772e5bc-ed3d-4a1c-a43d-0237b929e762","name":"New Request","originalRequest":{"method":"GET","header":[],"url":"http://localhost:8080/api/v1/bookings/65fe09ff3965e8cef983a638"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"227","enabled":true},{"key":"ETag","value":"W/\"e3-b7pGb7GhgmYdm8I4oikh9CaILKI\"","enabled":true},{"key":"Date","value":"Fri, 22 Mar 2024 22:52:03 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"65fe09ff3965e8cef983a638\",\n \"classroom\": \"65fe07ae3965e8cef983a622\",\n \"resources\": [\n \"65fe07d93965e8cef983a626\",\n \"65fe07c63965e8cef983a624\"\n ],\n \"date\": \"2024-04-01T00:00:00.000Z\",\n \"startTime\": \"09:00 AM\",\n \"endTime\": \"12:00 PM\",\n \"__v\": 0\n}"}],"_postman_id":"32ffb247-a633-4d68-a825-60a45973377d"},{"name":"Update Booking by ID","event":[{"listen":"test","script":{"id":"f9436c6b-3142-47dd-8513-84dce1751739","exec":["// Status code test for successful update\r","pm.test(\"Status code is 200 for successful update\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","// Status code test when booking is not found\r","pm.test(\"Status code is 404 when booking is not found\", function () {\r"," pm.response.to.have.status(404);\r","});\r","\r","// Status code test for classroom not found\r","pm.test(\"Status code is 404 when classroom is not found\", function () {\r"," pm.response.to.have.status(404);\r","});\r","\r","// Status code test for resource not found\r","pm.test(\"Status code is 404 when resource is not found\", function () {\r"," pm.response.to.have.status(404);\r","});\r","\r","// Status code test for resources exceeding classroom capacity\r","pm.test(\"Status code is 400 when resources exceed classroom capacity\", function () {\r"," pm.response.to.have.status(400);\r","});\r","\r","// Status code test for scheduling conflict with existing booking\r","pm.test(\"Status code is 400 when there is a scheduling conflict with existing booking\", function () {\r"," pm.response.to.have.status(400);\r","});\r","\r","// Response content test for successful update\r","pm.test(\"Response contains updated booking object\", function () {\r"," pm.expect(pm.response.json()).to.be.an(\"object\").and.to.have.property(\"_id\");\r"," // Add more assertions based on the structure of the updated booking object if needed\r","});\r",""],"type":"text/javascript","packages":{}}}],"id":"90735d96-7651-4100-b766-3bcefb6418de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"classroomID\": \"65fe07ae3965e8cef983a622\", // Replace with a valid Classroom ObjectId\r\n \"resources\": [\"65fe07d93965e8cef983a626\", \"65fe07c63965e8cef983a624\"], // Replace with valid Resource ObjectIds\r\n \"date\": \"2024-04-01\",\r\n \"startTime\": \"08:30 AM\",\r\n \"endTime\": \"12:00 PM\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/v1/bookings/65fe09ff3965e8cef983a638","urlObject":{"protocol":"http","port":"8080","path":["api","v1","bookings","65fe09ff3965e8cef983a638"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ad2e6692-69cc-48ee-bb1d-3d5371b32074","name":"New Request","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"classroomID\": \"65fe07ae3965e8cef983a622\", // Replace with a valid Classroom ObjectId\r\n \"resources\": [\"65fe07d93965e8cef983a626\", \"65fe07c63965e8cef983a624\"], // Replace with valid Resource ObjectIds\r\n \"date\": \"2024-04-01\",\r\n \"startTime\": \"08:30 AM\",\r\n \"endTime\": \"12:00 PM\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/v1/bookings/65fe09ff3965e8cef983a638"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"227","enabled":true},{"key":"ETag","value":"W/\"e3-FC52BbDfYDGqWSa9v9PG2QKaAdg\"","enabled":true},{"key":"Date","value":"Fri, 22 Mar 2024 22:54:24 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"65fe09ff3965e8cef983a638\",\n \"classroom\": \"65fe07ae3965e8cef983a622\",\n \"resources\": [\n \"65fe07d93965e8cef983a626\",\n \"65fe07c63965e8cef983a624\"\n ],\n \"date\": \"2024-04-01T00:00:00.000Z\",\n \"startTime\": \"08:30 AM\",\n \"endTime\": \"12:00 PM\",\n \"__v\": 0\n}"}],"_postman_id":"90735d96-7651-4100-b766-3bcefb6418de"},{"name":"Delete Booking by ID","id":"e5dade3e-bf07-4b7f-8668-f85d27e67eb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:8080/api/v1/bookings/65f9582012d539e4f8faf8d0","urlObject":{"protocol":"http","port":"8080","path":["api","v1","bookings","65f9582012d539e4f8faf8d0"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"c13e124d-fee8-4ff9-9783-2b5524621b6e","name":"New Request","originalRequest":{"method":"DELETE","header":[],"url":"http://localhost:8080/api/v1/bookings/65f9582012d539e4f8faf8d0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"42","enabled":true},{"key":"ETag","value":"W/\"2a-gVcEEnK8+lEWo3IHFtPL/zRKQgM\"","enabled":true},{"key":"Date","value":"Fri, 22 Mar 2024 22:56:01 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Booking deleted successfully\"\n}"}],"_postman_id":"e5dade3e-bf07-4b7f-8668-f85d27e67eb6"}],"id":"bb414785-ec8a-4cd7-921e-3b01f741b9a8","_postman_id":"bb414785-ec8a-4cd7-921e-3b01f741b9a8","description":""}],"id":"2e6fcafe-c180-44d5-8f8b-f92e3e0ce480","description":"Validations
\nCheck if total resource capacity exceeds classroom capacity.
\nCheck if classroom is already booked for the specified date and time.
\nCheck if any of the resources are already booked for the specified date and time.
\nTo delete and view all student enrollments (for admins and faculty) Need To Login as Admin or Faculty.
\nEnrolled Student Can get timetable for enrolled Courses.
\nEnable students to enroll in courses and view their timetables.
\ncreate a notification (accessible only by Admin and Faculty)
\nget notifications for a specific user Get notification by UserID
\nupdate a notification by ID (accessible only by Admin and Faculty)
\ndelete a notification by ID (accessible only by Admin and Faculty)
\n