{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d1c21c08-19c3-4233-a3fc-4c5c1b9e6e6d","name":"CIFPEC","description":"### **Introduction to CIFPEC API**\n\nWelcome to the CIFPEC API documentation!  \nThis API provides a robust and scalable solution to manage the Creative Innovation Final Project Exhibition and Competition (CIFPEC) platform. The API allows seamless interaction with various modules, ensuring an efficient and user-friendly experience for all stakeholders involved in the project.\n\n---\n\n### **Purpose**\n\nThe CIFPEC API is designed to facilitate the management and submission of student projects for the competition. It serves as the backbone of the CIFPEC portal, offering functionalities for different user roles, including administrators, coordinators, supervisors, web maintenance, and students.\n\n---\n\n### **Key Features**\n\n1. **Authentication & Authorization:**\n    \n    - Secure login and registration for all users.\n        \n    - Role-based access control for admins, coordinators, supervisors, and students.\n        \n2. **Batch Management:**\n    \n    - Create, update, and manage competition batches with dynamic field requirements.\n        \n3. **Project Management:**\n    \n    - Submit, update, and view student projects.\n        \n    - Archive finalized projects for better performance and long-term storage.\n        \n4. **User Management:**\n    \n    - Manage user roles, profiles, and access permissions.\n        \n    - Retrieve user-specific data such as students, supervisors, or courses.\n        \n5. **Site Maintenance:**\n    \n    - Update portal settings like logo, banner, and description to reflect organizational branding.\n        \n\n---\n\n### **How to Use This API**\n\n1. **Authentication:**\n    \n    - Begin by registering and logging in to receive an access token.\n        \n    - Use the token to authenticate subsequent requests.\n        \n2. **Batch and Project Management:**\n    \n    - Admins can set up new batches, define fields, and monitor projects.\n        \n    - Student will submit projects tied to specific batches based on the requirements set by the admin.\n        \n3. **Role-Specific Actions:**\n    \n    - Coordinators and supervisors can monitor and manage projects under their purview.\n        \n    - Web maintenance teams can manage portal appearance and settings.\n        \n4. **Archiving Projects**:\n    \n    1. Projects that are marked as **final** will be moved to the **archive**, and they **cannot be modified** afterward. This ensures improved system performance and prevents inactive data from affecting system operations.\n        \n5. **Error Handling:**\n    \n    - The API returns meaningful error codes (e.g., 401 for unauthorized access, 403 for forbidden actions) to guide users in resolving issues.\n        \n\n---\n\n### **Base URL**\n\n- All API requests must be prefixed with the following base URL:  \n    **`https://example.com/api/v1/`**\n    \n\n---\n\n### **Getting Started**\n\n- Explore the endpoints in the following sections to learn more about the API functionalities.\n    \n- For questions or support, refer to the contact information provided by the CIFPEC team.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18545142","collectionId":"d1c21c08-19c3-4233-a3fc-4c5c1b9e6e6d","publishedId":"2sAYQUpuAt","public":true,"publicUrl":"https://documenter-api.postman.tech/view/18545142/2sAYQUpuAt","privateUrl":"https://go.postman.co/documentation/18545142-d1c21c08-19c3-4233-a3fc-4c5c1b9e6e6d","customColor":{"top-bar":"FFFFFF","right-sidebar":"031b22","highlight":"2a89a1"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/732ff246-fddf-44fc-be98-b9e4391a8aff/Q0lGUEVELnBuZw==","colors":{"top-bar":"031b22","right-sidebar":"303030","highlight":"2a89a1"}},{"name":"light","logo":"https://content.pstmn.io/732ff246-fddf-44fc-be98-b9e4391a8aff/Q0lGUEVELnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"031b22","highlight":"2a89a1"}}]}},"version":"8.10.1","publishDate":"2025-01-12T08:00:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/732ff246-fddf-44fc-be98-b9e4391a8aff/Q0lGUEVELnBuZw==","logoDark":"https://content.pstmn.io/732ff246-fddf-44fc-be98-b9e4391a8aff/Q0lGUEVELnBuZw=="}},"statusCode":200},"environments":[{"name":"Example","id":"a499dd15-fa01-46a6-a824-6b5229a6bf1e","owner":"18545142","values":[{"key":"site_url","value":"http://example.com/api/v1","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Example","value":"18545142-a499dd15-fa01-46a6-a824-6b5229a6bf1e"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sAYQUpuAt"}