Skip to content

Commit

Permalink
Added Postman collection with all APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
sumitst05 committed Dec 18, 2023
1 parent 16aa476 commit c3b3895
Show file tree
Hide file tree
Showing 32 changed files with 86 additions and 0 deletions.
22 changes: 22 additions & 0 deletions api_collections/api_collections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## **ERP Backend API Collections**

This workspace is dedicated to the ERP backend API, organized into collections that represent individual endpoints. Each collection contains requests for various HTTP methods, including GET, POST, PUT, and DELETE, corresponding to specific functionalities within the ERP system.

**Note:** For endpoints that include the `/list` route, you have the flexibility to customize the data retrieval using query parameters. Specifically, you can pass `page` and `filter` as query parameters to tailor the results. If these parameters are omitted, the API will return all available data.

**Example:**

- List all accreditations:

```
localhost://3000/accreditation/list
```

- Customized listing with pagination and filtering:

```
localhost://3000/accreditation/list?page=2&limit=3
```

---
Import this into an API Client of your choice (Postman, Thunder Client, etc.)
34 changes: 34 additions & 0 deletions api_collections/archive.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"collection": {
"318b0772-c43a-4602-b841-4ec03c4880d0": true,
"3553abfa-38de-44cc-b5d4-b1b4d49eca31": true,
"1117bf5a-20c5-4c12-bceb-2dc4b198068c": true,
"463becc9-b939-4e98-b18a-13f91b49e3d9": true,
"3fd36682-4620-4f75-99dc-a8fa324e883c": true,
"703b39d0-931c-4e08-8d69-1cfe5cab5f01": true,
"564e9231-fc2c-48e3-a818-4d8a255ca02d": true,
"381df9f6-ab5a-4783-a1f8-b1ca4f982993": true,
"4bdf746b-9314-4917-abb1-24695fc3995b": true,
"897739ed-07ee-4590-9424-e32079dbab30": true,
"5652ddf3-92ce-4328-9c22-763723c2fc23": true,
"5732c019-3ee0-4a71-81ee-06ad720c6139": true,
"8165772d-f964-4af6-9eeb-79f354729473": true,
"97a57a2f-a2c1-48a4-9e09-56325ff2de25": true,
"7ae5a647-af59-4395-bce3-942f160ef874": true,
"871f470e-fc04-404f-9849-c89f4d79be51": true,
"a7837d0b-00d7-4709-9f91-d4d89be256b1": true,
"9dc56da6-7565-4ad0-a5c3-b0e9eebb7461": true,
"a9c397c6-0e45-4e4d-9ab7-38193d65008e": true,
"d64c14a5-362a-41e9-9fa1-5f7d93ab1c02": true,
"b112685f-00ae-4493-ba33-f4ead282236b": true,
"c894ed4d-56af-4346-8fff-d6286eb85e3b": true,
"d528bf3a-eb58-48ec-8a1c-c79c62d673e2": true,
"cb8df51e-1014-4358-919c-3378ac431d62": true,
"ed82edec-9c7c-4fce-a00b-e531288e0c80": true,
"f37302e2-693b-4fa6-b926-1cf0e5032e6d": true,
"deaa0fc0-e06f-4427-8051-b2f3550a8aa0": true,
"f54f8502-855b-4e1f-8ad7-8a4d3e33ce2c": true,
"fda43fc4-6ae2-4d95-88ff-31f5e2ceb0ba": true,
"f291aff3-514f-42be-a9bb-a9159018ba59": true
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"info":{"_postman_id":"1117bf5a-20c5-4c12-bceb-2dc4b198068c","name":"Activity Blurprint","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"list activity blueprints","id":"1ceeccff-b831-4eba-ae89-a7624988a1f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/activityBlueprint/list","host":["localhost"],"port":"3000","path":["activityBlueprint","list"]}},"response":[]},{"name":"add activity blueprint","id":"016c821e-33e4-404b-b95c-76581da978a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/activityBlueprint/add","host":["localhost"],"port":"3000","path":["activityBlueprint","add"]}},"response":[]},{"name":"delete activity blueprint","id":"055d223b-1ddd-4d53-be1b-0d2342ade24d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/activityBlueprint/delete/:{id}","host":["localhost"],"port":"3000","path":["activityBlueprint","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Activity Blurprint Id"}]}},"response":[]},{"name":"update activity blueprint","id":"203ce6a5-5070-4651-a737-3926040cfbd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/activityBlueprint/update/:{id}","host":["localhost"],"port":"3000","path":["activityBlueprint","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Activity Blueprint Id"}]}},"response":[]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"info":{"_postman_id":"318b0772-c43a-4602-b841-4ec03c4880d0","name":"Faculty","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"list faculties","id":"4b603237-5c29-48e8-a43d-c73a8c73b652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/faculty/list","host":["localhost"],"port":"3000","path":["faculty","list"]}},"response":[]},{"name":"create faculty","id":"345d70ee-8ff5-4da6-8fb9-3e334d8a33b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/faculty/create","host":["localhost"],"port":"3000","path":["faculty","create"]}},"response":[]},{"name":"delete faculty","id":"440ee4c1-7c60-4b46-ae49-aedc063afc38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/faculty/delete/:{id}","host":["localhost"],"port":"3000","path":["faculty","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Faculty Id"}]}},"response":[]},{"name":"update faculty","id":"ffafc819-10ca-4104-8005-0398869dec77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/faculty/update/:{id}","host":["localhost"],"port":"3000","path":["faculty","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Faculty Id"}]}},"response":[]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"info":{"_postman_id":"3553abfa-38de-44cc-b5d4-b1b4d49eca31","name":"Articles API","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Create Article","id":"f47cc60d-bb8e-409a-a037-c272442fce67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Article2\",\n \"tags\": [\"Cloud\", \"custom\"],\n \"content\": \"This is my second Article. Hope you enjoy it\",\n \"author\": \"65577f49910050d6c99d70f9\",\n \"likes\": 5,\n \"comments\": \"65578017910050d6c99d70ff\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{URL}}/articles","host":["{{URL}}"],"path":["articles"]}},"response":[]},{"name":"Get Articles","id":"574807d9-9698-4a82-9d94-2c04d1482dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{URL}}/articles","host":["{{URL}}"],"path":["articles"]}},"response":[]},{"name":"Update Article","id":"88be54f3-7a56-4efe-8198-85906623f8a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Article2\",\n \"tags\": [\"Cloud\", \"custom\"],\n \"content\": \"This is my second Article. Enjoy! :)\",\n \"author\": \"65577f49910050d6c99d70f9\",\n \"views\": 15,\n \"likes\": 8,\n \"comments\": \"65578017910050d6c99d70ff\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{URL}}/articles/655781e0b836bfdcb15262f3","host":["{{URL}}"],"path":["articles","655781e0b836bfdcb15262f3"]}},"response":[]},{"name":"Delete Article","id":"62bbb031-cb0c-4624-9c39-9d5bf1537fe9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{URL}}/articles/655781e0b836bfdcb15262f3","host":["{{URL}}"],"path":["articles","655781e0b836bfdcb15262f3"]}},"response":[]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"info":{"_postman_id":"381df9f6-ab5a-4783-a1f8-b1ca4f982993","name":"Users","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"get users","id":"6ee176ae-4113-4dc8-861b-1063a8c4addf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/users/get","host":["localhost"],"port":"3000","path":["users","get"]}},"response":[]},{"name":"add user","id":"de847893-c903-4c79-bcdf-3fe4fd515587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/users/add","host":["localhost"],"port":"3000","path":["users","add"]}},"response":[]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"info":{"_postman_id":"3fd36682-4620-4f75-99dc-a8fa324e883c","name":"Organization","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"list organizations","id":"93c2a81f-4a2e-4ed4-ac9d-be6ec82d1995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/organization/list","host":["localhost"],"port":"3000","path":["organization","list"]}},"response":[]},{"name":"add organization","id":"09176683-c6a9-409b-bb08-cd9f0b77ed4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/organization/add","host":["localhost"],"port":"3000","path":["organization","add"]}},"response":[]},{"name":"delete organization","id":"7ff14ca0-aa93-4db8-bd34-8986be1220c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/organization/delete/:{id}","host":["localhost"],"port":"3000","path":["organization","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Organization Id"}]}},"response":[]},{"name":"update organization","id":"cf14fa2c-1328-474d-92b5-952c039e99cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/organization/update/:{id}","host":["localhost"],"port":"3000","path":["organization","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Organization Id"}]}},"response":[]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"info":{"_postman_id":"463becc9-b939-4e98-b18a-13f91b49e3d9","name":"ERP Backend","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"Accreditation","item":[{"name":"list accreditations","id":"5b590b65-0810-425b-8b99-428921e674f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/accreditation/list","host":["localhost"],"port":"3000","path":["accreditation","list"]}},"response":[]},{"name":"add accreditation","id":"aaac0b73-02b8-4071-9e21-f73f83907425","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/accreditation/add","host":["localhost"],"port":"3000","path":["accreditation","add"]}},"response":[]},{"name":"delete accreditation","id":"da95cbbd-46cb-45ff-b7c7-489dc523f2dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/accreditation/delete/:{id}","host":["localhost"],"port":"3000","path":["accreditation","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Accreditation iD"}]}},"response":[]},{"name":"update accreditation","id":"9db7973a-3ba4-4468-beb7-ce547c9fc454","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/accreditation/update/:{id}","host":["localhost"],"port":"3000","path":["accreditation","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Accreditation ID"}]}},"response":[]}],"id":"b130d2cf-1774-47e7-9cc8-e67fa8fa7a96"},{"name":"Activity","item":[{"name":"list accreditations","id":"6a661093-8d40-4f10-b69f-3a32f28ef0e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/activity/list","host":["localhost"],"port":"3000","path":["activity","list"]}},"response":[]},{"name":"add accreditation","id":"cc3ac787-70f0-4134-9f83-eae5640fc881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/activity/add","host":["localhost"],"port":"3000","path":["activity","add"]}},"response":[]},{"name":"delete accreditation","id":"1bbd5d96-d4ca-499e-8203-695b3808643b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/activity/delete/:{id}","host":["localhost"],"port":"3000","path":["activity","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Activity ID"}]}},"response":[]},{"name":"update accreditation","id":"6248503c-3e73-4c0d-9763-59ce7394462d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/activity/update/:{id}","host":["localhost"],"port":"3000","path":["activity","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Activity ID"}]}},"response":[]}],"id":"ce64b4fe-b276-4fab-a309-b4a6cb28d6d8"},{"name":"Activity Blueprint","item":[{"name":"get activity blueprints","id":"2e879b85-f26d-42f0-b401-c5ff359feb02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/activityBlueprint/list","host":["localhost"],"port":"3000","path":["activityBlueprint","list"]}},"response":[]},{"name":"add activity blueprint","id":"5d69d2ca-1abc-4705-bbc4-2f01cf3f789e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/activiyBlueprint/add","host":["localhost"],"port":"3000","path":["activiyBlueprint","add"]}},"response":[]},{"name":"delete activity blueprint","id":"675e6dc4-6b2f-4d1f-88bb-155d3e9e33ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/activityBlueprint/delete/:{id}","host":["localhost"],"port":"3000","path":["activityBlueprint","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Activity Blueprint ID"}]}},"response":[]},{"name":"New Request","id":"83abcbd2-564c-4a7a-8ebe-e2cb5d25edc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/activityBlueprint/update/:{id}","host":["localhost"],"port":"3000","path":["activityBlueprint","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Activity Blueprint ID"}]}},"response":[]}],"id":"cebc416c-d819-4ac6-b6dc-b9d11c8f78a7"},{"name":"Assignment","item":[{"name":"list accreditations","id":"e21bb38e-3bb7-4cbb-9cd4-b939363c3100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/assignment/list","host":["localhost"],"port":"3000","path":["assignment","list"]}},"response":[]},{"name":"add accreditation","id":"0c3b26a3-909b-4a82-a3f8-54b6aff6c3b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/assignment/add","host":["localhost"],"port":"3000","path":["assignment","add"]}},"response":[]},{"name":"delete accreditation","id":"6c901808-f622-4747-b976-633e0a539b9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/assignment/delete/:{id}","host":["localhost"],"port":"3000","path":["assignment","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Assignment ID"}]}},"response":[]},{"name":"update accreditation","id":"0ee731ec-7ae1-4add-9876-026cc8e15485","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/assignment/update/:{id}","host":["localhost"],"port":"3000","path":["assignment","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Assignment ID"}]}},"response":[]}],"id":"48a5002e-77cd-4c3b-ae43-e807084c0a24"},{"name":"Attendance Copy","item":[{"name":"list accreditations","id":"275f4928-c63e-4bdb-ab29-af7660ad564e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/attendance/list","host":["localhost"],"port":"3000","path":["attendance","list"]}},"response":[]},{"name":"add accreditation","id":"13705294-2dde-4430-ad8a-92f1ae0a64d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/attendance/add","host":["localhost"],"port":"3000","path":["attendance","add"]}},"response":[]},{"name":"delete accreditation","id":"70478a9b-908c-4c1f-9eaa-463cce386f7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/attendance/delete/:{id}","host":["localhost"],"port":"3000","path":["attendance","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Attendance ID"}]}},"response":[]},{"name":"update accreditation","id":"dc68f7fe-cb3f-43d9-a2de-e12e0da45a85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/assignment/update/:{id}","host":["localhost"],"port":"3000","path":["assignment","update",":{id}"],"variable":[{"key":"{id}","value":"","description":"Attendance ID"}]}},"response":[]}],"id":"ad0623e5-34cd-4e6b-90eb-d423d8fc16d0"},{"name":"Auth","item":[{"name":"login","id":"d94e9300-7a0c-4d55-847e-f2a5dae38622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/auth","host":["localhost"],"port":"3000","path":["auth"]}},"response":[]},{"name":"validate user","id":"5c761975-7e33-4329-a242-04f769a32dca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/auth/validateUser","host":["localhost"],"port":"3000","path":["auth","validateUser"]}},"response":[]},{"name":"send otp","id":"916fe952-d7ab-43d3-b98f-d136f9acf243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/auth/sendOTP","host":["localhost"],"port":"3000","path":["auth","sendOTP"]}},"response":[]},{"name":"reset password","id":"213157be-abd2-423b-8b76-425ca41c0d39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/auth/resetPassword","host":["localhost"],"port":"3000","path":["auth","resetPassword"]}},"response":[]}],"id":"3e2294d8-3eb5-46bc-b94b-ce3cef87c77b"}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"info":{"_postman_id":"4bdf746b-9314-4917-abb1-24695fc3995b","name":"Accreditation","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"item":[{"name":"list accreditations","id":"9d40bbed-ecee-4eab-821f-5799f7bbd16d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"localhost:3000/accreditation/list","host":["localhost"],"port":"3000","path":["accreditation","list"]}},"response":[]},{"name":"add accreditation","id":"41cb2d4d-313f-455c-9240-b8c0ee4ec43d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/accreditation/add","host":["localhost"],"port":"3000","path":["accreditation","add"]}},"response":[]},{"name":"delete accreditation","id":"3dcf3c29-26f8-4042-8831-54f15c22b2a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":{"raw":"localhost:3000/accreditation/delete/:{id}","host":["localhost"],"port":"3000","path":["accreditation","delete",":{id}"],"variable":[{"key":"{id}","value":"","description":"Accreditation Id"}]}},"response":[]},{"name":"update accreditation","id":"6e30a369-5484-4cf7-8b40-80521d25d5d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":{"raw":"localhost:3000/accreditation/update/:{id}","host":["localhost"],"port":"3000","path":["accreditation","update",":{id}"],"variable":[{"id":"1763632d-675c-4fdc-bd9e-e4215371882b","key":"{id}","value":"","description":"Accreditation Id"}]}},"response":[]}]}
Loading

0 comments on commit c3b3895

Please sign in to comment.