This API is designed for an event management system and includes endpoints for managing users, colleges, students, and events.
\nAll the API endpoints return data in a JSON format. Most of the endpoints require
JWT token authentication. The JWT token should be included in the Authorization header of the request in the format Bearer .
To use this API, you first need to register a user and obtain a JWT token.
The token is then used to authenticate further requests.
This endpoint is used to register a new user. It requires email, password, name, college_id, and roll_number in the request body. The response contains the details of the newly created user
\n","urlObject":{"protocol":"http","port":"8000","path":["api","register",""],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"d2771010-e51e-4a4e-99de-4de99ad3929d","name":"http://127.0.0.1:8000/api/register/","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"email\": \"test4@test.com\",\r\n \"password\": \"testpassword\",\r\n \"name\": \"Test User4\",\r\n \"college\": 3\r\n }","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/register/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Oct 2023 17:03:16 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.0rc1"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"65"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 9,\n \"email\": \"test4@test.com\",\n \"name\": \"Test User4\",\n \"college\": 3\n}"}],"_postman_id":"7b5f3642-e4ed-4fbe-948d-0b3881f8ed2f"},{"name":"JWT Token Generation","id":"01d15718-b1c5-438f-9ce4-b92169dcc638","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"email\": \"test@test.com\",\r\n \"password\": \"testpassword\"\r\n }","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/token/","description":"This endpoint is used to generate a new JWT token for user authentication. It requires email and password in the request body. The response contains the generated JWT token
\n","urlObject":{"protocol":"http","port":"8000","path":["api","token",""],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"fa4a778c-084a-4e47-8d63-7d64e0e39b88","name":"http://127.0.0.1:8000/api/token/","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"email\": \"test@test.com\",\r\n \"password\": \"testpassword\"\r\n }","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/token/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Oct 2023 14:32:48 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.0rc1"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"483"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"refresh\": \"xxxxxx\",\n \"access\": \"xxxxxxx\"\n}"}],"_postman_id":"01d15718-b1c5-438f-9ce4-b92169dcc638"},{"name":"JWT Token Refresh","id":"c61258e1-1458-4ec2-b6d1-585678f279f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" { \r\n\r\n \"refresh\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTY5ODA5MzEzOCwiaWF0IjoxNjk4MDA2NzM4LCJqdGkiOiIwNjE3YmJiOTMxYmM0ZmY4OTlkZTE3ZjA0ZTUwMzY1MCIsInVzZXJfaWQiOjR9.KMyqesehokU9Z1OwLdRaYDFmd-n4ZEFnsLOWC9EmaMM\" \r\n\r\n }","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/token/refresh/","description":"This endpoint is used to refresh the JWT token. It requires the refresh token in the request body. The response contains the new JWT access token.
\n","urlObject":{"protocol":"http","port":"8000","path":["api","token","refresh",""],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"e707f90f-fa11-473c-a107-bb9590eb8f81","name":"JWT Token Refresh","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" { \r\n\r\n \"refresh\": \"xxxxxx\" \r\n\r\n }","options":{"raw":{"language":"json"}}},"url":"http://127.0.0.1:8000/api/token/refresh/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Oct 2023 20:33:44 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.0rc1"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"241"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"access\": \"xxxxxx\"\n}"}],"_postman_id":"c61258e1-1458-4ec2-b6d1-585678f279f9"},{"name":"College Management","id":"8add806b-d84a-4170-9c08-fc5d702e7017","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/api/colleges/","description":"This endpoint is used to get a list of all colleges (GET) or create a new college (POST)
This endpoint is used to get, update, partially update, or delete a specific college
\n","urlObject":{"protocol":"http","port":"8000","path":["api","colleges","2"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"9dea358c-ddac-48b6-858d-1f3f683b843f","name":"College Detail","originalRequest":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/api/colleges/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Oct 2023 19:53:12 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.0rc1"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"42"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"code\": \"COL-B\",\n \"name\": \"College B\"\n}"}],"_postman_id":"cd7a9a64-9fe9-471b-a058-df6b34f7bf28"},{"name":"Student Management","id":"3c19d98c-c7ab-4994-9440-4070c7fd4d5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/api/students/","description":"This endpoint is used to get a list of all students (GET) or create a new student (POST)
This endpoint is used to get, update, partially update, or delete a specific student
\n","urlObject":{"protocol":"http","port":"8000","path":["api","students","3"],"host":["127","0","0","1"],"query":[],"variable":[]}},"response":[{"id":"ee12db75-143f-4db0-b4e5-147e816c27ea","name":"Student Detail","originalRequest":{"method":"GET","header":[],"url":"http://127.0.0.1:8000/api/students/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Oct 2023 19:55:05 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.0rc1"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"68"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"name\": \"Student 3\",\n \"roll_number\": \"003\",\n \"user\": 3,\n \"college\": 3\n}"}],"_postman_id":"ad093d4e-7ee0-439a-8827-e171d20c21a3"},{"name":"Events","id":"5342363d-2090-434c-bc16-ffa40e0bfb00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjk4MDA0ODkyLCJpYXQiOjE2OTgwMDQ1OTIsImp0aSI6IjhhMGU2N2Q0M2EwODQ4MTNiN2RjNzE4NWJmNDU2ZDYzIiwidXNlcl9pZCI6NH0.Z9lFQHHw4l15OayulqmMvaIkTt5E6_-3CyHVnErPAs4","type":"text"}],"url":"http://127.0.0.1:8000/api/events/","description":"This endpoint is used to get a list of all events available for that specific student based on their college.
It requires an Authorization header
Authorization: Bearer JWT_access_token
This endpoint is used to view a specific event. Event visible only if the event belongs to the college in which the student is from
\nIt requires an Authorization header
Authorization: Bearer JWT_access_token