{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/henddu.com" } ], "info": { "name": "Henddu Monitoring and Analysis API Documentation", "_postman_id": "14df89a8-cb47-45c2-b2d4-47573f6ebb58", "description": "Welcome to the Henddu Air Quality Monitoring and Analysis API. This API provides real-time and historical data about air quality across multiple locations. You can access pollutant levels, meteorological data, sensor information, and much more. It is designed to offer comprehensive monitoring solutions for air quality analysis in diverse regions.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json", "version": "1.0.0" }, "item": [ { "name": "AQI Calculations", "description": "\nManage AQI (Air Quality Index) data, including retrieval by station, city, country, and more.", "item": [ { "name": "Calculate AQI", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/calculate-aqi", "query": [], "raw": "{{baseUrl}}\/api\/aqi\/calculate-aqi" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant\":\"PM10\",\"concentration\":135}" }, "description": "Calculate the AQI for a specific pollutant and its concentration.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"pollutant\": \"PM10\",\n \"concentration\": 135,\n \"aqi\": 91,\n \"category\": \"Moderate\",\n \"meaning\": \"Air quality is acceptable; however, there may be a moderate health concern for a small number of people.\",\n \"healthEffectsStatements\": \"Respiratory symptoms in sensitive individuals.\",\n \"cautionaryStatements\": \"People with respiratory disease should limit outdoor exertion.\",\n \"sensitiveGroups\": \"People with respiratory disease are the group most at risk.\"\n}", "name": "" } ] }, { "name": "Calculate NowCast AQI", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/calculate-nowcast-aqi", "query": [], "raw": "{{baseUrl}}\/api\/aqi\/calculate-nowcast-aqi" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant\":\"PM2.5\",\"concentrations\":[64,63,72,77,65,61,70,71,64,57,58,64]}" }, "description": "Calculate the NowCast AQI for a pollutant using a list of hourly concentrations (12 values).", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"pollutant\": \"PM25\",\n \"concentrations\": [64, 63, 72, 77, 65, 61, 70, 71, 64, 57, 58, 64],\n \"aqi\": 57,\n \"category\": \"Good\",\n \"meaning\": \"Air quality is considered satisfactory, and air pollution poses little or no risk.\",\n \"healthEffectsStatements\": \"No health implications.\",\n \"cautionaryStatements\": \"None.\",\n \"sensitiveGroups\": \"None.\"\n}", "name": "" } ] }, { "name": "Get AQI by Station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/stations\/:stationId\/aqi", "query": [ { "key": "start", "value": "2025-01-20T00%3A00%3A00Z", "description": "Optional start of the custom interval (ISO-8601 format).", "disabled": false }, { "key": "end", "value": "2025-01-29T23%3A59%3A59Z", "description": "Optional end of the custom interval (ISO-8601 format).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/aqi\/stations\/:stationId\/aqi?start=2025-01-20T00%3A00%3A00Z&end=2025-01-29T23%3A59%3A59Z", "variable": [ { "id": "stationId", "key": "stationId", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "uuid required The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get AQI by State", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/states\/:stateId\/aqi", "query": [ { "key": "start", "value": "2025-01-20T00%3A00%3A00Z", "description": "Optional start of the custom interval (ISO-8601 format).", "disabled": false }, { "key": "end", "value": "2025-01-29T23%3A59%3A59Z", "description": "Optional end of the custom interval (ISO-8601 format).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/aqi\/states\/:stateId\/aqi?start=2025-01-20T00%3A00%3A00Z&end=2025-01-29T23%3A59%3A59Z", "variable": [ { "id": "stateId", "key": "stateId", "value": "2643", "description": "The ID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get AQI for a specific pollutant at specified stations.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/pollutants\/:pollutantId\/aqi", "query": [ { "key": "start", "value": "2025-01-20T00%3A00%3A00Z", "description": "Optional start of the custom interval (ISO-8601 format).", "disabled": false }, { "key": "end", "value": "2025-01-29T23%3A59%3A59Z", "description": "Optional end of the custom interval (ISO-8601 format).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/aqi\/pollutants\/:pollutantId\/aqi?start=2025-01-20T00%3A00%3A00Z&end=2025-01-29T23%3A59%3A59Z", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"stations\":[\"123e4567-e89b-12d3-a456-426614174001\",\"123e4567-e89b-12d3-a456-426614174001\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Admin Help Center - Articles", "description": "", "item": [ { "name": "List articles.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles", "query": [ { "key": "module", "value": "MONITORING", "description": "Filter by module.", "disabled": false }, { "key": "type", "value": "faq", "description": "Filter by type (faq|troubleshooting|guide).", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status (draft|published|archived).", "disabled": false }, { "key": "category", "value": "alerts", "description": "Filter by category.", "disabled": false }, { "key": "search", "value": "threshold", "description": "Search in question\/answer EN\/FR.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles?module=MONITORING&type=faq&status=published&category=alerts&search=threshold&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create article.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"b\",\"type\":\"troubleshooting\",\"module\":\"MANAGER\",\"category\":\"n\",\"question_en\":\"architecto\",\"question_fr\":\"architecto\",\"answer_en\":\"architecto\",\"answer_fr\":\"architecto\",\"tags_en\":[\"n\"],\"tags_fr\":[\"g\"],\"status\":\"draft\",\"display_order\":12,\"is_featured\":true}" }, "description": "" }, "response": [] }, { "name": "Show article.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the article." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update article.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the article." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"slug\":\"b\",\"type\":\"troubleshooting\",\"module\":\"MONITORING\",\"category\":\"n\",\"question_en\":\"architecto\",\"question_fr\":\"architecto\",\"answer_en\":\"architecto\",\"answer_fr\":\"architecto\",\"tags_en\":[\"n\"],\"tags_fr\":[\"g\"],\"status\":\"published\",\"display_order\":12,\"is_featured\":false}" }, "description": "" }, "response": [] }, { "name": "Delete article.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the article." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Reorder articles.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"display_order\":84}]}" }, "description": "" }, "response": [] }, { "name": "Publish article.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles\/:id\/publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles\/:id\/publish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the article." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Unpublish article.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/articles\/:id\/unpublish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/articles\/:id\/unpublish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the article." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Admin Help Center - Feedback", "description": "", "item": [ { "name": "List feedback entries.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/feedback", "query": [ { "key": "module", "value": "MONITORING", "description": "Filter by module.", "disabled": false }, { "key": "is_helpful", "value": "", "description": "Filter by helpful flag.", "disabled": true }, { "key": "section", "value": "faq", "description": "Filter by section.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/help-center\/feedback?module=MONITORING&is_helpful=§ion=faq&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show feedback entry.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/feedback\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/feedback\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the feedback." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Admin Help Center - Glossary", "description": "", "item": [ { "name": "List glossary terms.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary", "query": [ { "key": "module", "value": "ALL", "description": "Filter by module.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status.", "disabled": false }, { "key": "search", "value": "AQI", "description": "Search in term\/definition EN\/FR.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary?module=ALL&status=published&search=AQI&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create glossary term.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"MANAGER\",\"category\":\"b\",\"term_en\":\"n\",\"term_fr\":\"g\",\"definition_en\":\"architecto\",\"definition_fr\":\"architecto\",\"aliases_en\":[\"n\"],\"aliases_fr\":[\"g\"],\"status\":\"archived\",\"display_order\":12}" }, "description": "" }, "response": [] }, { "name": "Show glossary term.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the glossary." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update glossary term.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the glossary." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"INDUSTRIAL\",\"category\":\"b\",\"term_en\":\"n\",\"term_fr\":\"g\",\"definition_en\":\"architecto\",\"definition_fr\":\"architecto\",\"aliases_en\":[\"n\"],\"aliases_fr\":[\"g\"],\"status\":\"published\",\"display_order\":12}" }, "description": "" }, "response": [] }, { "name": "Delete glossary term.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the glossary." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Reorder glossary terms.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"display_order\":84}]}" }, "description": "" }, "response": [] }, { "name": "Publish glossary term.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary\/:id\/publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary\/:id\/publish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the glossary." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Unpublish glossary term.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/glossary\/:id\/unpublish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/glossary\/:id\/unpublish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the glossary." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Admin Help Center - Quick Actions", "description": "", "item": [ { "name": "List quick actions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions", "query": [ { "key": "module", "value": "MANAGER", "description": "Filter by module.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status.", "disabled": false }, { "key": "search", "value": "export", "description": "Search title\/description EN\/FR.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions?module=MANAGER&status=published&search=export&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create quick action.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"MONITORING\",\"slug\":\"b\",\"title_en\":\"n\",\"title_fr\":\"g\",\"description_en\":\"architecto\",\"description_fr\":\"architecto\",\"route\":\"n\",\"icon\":\"g\",\"required_permission\":\"z\",\"status\":\"archived\",\"display_order\":77}" }, "description": "" }, "response": [] }, { "name": "Show quick action.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the quick action." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update quick action.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the quick action." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"MANAGER\",\"slug\":\"b\",\"title_en\":\"n\",\"title_fr\":\"g\",\"description_en\":\"architecto\",\"description_fr\":\"architecto\",\"route\":\"n\",\"icon\":\"g\",\"required_permission\":\"z\",\"status\":\"draft\",\"display_order\":77}" }, "description": "" }, "response": [] }, { "name": "Delete quick action.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the quick action." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Reorder quick actions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"display_order\":84}]}" }, "description": "" }, "response": [] }, { "name": "Publish quick action.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions\/:id\/publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions\/:id\/publish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the quick action." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Unpublish quick action.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/quick-actions\/:id\/unpublish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/quick-actions\/:id\/unpublish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the quick action." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Admin Help Center - Support Channels", "description": "", "item": [ { "name": "List support channels.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels", "query": [ { "key": "module", "value": "ALL", "description": "Filter by module.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels?module=ALL&status=published" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create support channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"MONITORING\",\"email\":\"gbailey@example.net\",\"phone\":\"m\",\"chat_url\":\"https:\\\/\\\/www.gulgowski.com\\\/nihil-accusantium-harum-mollitia-modi-deserunt\",\"hours_en\":\"architecto\",\"hours_fr\":\"architecto\",\"status\":\"archived\",\"display_order\":39}" }, "description": "" }, "response": [] }, { "name": "Show support channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the support channel." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update support channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the support channel." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"MONITORING\",\"email\":\"gbailey@example.net\",\"phone\":\"m\",\"chat_url\":\"https:\\\/\\\/www.gulgowski.com\\\/nihil-accusantium-harum-mollitia-modi-deserunt\",\"hours_en\":\"architecto\",\"hours_fr\":\"architecto\",\"status\":\"draft\",\"display_order\":39}" }, "description": "" }, "response": [] }, { "name": "Delete support channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the support channel." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Reorder support channels.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"display_order\":84}]}" }, "description": "" }, "response": [] }, { "name": "Publish support channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels\/:id\/publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels\/:id\/publish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the support channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Unpublish support channel.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/support-channels\/:id\/unpublish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/support-channels\/:id\/unpublish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the support channel." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Admin Help Center - Tasks", "description": "", "item": [ { "name": "List tasks.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks", "query": [ { "key": "module", "value": "MONITORING", "description": "Filter by module.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status.", "disabled": false }, { "key": "search", "value": "export", "description": "Search label EN\/FR.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks?module=MONITORING&status=published&search=export&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"INDUSTRIAL\",\"slug\":\"b\",\"label_en\":\"n\",\"label_fr\":\"g\",\"route\":\"z\",\"icon\":\"m\",\"required_permission\":\"i\",\"status\":\"draft\",\"display_order\":76}" }, "description": "" }, "response": [] }, { "name": "Show task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the task." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the task." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"INDUSTRIAL\",\"slug\":\"b\",\"label_en\":\"n\",\"label_fr\":\"g\",\"route\":\"z\",\"icon\":\"m\",\"required_permission\":\"i\",\"status\":\"archived\",\"display_order\":76}" }, "description": "" }, "response": [] }, { "name": "Delete task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the task." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Reorder tasks.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"display_order\":84}]}" }, "description": "" }, "response": [] }, { "name": "Publish task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks\/:id\/publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks\/:id\/publish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the task." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Unpublish task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tasks\/:id\/unpublish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tasks\/:id\/unpublish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the task." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Admin Help Center - Tutorials", "description": "", "item": [ { "name": "List tutorials.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials", "query": [ { "key": "module", "value": "INDUSTRIAL", "description": "Filter by module.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status.", "disabled": false }, { "key": "search", "value": "onboarding", "description": "Search title\/summary EN\/FR.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials?module=INDUSTRIAL&status=published&search=onboarding&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create tutorial.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"INDUSTRIAL\",\"slug\":\"b\",\"title_en\":\"n\",\"title_fr\":\"g\",\"summary_en\":\"architecto\",\"summary_fr\":\"architecto\",\"duration_minutes\":22,\"video_url\":\"http:\\\/\\\/crooks.biz\\\/et-fugiat-sunt-nihil-accusantium\",\"status\":\"draft\",\"display_order\":52,\"steps\":[{\"step_number\":35,\"title_en\":\"k\",\"title_fr\":\"h\",\"body_en\":\"architecto\",\"body_fr\":\"architecto\",\"media_url\":\"http:\\\/\\\/bailey.com\\\/\"}]}" }, "description": "" }, "response": [] }, { "name": "Show tutorial.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tutorial." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update tutorial.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tutorial." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"MONITORING\",\"slug\":\"b\",\"title_en\":\"n\",\"title_fr\":\"g\",\"summary_en\":\"architecto\",\"summary_fr\":\"architecto\",\"duration_minutes\":22,\"video_url\":\"http:\\\/\\\/crooks.biz\\\/et-fugiat-sunt-nihil-accusantium\",\"status\":\"archived\",\"display_order\":52,\"steps\":[{\"step_number\":35,\"title_en\":\"k\",\"title_fr\":\"h\",\"body_en\":\"architecto\",\"body_fr\":\"architecto\",\"media_url\":\"http:\\\/\\\/bailey.com\\\/\"}]}" }, "description": "" }, "response": [] }, { "name": "Delete tutorial.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tutorial." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Reorder tutorials.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials\/reorder", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials\/reorder" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"items\":[{\"id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\",\"display_order\":84}]}" }, "description": "" }, "response": [] }, { "name": "Publish tutorial.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials\/:id\/publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials\/:id\/publish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tutorial." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Unpublish tutorial.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/help-center\/tutorials\/:id\/unpublish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/help-center\/tutorials\/:id\/unpublish", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tutorial." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Air Quality Endpoints", "description": "", "item": [ { "name": "GET api\/health", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/health", "query": [], "raw": "{{baseUrl}}\/api\/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"status\":\"ok\"}", "name": "" } ] }, { "name": "GET api\/testing\/providers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/testing\/providers", "query": [], "raw": "{{baseUrl}}\/api\/testing\/providers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"supported_providers\":[\"iqair\",\"clarity\",\"claircloud\",\"henddu\",\"zwinsoft\",\"data354\"],\"provider_statistics\":{\"total_registered\":6,\"total_instantiated\":5,\"total_active\":5,\"providers\":{\"iqair\":{\"active\":true,\"configuration\":{\"name\":\"IQAir\",\"active\":true,\"base_url\":\"https:\\\/\\\/device.iqair.com\\\/v2\",\"rate_limit\":{\"requests\":10000,\"per\":\"month\"},\"timeout\":30,\"has_api_key\":false},\"supported_pollutants\":[\"PM2.5\",\"PM10\",\"PM1\",\"CO2\",\"CO\",\"O3\",\"NO2\",\"Temperature\",\"Humidity\",\"Pressure\"],\"metadata\":{\"name\":\"IQAir\",\"active\":true,\"base_url\":\"https:\\\/\\\/device.iqair.com\\\/v2\",\"supported_pollutants\":[\"PM2.5\",\"PM10\",\"PM1\",\"CO2\",\"CO\",\"O3\",\"NO2\",\"Temperature\",\"Humidity\",\"Pressure\"],\"rate_limit\":{\"requests\":10000,\"per\":\"month\"},\"timeout\":30,\"capabilities\":{\"real_time_data\":true,\"historical_data\":true,\"device_metadata\":true,\"bulk_operations\":true,\"location_data\":true,\"air_quality_index\":true,\"forecasting\":true}}},\"clarity\":{\"active\":true,\"configuration\":{\"name\":\"Clarity\",\"active\":true,\"base_url\":\"https:\\\/\\\/clarity-data-api.clarity.io\\\/v2\",\"rate_limit\":{\"requests\":\"1000\",\"per\":\"hour\"},\"timeout\":\"30\",\"has_api_key\":true},\"supported_pollutants\":[\"PM2.5\",\"PM10\",\"PM1\",\"NO2\",\"Temperature\",\"Humidity\",\"Pressure\",\"Wind Speed\",\"Wind Direction\"],\"metadata\":{\"name\":\"Clarity\",\"active\":true,\"base_url\":\"https:\\\/\\\/clarity-data-api.clarity.io\\\/v2\",\"supported_pollutants\":[\"PM2.5\",\"PM10\",\"PM1\",\"NO2\",\"Temperature\",\"Humidity\",\"Pressure\",\"Wind Speed\",\"Wind Direction\"],\"rate_limit\":{\"requests\":\"1000\",\"per\":\"hour\"},\"timeout\":\"30\",\"capabilities\":{\"real_time_data\":true,\"historical_data\":false,\"device_metadata\":true,\"bulk_operations\":false}}},\"zwinsoft\":{\"active\":true,\"configuration\":{\"provider_name\":\"zwinsoft\",\"display_name\":\"Henddu (Zwinsoft)\",\"active\":true,\"api_base_url\":\"http:\\\/\\\/47.236.90.227:57200\",\"api_key_configured\":true,\"api_secret_configured\":true,\"timeout\":30,\"retry_attempts\":3,\"refresh_interval\":3600,\"supported_features\":{\"real_time_data\":true,\"hourly_data\":true,\"daily_data\":true,\"minute_data\":true,\"weather_data\":true,\"device_management\":false},\"data_types\":{\"realtime\":2011,\"minute\":2051,\"hourly\":2061,\"daily\":2031},\"requirements\":{\"api_key\":\"required\",\"api_secret\":\"required\",\"api_base_url\":\"required\",\"device_sn\":\"required per station configuration\"},\"status\":\"configured\"},\"supported_pollutants\":[\"PM2.5\",\"PM10\",\"TSP\",\"SO2\",\"NO2\",\"NOx\",\"NO\",\"CO\",\"O3\"],\"metadata\":{\"name\":\"zwinsoft\",\"display_name\":\"Henddu (Zwinsoft)\",\"description\":\"Henddu environmental monitoring stations (Zwinsoft HJ212 protocol)\",\"protocol\":\"HJ212\",\"supports_aqi\":true,\"supports_weather\":true,\"pollutants\":[\"PM2.5\",\"PM10\",\"TSP\",\"SO2\",\"NO2\",\"NOx\",\"NO\",\"CO\",\"O3\"],\"weather_params\":[\"temperature\",\"humidity\",\"pressure\",\"wind_speed\",\"wind_direction\",\"precipitation\",\"precipitation\",\"solar_radiation\",\"noise\"],\"update_frequency\":\"realtime\",\"refresh_interval\":3600,\"concentration_unit\":\"\\u03bcg\\\/m\\u00b3\",\"data_types\":{\"realtime\":\"Real-time data (tp=2011) - DEFAULT\",\"minute\":\"Minute-aggregated data (tp=2051)\",\"hourly\":\"Hourly-aggregated data (tp=2061)\",\"daily\":\"Daily-aggregated data (tp=2031)\"},\"pressure_conversion\":\"kPa \\u2192 hPa (multiply by 10)\"}},\"claircloud\":{\"active\":true,\"configuration\":{\"name\":\"ClairCloud\",\"active\":true,\"base_url\":\"https:\\\/\\\/rest-caircloud.envea.cloud\",\"rate_limit\":{\"requests\":\"60\",\"per\":\"minute\"},\"timeout\":30,\"has_api_key\":false},\"supported_pollutants\":[\"PM1\",\"PM2.5\",\"PM10\",\"NO2\",\"O3\",\"SO2\",\"CO\",\"Temperature\",\"Humidity\",\"Pressure\"],\"metadata\":{\"name\":\"ClairCloud\",\"active\":true,\"base_url\":\"https:\\\/\\\/rest-caircloud.envea.cloud\",\"supported_pollutants\":[\"PM1\",\"PM2.5\",\"PM10\",\"NO2\",\"O3\",\"SO2\",\"CO\",\"Temperature\",\"Humidity\",\"Pressure\"],\"rate_limit\":{\"requests\":\"60\",\"per\":\"minute\"},\"timeout\":30,\"capabilities\":{\"real_time_data\":true,\"historical_data\":false,\"device_metadata\":true,\"bulk_operations\":false}}},\"data354\":{\"active\":true,\"configuration\":{\"name\":\"Data354\",\"active\":true,\"base_url\":\"https:\\\/\\\/aq54api-721433604320.europe-west1.run.app\",\"rate_limit\":{\"requests\":\"5000\",\"per\":\"hour\"},\"timeout\":\"30\",\"has_api_key\":false},\"supported_pollutants\":[\"PM2.5\",\"PM10\",\"CO\",\"NO2\",\"O3\"],\"metadata\":{\"name\":\"Data354\",\"active\":true,\"base_url\":\"https:\\\/\\\/aq54api-721433604320.europe-west1.run.app\",\"supported_pollutants\":[\"PM2.5\",\"PM10\",\"CO\",\"NO2\",\"O3\"],\"rate_limit\":{\"requests\":\"5000\",\"per\":\"hour\"},\"timeout\":\"30\",\"capabilities\":{\"real_time_data\":true,\"historical_data\":false,\"device_metadata\":true,\"bulk_operations\":false}}}}},\"provider_health\":{\"timestamp\":\"2026-06-20T08:19:44.877732Z\",\"overall_status\":\"healthy\",\"providers\":{\"iqair\":{\"status\":\"healthy\",\"active\":true,\"connection_test\":{\"success\":true,\"provider\":\"IQAir\",\"status\":\"connected\",\"message\":\"Device is online with recent data\",\"device_id\":\"679a3d63530bd615ded60e58\",\"device_name\":\"AirVisual Outdoor - NPCW\",\"last_data_timestamp\":\"2026-06-20T08:18:50.000Z\",\"data_age_hours\":-0.01558860361111111,\"has_recent_data\":true,\"data_points\":12,\"test_timestamp\":\"2026-06-20T08:19:46.119033Z\"},\"last_check\":\"2026-06-20T08:19:46.119110Z\"},\"clarity\":{\"status\":\"healthy\",\"active\":true,\"connection_test\":{\"success\":true,\"provider\":\"Clarity\",\"status\":\"connected\",\"message\":\"Successfully connected to Clarity API\",\"data\":{\"organization\":\"ciapolXVYA\",\"datasource_count\":10}},\"last_check\":\"2026-06-20T08:19:46.526038Z\"},\"zwinsoft\":{\"status\":\"healthy\",\"active\":true,\"connection_test\":{\"success\":true,\"message\":\"Zwinsoft API credentials configured - provide device_sn to test connectivity\",\"timestamp\":\"2026-06-20T08:19:46+00:00\",\"response_time\":0,\"details\":{\"provider\":\"zwinsoft\",\"display_name\":\"Henddu (Zwinsoft)\",\"status\":\"configured\",\"config_info\":{\"base_url\":\"http:\\\/\\\/47.236.90.227:57200\",\"app_key_configured\":true,\"app_secret_configured\":true,\"timeout\":30,\"retry_attempts\":3,\"is_configured\":true},\"requires\":\"device_sn parameter to test actual connectivity\"}},\"last_check\":\"2026-06-20T08:19:46.526132Z\"},\"claircloud\":{\"status\":\"healthy\",\"active\":true,\"connection_test\":{\"success\":true,\"provider\":\"ClairCloud\",\"status\":\"connected\",\"message\":\"Successfully connected to ClairCloud API\",\"data\":{\"sites_count\":4,\"authenticated\":true}},\"last_check\":\"2026-06-20T08:19:46.650799Z\"},\"data354\":{\"status\":\"healthy\",\"active\":true,\"connection_test\":{\"success\":true,\"provider\":\"Data354\",\"status\":\"connected\",\"message\":\"Connection successful\",\"total_stations\":16,\"deployed_stations\":16},\"last_check\":\"2026-06-20T08:19:48.168507Z\"}},\"healthy_count\":5,\"unhealthy_count\":0,\"total_count\":5}}}", "name": "" } ] }, { "name": "GET api\/testing\/providers\/test-connections", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/testing\/providers\/test-connections", "query": [], "raw": "{{baseUrl}}\/api\/testing\/providers\/test-connections" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"timestamp\":\"2026-06-20T08:19:50.695895Z\",\"providers\":{\"iqair\":{\"success\":true,\"provider\":\"IQAir\",\"status\":\"connected\",\"message\":\"Device is online with recent data\",\"device_id\":\"679a3d63530bd615ded60e58\",\"device_name\":\"AirVisual Outdoor - NPCW\",\"last_data_timestamp\":\"2026-06-20T08:18:50.000Z\",\"data_age_hours\":-0.016474425555555554,\"has_recent_data\":true,\"data_points\":12,\"test_timestamp\":\"2026-06-20T08:19:49.307983Z\"},\"clarity\":{\"success\":true,\"provider\":\"Clarity\",\"status\":\"connected\",\"message\":\"Successfully connected to Clarity API\",\"data\":{\"organization\":\"ciapolXVYA\",\"datasource_count\":10}},\"zwinsoft\":{\"success\":true,\"message\":\"Zwinsoft API credentials configured - provide device_sn to test connectivity\",\"timestamp\":\"2026-06-20T08:19:49+00:00\",\"response_time\":0,\"details\":{\"provider\":\"zwinsoft\",\"display_name\":\"Henddu (Zwinsoft)\",\"status\":\"configured\",\"config_info\":{\"base_url\":\"http:\\\/\\\/47.236.90.227:57200\",\"app_key_configured\":true,\"app_secret_configured\":true,\"timeout\":30,\"retry_attempts\":3,\"is_configured\":true},\"requires\":\"device_sn parameter to test actual connectivity\"}},\"claircloud\":{\"success\":true,\"provider\":\"ClairCloud\",\"status\":\"connected\",\"message\":\"Successfully connected to ClairCloud API\",\"data\":{\"sites_count\":4,\"authenticated\":true}},\"data354\":{\"success\":true,\"provider\":\"Data354\",\"status\":\"connected\",\"message\":\"Connection successful\",\"total_stations\":16,\"deployed_stations\":16}},\"total_tested\":5,\"successful\":5}}", "name": "" } ] }, { "name": "GET api\/testing\/providers\/{providerName}\/test", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/testing\/providers\/:providerName\/test", "query": [], "raw": "{{baseUrl}}\/api\/testing\/providers\/:providerName\/test", "variable": [ { "id": "providerName", "key": "providerName", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 404, "body": "{\"status\":\"error\",\"message\":\"Provider architecto not found\"}", "name": "" } ] }, { "name": "POST api\/testing\/providers\/{providerName}\/fetch-data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/testing\/providers\/:providerName\/fetch-data", "query": [], "raw": "{{baseUrl}}\/api\/testing\/providers\/:providerName\/fetch-data", "variable": [ { "id": "providerName", "key": "providerName", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/testing\/sync\/status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/testing\/sync\/status", "query": [], "raw": "{{baseUrl}}\/api\/testing\/sync\/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"status\":\"success\",\"data\":[]}", "name": "" } ] }, { "name": "GET api\/testing\/config", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/testing\/config", "query": [], "raw": "{{baseUrl}}\/api\/testing\/config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"status\":\"success\",\"data\":{\"environment\":\"production\",\"debug\":false,\"iqair_configured\":false,\"clarity_configured\":false,\"henddu_provider_configured\":false,\"database_connection\":\"mysql\",\"queue_connection\":\"redis\"}}", "name": "" } ] }, { "name": "GET api\/help-center\/tasks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/tasks", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/tasks" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true,\"code\":0,\"locale\":\"en\",\"message\":\"The operation succeeded.\",\"data\":{\"items\":[]}}", "name": "" } ] }, { "name": "GET api\/help-center\/quick-actions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/quick-actions", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/quick-actions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true,\"code\":0,\"locale\":\"en\",\"message\":\"The operation succeeded.\",\"data\":{\"items\":[]}}", "name": "" } ] }, { "name": "GET api\/help-center\/tutorials", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/tutorials", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/tutorials" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true,\"code\":0,\"locale\":\"en\",\"message\":\"The operation succeeded.\",\"data\":{\"items\":[]}}", "name": "" } ] }, { "name": "GET api\/help-center\/tutorials\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/tutorials\/:id", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/tutorials\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tutorial." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 404, "body": "{\"status\":\"error\",\"message\":\"No query results for model [App\\\\Models\\\\HelpTutorial] architecto\"}", "name": "" } ] }, { "name": "GET api\/help-center\/articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/articles", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/articles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true,\"code\":0,\"locale\":\"en\",\"message\":\"The operation succeeded.\",\"data\":{\"current_page\":1,\"data\":[],\"first_page_url\":\"https:\\\/\\\/henddu.com\\\/api\\\/help-center\\\/articles?page=1\",\"from\":null,\"last_page\":1,\"last_page_url\":\"https:\\\/\\\/henddu.com\\\/api\\\/help-center\\\/articles?page=1\",\"links\":[{\"url\":null,\"label\":\"\\u0026laquo; Previous\",\"active\":false},{\"url\":\"https:\\\/\\\/henddu.com\\\/api\\\/help-center\\\/articles?page=1\",\"label\":\"1\",\"active\":true},{\"url\":null,\"label\":\"Next \\u0026raquo;\",\"active\":false}],\"next_page_url\":null,\"path\":\"https:\\\/\\\/henddu.com\\\/api\\\/help-center\\\/articles\",\"per_page\":15,\"prev_page_url\":null,\"to\":null,\"total\":0}}", "name": "" } ] }, { "name": "GET api\/help-center\/glossary", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/glossary", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/glossary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true,\"code\":0,\"locale\":\"en\",\"message\":\"The operation succeeded.\",\"data\":{\"items\":[]}}", "name": "" } ] }, { "name": "GET api\/help-center\/support", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/support", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/support" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true,\"code\":0,\"locale\":\"en\",\"message\":\"The operation succeeded.\",\"data\":{\"items\":[]}}", "name": "" } ] }, { "name": "POST api\/help-center\/feedback", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/help-center\/feedback", "query": [], "raw": "{{baseUrl}}\/api\/help-center\/feedback" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"INDUSTRIAL\",\"section\":\"b\",\"content_id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"is_helpful\":true,\"comment\":\"z\",\"locale\":\"fr\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Test connectivity to the Data354 API.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data354\/connection\/test", "query": [], "raw": "{{baseUrl}}\/api\/data354\/connection\/test" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Return all deployed Data354 stations, each enriched with an\n`already_integrated` boolean indicating whether the current tenant\nhas already registered that station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data354\/stations", "query": [], "raw": "{{baseUrl}}\/api\/data354\/stations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Dispatch an immediate data sync for a registered Data354 integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data354\/integrations\/:integrationId\/sync", "query": [], "raw": "{{baseUrl}}\/api\/data354\/integrations\/:integrationId\/sync", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "List tenants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Two modes:\n - With ?module=monitoring|industrial|... \u2014 used by the tenant picker\n before a tenant is selected. Returns the full unpaginated list of\n tenants subscribed to that module.\n - Without ?module \u2014 admin CRUD list. Supports ?search=&status=&per_page=\n and is paginated." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Validate and confirm the admin's chosen tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/select-tenant", "query": [], "raw": "{{baseUrl}}\/api\/admin\/select-tenant" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tenant_id\":\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"}" }, "description": "" }, "response": [] }, { "name": "Create a new tenant. Optionally attaches an initial set of modules.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"slug\":\"n\",\"logo\":\"g\",\"website\":\"z\",\"organization_type\":\"public_private\",\"description\":\"Velit et fugiat sunt nihil accusantium.\",\"email\":\"lafayette.considine@example.com\",\"phone_number\":\"a\",\"country_id\":16,\"state_id\":16,\"city_id\":16,\"address\":\"n\",\"timezone\":\"Antarctica\\\/Syowa\",\"coordinates\":\"architecto\",\"start_date\":\"2026-06-20T08:19:51\",\"end_date\":\"2052-07-13\",\"budget\":39,\"funding_source\":\"g\",\"tenant_manager\":\"z\",\"manager_email\":\"rempel.chadrick@example.org\",\"manager_phone\":\"l\",\"billing_email\":\"idickens@example.org\",\"default_locale\":\"fr\",\"is_active\":true,\"modules\":[\"industrial\"]}" }, "description": "" }, "response": [] }, { "name": "Show a single tenant with its modules.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "List users belonging to a tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant\/users", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant\/users", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Supports ?search= and pagination via ?per_page=." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update tenant attributes (does NOT touch module subscriptions).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tenant." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"slug\":\"n\",\"logo\":\"g\",\"website\":\"z\",\"organization_type\":\"private\",\"description\":\"Velit et fugiat sunt nihil accusantium.\",\"email\":\"lafayette.considine@example.com\",\"phone_number\":\"a\",\"country_id\":16,\"state_id\":16,\"city_id\":16,\"address\":\"n\",\"timezone\":\"Antarctica\\\/Syowa\",\"coordinates\":\"architecto\",\"start_date\":\"2026-06-20T08:19:51\",\"end_date\":\"2052-07-13\",\"budget\":39,\"funding_source\":\"g\",\"tenant_manager\":\"z\",\"manager_email\":\"rempel.chadrick@example.org\",\"manager_phone\":\"l\",\"billing_email\":\"idickens@example.org\",\"default_locale\":\"en\",\"is_active\":true}" }, "description": "" }, "response": [] }, { "name": "Upload (or replace) a tenant's logo. Stores the file under the\n`public` disk at `logos\/` and updates `tenants.logo` with its URL.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant\/logo", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant\/logo", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "logo", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "Delete a tenant. Module pivots are removed via cascade or here explicitly.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tenant." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Activate a tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant\/activate", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant\/activate", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Deactivate a tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant\/deactivate", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant\/deactivate", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List the module subscriptions for a tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant_id\/modules", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant_id\/modules", "variable": [ { "id": "tenant_id", "key": "tenant_id", "value": "architecto", "description": "The ID of the tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Replace the full set of module subscriptions for a tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant\/modules", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant\/modules", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"modules\":[\"manager\"]}" }, "description": "Body: { \"modules\": [\"monitoring\", \"industrial\", ...] }" }, "response": [] }, { "name": "Attach a single module to a tenant (idempotent).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant\/modules", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant\/modules", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"module\":\"analysis\"}" }, "description": "Body: { \"module\": \"industrial\" }" }, "response": [] }, { "name": "Detach a single module from a tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/tenants\/:tenant\/modules\/:module", "query": [], "raw": "{{baseUrl}}\/api\/admin\/tenants\/:tenant\/modules\/:module", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." }, { "id": "module", "key": "module", "value": "architecto", "description": "The module." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List countries with optional search\/filter and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/countries", "query": [], "raw": "{{baseUrl}}\/api\/admin\/countries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Query params: ?search=&status=active|inactive®ion_id=&per_page=20\nWhen per_page=all is passed, returns the full list (used for pickers)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/countries", "query": [], "raw": "{{baseUrl}}\/api\/admin\/countries" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"iso2\":\"ng\",\"iso3\":\"zmi\",\"numeric_code\":\"yvd\",\"phonecode\":\"l\",\"capital\":\"j\",\"currency\":\"nikhwa\",\"currency_name\":\"y\",\"currency_symbol\":\"k\",\"tld\":\"c\",\"native\":\"m\",\"region\":\"y\",\"region_id\":16,\"subregion\":\"n\",\"subregion_id\":16,\"nationality\":\"n\",\"latitude\":-90,\"longitude\":-179,\"emoji\":\"m\",\"emojiU\":\"i\",\"status\":false}" }, "description": "" }, "response": [] }, { "name": "Show a single country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/countries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/countries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the country." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/countries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/countries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the country." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"iso2\":\"ng\",\"iso3\":\"zmi\",\"numeric_code\":\"yvd\",\"phonecode\":\"l\",\"capital\":\"j\",\"currency\":\"nikhwa\",\"currency_name\":\"y\",\"currency_symbol\":\"k\",\"tld\":\"c\",\"native\":\"m\",\"region\":\"y\",\"region_id\":16,\"subregion\":\"n\",\"subregion_id\":16,\"nationality\":\"n\",\"latitude\":-90,\"longitude\":-179,\"emoji\":\"m\",\"emojiU\":\"i\",\"status\":false}" }, "description": "" }, "response": [] }, { "name": "Delete a country. Blocked when states\/cities\/tenants reference it.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/countries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/countries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the country." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List states with optional search\/filter and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/states", "query": [], "raw": "{{baseUrl}}\/api\/admin\/states" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Query params: ?search=&country_id=&status=active|inactive&per_page=20\nWhen per_page=all is passed, returns the full filtered list (used for pickers)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new state.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/states", "query": [], "raw": "{{baseUrl}}\/api\/admin\/states" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"country_id\":16,\"country_code\":\"ng\",\"iso2\":\"zmiyvd\",\"fips_code\":\"ljnikh\",\"type\":\"w\",\"level\":16,\"parent_id\":16,\"latitude\":-89,\"longitude\":-180,\"status\":false}" }, "description": "" }, "response": [] }, { "name": "Show a single state.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/states\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/states\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the state." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a state.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/states\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/states\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the state." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"country_id\":16,\"country_code\":\"ng\",\"iso2\":\"zmiyvd\",\"fips_code\":\"ljnikh\",\"type\":\"w\",\"level\":16,\"parent_id\":16,\"latitude\":-89,\"longitude\":-180,\"status\":true}" }, "description": "" }, "response": [] }, { "name": "Delete a state. Blocked when cities\/tenants reference it.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/states\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/states\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the state." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List cities with optional search\/filter and pagination.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/cities", "query": [], "raw": "{{baseUrl}}\/api\/admin\/cities" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Query params: ?search=&state_id=&country_id=&status=active|inactive&per_page=20\nWhen per_page=all is passed, returns the full filtered list (used for pickers)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new city.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/cities", "query": [], "raw": "{{baseUrl}}\/api\/admin\/cities" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"state_id\":16,\"country_id\":16,\"state_code\":\"ngzmiy\",\"country_code\":\"vd\",\"latitude\":-89,\"longitude\":-179,\"status\":false}" }, "description": "" }, "response": [] }, { "name": "Show a single city.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/cities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/cities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the city." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a city.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/cities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/cities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the city." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"state_id\":16,\"country_id\":16,\"state_code\":\"ngzmiy\",\"country_code\":\"vd\",\"latitude\":-89,\"longitude\":-179,\"status\":false}" }, "description": "" }, "response": [] }, { "name": "Delete a city. Blocked when stations\/tenants reference it.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/cities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/cities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the city." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "List all platform users (paginated, filterable).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"b\",\"last_name\":\"n\",\"email\":\"ashly64@example.com\",\"phone\":\"v\",\"job_title\":\"d\",\"company\":\"l\",\"department\":\"j\",\"bio\":\"n\",\"tenant_id\":\"cd1eb1ea-4697-3b9a-9dd0-988044a83af6\",\"roles\":[\"h\"],\"account_status\":\"inactive\",\"language\":\"waykcm\",\"timezone\":\"Pacific\\\/Apia\",\"country\":\"u\",\"state\":\"w\",\"city\":\"p\"}" }, "description": "" }, "response": [] }, { "name": "Get a single user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update an existing user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"b\",\"last_name\":\"n\",\"email\":\"ashly64@example.com\",\"phone\":\"v\",\"job_title\":\"d\",\"company\":\"l\",\"department\":\"j\",\"bio\":\"n\",\"tenant_id\":\"cd1eb1ea-4697-3b9a-9dd0-988044a83af6\",\"roles\":[\"h\"],\"account_status\":\"suspended\",\"language\":\"waykcm\",\"timezone\":\"Pacific\\\/Apia\",\"country\":\"u\",\"state\":\"w\",\"city\":\"p\"}" }, "description": "" }, "response": [] }, { "name": "Delete a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the user." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Activate (enable) a user account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users\/:user\/enable", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users\/:user\/enable", "variable": [ { "id": "user", "key": "user", "value": "architecto", "description": "The user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Suspend (disable) a user account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users\/:user\/disable", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users\/:user\/disable", "variable": [ { "id": "user", "key": "user", "value": "architecto", "description": "The user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Sync roles for a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/users\/:user\/roles", "query": [], "raw": "{{baseUrl}}\/api\/admin\/users\/:user\/roles", "variable": [ { "id": "user", "key": "user", "value": "architecto", "description": "The user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"roles\":[\"b\"]}" }, "description": "" }, "response": [] }, { "name": "Paginated audit log feed. Supports the filters declared in\n`frontend\/docs\/admin-app\/05-backend-contract.md` \u00a7Audit Log.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/audit-log", "query": [], "raw": "{{baseUrl}}\/api\/admin\/audit-log" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Stream the same filtered set as a CSV download.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/audit-log\/export", "query": [], "raw": "{{baseUrl}}\/api\/admin\/audit-log\/export" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "High-level KPIs across the whole platform.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/dashboard\/summary", "query": [], "raw": "{{baseUrl}}\/api\/admin\/dashboard\/summary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Shape:\n{\n tenants: { total, active, inactive, new_this_month },\n users: { total, active, suspended, admins, new_this_month },\n stations: { total, active, inactive, maintenance },\n audit: { today, this_week, this_month, top_actions: [{ action, count }] },\n activity: [ { day, count } x 14 ],\n}", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Most recent platform actions \u2014 same shape as `\/admin\/audit-log` rows\nbut capped at 20 and stripped to the fields the dashboard renders.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/dashboard\/recent-actions", "query": [], "raw": "{{baseUrl}}\/api\/admin\/dashboard\/recent-actions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Paginated list of the current user's exports.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-exports", "query": [], "raw": "{{baseUrl}}\/api\/data-exports" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Series available across the requested set of stations\n(drives the pollutant + weather pickers in the UI).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-exports\/available-series", "query": [], "raw": "{{baseUrl}}\/api\/data-exports\/available-series" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_ids\":[\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Persist a new export request and dispatch the worker job.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-exports", "query": [], "raw": "{{baseUrl}}\/api\/data-exports" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_ids\":[\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"],\"datasets\":[\"aqi\"],\"pollutants\":[\"architecto\"],\"weather_parameters\":[\"precipitation\"],\"layout\":\"wide\",\"granularity\":\"1d\",\"range_start\":\"2022-07-14\",\"range_end\":\"2022-07-14\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Single export \u2014 used for polling status from the UI.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-exports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/data-exports\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the data export." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Stream the file (local disk) or 307 to a signed URL (S3 disk).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-exports\/:id\/download", "query": [], "raw": "{{baseUrl}}\/api\/data-exports\/:id\/download", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the data export." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Clone the parameters of an existing export into a new pending one.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-exports\/:id\/rerun", "query": [], "raw": "{{baseUrl}}\/api\/data-exports\/:id\/rerun", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the data export." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete the row and the artefact on disk.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-exports\/:id", "query": [], "raw": "{{baseUrl}}\/api\/data-exports\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the data export." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/industrial\/timeseries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/industrial\/timeseries", "query": [], "raw": "{{baseUrl}}\/api\/industrial\/timeseries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/industrial\/station-health", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/industrial\/station-health", "query": [], "raw": "{{baseUrl}}\/api\/industrial\/station-health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/industrial\/stations\/{id}\/latest", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/industrial\/stations\/:id\/latest", "query": [], "raw": "{{baseUrl}}\/api\/industrial\/stations\/:id\/latest", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "List hourly AQI records for a station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/stations\/:stationId\/hourly", "query": [], "raw": "{{baseUrl}}\/api\/aqi\/stations\/:stationId\/hourly", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"date\":\"2026-06-20\",\"start_date\":\"2026-06-20\",\"end_date\":\"2052-07-13\"}" }, "description": "Single day: GET \/api\/aqi\/stations\/{stationId}\/hourly?date=YYYY-MM-DD\nDate range: GET \/api\/aqi\/stations\/{stationId}\/hourly?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show a single hourly AQI record.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/stations\/:stationId\/hourly\/:date\/:hour", "query": [], "raw": "{{baseUrl}}\/api\/aqi\/stations\/:stationId\/hourly\/:date\/:hour", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" }, { "id": "date", "key": "date", "value": "architecto", "description": "" }, { "id": "hour", "key": "hour", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "GET \/api\/aqi\/stations\/{stationId}\/hourly\/{date}\/{hour}", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Return the top-N peak hours (hours with highest overall_aqi) for a station\nover a date range.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/stations\/:stationId\/peak-hours", "query": [], "raw": "{{baseUrl}}\/api\/aqi\/stations\/:stationId\/peak-hours", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2026-06-20\",\"end_date\":\"2052-07-13\",\"limit\":22}" }, "description": "GET \/api\/aqi\/stations\/{stationId}\/peak-hours?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&days=10", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Return the diurnal (average-by-hour-of-day) AQI profile for a station\nover a date range \u2014 24 data points, one per hour 0-23.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/aqi\/stations\/:stationId\/diurnal-profile", "query": [], "raw": "{{baseUrl}}\/api\/aqi\/stations\/:stationId\/diurnal-profile", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2026-06-20\",\"end_date\":\"2052-07-13\"}" }, "description": "GET \/api\/aqi\/stations\/{stationId}\/diurnal-profile?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Display a listing of the user's alert rules.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store a newly created alert rule.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"alert_type\":\"architecto\",\"station_ids\":[\"a4855dc5-0acb-33c3-b921-f4291f719ca0\"],\"condition\":\"architecto\",\"pollutant_id\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"aqi_category\":\"z\",\"notify_email\":false,\"notify_push\":false,\"active\":true,\"cooldown_minutes\":17,\"pollutants\":[{\"pollutant_id\":\"a1a0a47d-e8c3-3cf0-8e6e-c1ff9dca5d1f\",\"threshold_value\":60}]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get regulatory (EPA) thresholds for given pollutants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts\/regulatory-thresholds", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts\/regulatory-thresholds" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_ids\":[\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"],\"station_id\":\"6b72fe4a-5b40-307c-bc24-f79acf9a1bb9\"}" }, "description": "Returns the default threshold values from PollutantThreshold records.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get statistics about user's alert rules.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts\/statistics", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts\/statistics" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Display the specified alert rule.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the my alert." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update the specified alert rule.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the my alert." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"station_ids\":[\"a4855dc5-0acb-33c3-b921-f4291f719ca0\"],\"pollutant_id\":\"c90237e9-ced5-3af6-88ea-84aeaa148878\",\"aqi_category\":\"i\",\"notify_email\":true,\"notify_push\":false,\"active\":true,\"cooldown_minutes\":8,\"pollutants\":[{\"pollutant_id\":\"21c4122b-d554-3723-966c-6d723ea5293f\",\"threshold_value\":37}]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove the specified alert rule.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the my alert." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Toggle the active status of an alert rule.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/my-alerts\/:id\/toggle", "query": [], "raw": "{{baseUrl}}\/api\/my-alerts\/:id\/toggle", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the my alert." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET \/api\/admin\/settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/settings", "query": [], "raw": "{{baseUrl}}\/api\/admin\/settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Return all settings grouped. Secret values are masked.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "PUT \/api\/admin\/settings\/{group}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/settings\/:group", "query": [], "raw": "{{baseUrl}}\/api\/admin\/settings\/:group", "variable": [ { "id": "group", "key": "group", "value": "--8", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Update a settings group. Secret fields with value \"\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022\" are skipped.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST \/api\/admin\/settings\/test-email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/settings\/test-email", "query": [], "raw": "{{baseUrl}}\/api\/admin\/settings\/test-email" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"to\":\"gbailey@example.net\"}" }, "description": "Send a test email to verify SMTP configuration.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST \/api\/admin\/settings\/test-storage", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/settings\/test-storage", "query": [], "raw": "{{baseUrl}}\/api\/admin\/settings\/test-storage" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Verify S3 \/ object-storage configuration by performing a lightweight\nput \u2192 exists \u2192 delete round-trip against the configured bucket.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/stations\/documents\/types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/documents\/types", "query": [], "raw": "{{baseUrl}}\/api\/stations\/documents\/types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/stations\/{stationId}\/documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/documents", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/documents", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "POST api\/stations\/{stationId}\/documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/documents", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/documents", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "document_type", "value": "compliance_report", "type": "text", "description": "" }, { "key": "title", "value": "b", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "description", "value": "Et animi quos velit et fugiat.", "type": "text", "description": "Must not be greater than 1000 characters." }, { "key": "file", "src": [], "type": "file" } ] }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/stations\/{stationId}\/documents\/{documentId}\/download", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/documents\/:documentId\/download", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/documents\/:documentId\/download", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" }, { "id": "documentId", "key": "documentId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "DELETE api\/stations\/{stationId}\/documents\/{documentId}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/documents\/:documentId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/documents\/:documentId", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" }, { "id": "documentId", "key": "documentId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET api\/unauthorized", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/unauthorized", "query": [], "raw": "{{baseUrl}}\/api\/unauthorized" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"error\":\"Unauthorized\"}", "name": "" } ] }, { "name": "GET api\/auth\/debug", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/debug", "query": [], "raw": "{{baseUrl}}\/api\/auth\/debug" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/admin\/dashboard", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/dashboard", "query": [], "raw": "{{baseUrl}}\/api\/admin\/dashboard" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/user\/dashboard", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/dashboard", "query": [], "raw": "{{baseUrl}}\/api\/user\/dashboard" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/reports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports", "query": [], "raw": "{{baseUrl}}\/api\/reports" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/forecasts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/forecasts", "query": [], "raw": "{{baseUrl}}\/api\/forecasts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "GET api\/analysis", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/analysis", "query": [], "raw": "{{baseUrl}}\/api\/analysis" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Alerts", "description": "\nAPIs for managing user-specific alerts triggered by custom alert rules.\n\nAlerts are automatically generated when air quality readings match conditions\ndefined in the user's alert rules. Each user only sees their own alerts.", "item": [ { "name": "List My Alerts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/alerts", "query": [ { "key": "pollutant_id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "Filter alerts by pollutant UUID.", "disabled": false }, { "key": "station_id", "value": "0034fd43-245f-4ce2-ac4f-4683a8cf4722", "description": "Filter alerts by station UUID.", "disabled": false }, { "key": "status", "value": "new", "description": "Filter alerts by status. Allowed: new, acknowledged, resolved.", "disabled": false }, { "key": "severity_level", "value": "hazardous", "description": "Filter alerts by severity level. Allowed: good, moderate, unhealthy_sensitive, unhealthy, very_unhealthy, hazardous.", "disabled": false }, { "key": "start_date", "value": "2025-04-01", "description": "date Filter alerts created on or after this date. Format: YYYY-MM-DD.", "disabled": false }, { "key": "end_date", "value": "2025-04-15", "description": "date Filter alerts created on or before this date. Format: YYYY-MM-DD.", "disabled": false }, { "key": "with", "value": "pollutant%2Cstation%2CuserAlertRule", "description": "Comma-separated relationships to include. Allowed: pollutant, station, threshold, creator, acknowledgedByUser, resolvedByUser, user, userAlertRule.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page (max: 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/alerts?pollutant_id=9ca44a28-824b-45f3-a12b-19df647e07bb&station_id=0034fd43-245f-4ce2-ac4f-4683a8cf4722&status=new&severity_level=hazardous&start_date=2025-04-01&end_date=2025-04-15&with=pollutant%2Cstation%2CuserAlertRule&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves all alerts belonging to the authenticated user with optional filtering.\nAlerts are triggered by user-defined alert rules when air quality readings\nmatch specified conditions.\n\nAdministrators can see all alerts; regular users only see their own." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"message\": \"Alerts retrieved successfully.\", \"data\": [], \"meta\": {\"current_page\": 1, \"last_page\": 1, \"per_page\": 15, \"total\": 0}}", "name": "Success" } ] }, { "name": "Create Alert Manually", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/alerts", "query": [], "raw": "{{baseUrl}}\/api\/alerts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_id\":\"9ca44a28-824b-45f3-a12b-19df647e07bb\",\"station_id\":\"0034fd43-245f-4ce2-ac4f-4683a8cf4722\",\"threshold_id\":\"1cd92c58-3c04-4982-b3b1-ade873b8e70a\",\"alert_type\":\"threshold_exceeded\",\"severity_level\":\"hazardous\",\"reading_value\":\"150.75\",\"message\":\"PM2.5 levels have reached hazardous levels\"}" }, "description": "Creates a new alert manually. Note: Alerts are typically created automatically\nby the system when air quality readings match user-defined alert rules.\nThis endpoint is provided for manual alert creation if needed." }, "response": [ { "header": [], "code": 201, "body": "{\"success\": true, \"message\": \"Alert created successfully.\", \"data\": {}}", "name": "Created" }, { "header": [], "code": 422, "body": "{\"message\": \"The given data was invalid.\", \"errors\": {}}", "name": "Validation Error" } ] }, { "name": "Get Alert Statistics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/alerts\/statistics", "query": [ { "key": "start_date", "value": "2025-04-01", "description": "date Filter statistics for alerts created on or after this date. Format: YYYY-MM-DD.", "disabled": false }, { "key": "end_date", "value": "2025-04-15", "description": "date Filter statistics for alerts created on or before this date. Format: YYYY-MM-DD.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/alerts\/statistics?start_date=2025-04-01&end_date=2025-04-15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves aggregated statistics for the authenticated user's alerts.\nReturns counts grouped by status, severity level, and pollutant." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"message\": \"Alert statistics retrieved successfully.\", \"data\": {\"total\": 42, \"by_status\": {\"new\": 10, \"acknowledged\": 20, \"resolved\": 12}, \"by_severity\": {\"moderate\": 15, \"unhealthy\": 20, \"hazardous\": 7}, \"by_pollutant\": [{\"pollutant_id\": \"uuid\", \"name\": \"PM2.5\", \"count\": 25}]}}", "name": "Success" } ] }, { "name": "Get Alert Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/alerts\/:id", "query": [ { "key": "with", "value": "pollutant%2CuserAlertRule", "description": "Comma-separated relationships to include. Allowed: pollutant, station, threshold, creator, acknowledgedByUser, resolvedByUser, user, userAlertRule.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/alerts\/:id?with=pollutant%2CuserAlertRule", "variable": [ { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The UUID of the alert." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a specific alert by its UUID. Regular users can only view alerts\nthat belong to them. Administrators can view any alert." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"message\": \"Alert retrieved successfully.\", \"data\": {}}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Alert].\"}", "name": "Not Found" } ] }, { "name": "Acknowledge Alert", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/alerts\/:id\/acknowledge", "query": [], "raw": "{{baseUrl}}\/api\/alerts\/:id\/acknowledge", "variable": [ { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The UUID of the alert to acknowledge." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Updates the alert status from 'new' to 'acknowledged'. Records the timestamp\nand user who acknowledged the alert. Only 'new' alerts can be acknowledged.\n\nRegular users can only acknowledge their own alerts. Administrators can acknowledge any alert." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"message\": \"Alert acknowledged successfully.\", \"data\": {}}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"success\": false, \"message\": \"Alert has already been acknowledged or resolved.\", \"data\": null}", "name": "Already Processed" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Alert].\"}", "name": "Not Found" } ] }, { "name": "Resolve Alert", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/alerts\/:id\/resolve", "query": [], "raw": "{{baseUrl}}\/api\/alerts\/:id\/resolve", "variable": [ { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The UUID of the alert to resolve." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Updates the alert status to 'resolved'. Records the timestamp and user\nwho resolved the alert. Alerts can be resolved directly from 'new' or\n'acknowledged' status. Already resolved alerts cannot be resolved again.\n\nRegular users can only resolve their own alerts. Administrators can resolve any alert." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"message\": \"Alert resolved successfully.\", \"data\": {}}", "name": "Success" }, { "header": [], "code": 400, "body": "{\"success\": false, \"message\": \"Alert has already been resolved.\", \"data\": null}", "name": "Already Resolved" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Alert].\"}", "name": "Not Found" } ] }, { "name": "Delete Alert", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/alerts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/alerts\/:id", "variable": [ { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The UUID of the alert to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently deletes an alert. Regular users can only delete their own alerts.\nAdministrators can delete any alert." }, "response": [ { "header": [], "code": 200, "body": "{\"success\": true, \"message\": \"Alert deleted successfully.\"}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\": \"No query results for model [App\\\\Models\\\\Alert].\"}", "name": "Not Found" } ] } ] }, { "name": "Authentication", "description": "\nEndpoints for authentication and user session management.", "item": [ { "name": "Get Tenant Info for the authenticated user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/me", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the tenant (organisation) that the current user belongs to.\nUsed by the frontend header to display the tenant name." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update the tenant of the authenticated user (administrator only).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/me", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/me" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"logo\":\"i\",\"phone_number\":\"yvdljnikhwaykcmy\",\"description\":\"Eius et animi quos velit et.\",\"start_date\":\"2026-06-20T08:19:52\",\"end_date\":\"2052-07-13\",\"tenant_manager\":\"n\",\"budget\":84,\"funding_source\":\"z\",\"coordinates\":\"[\\\"architecto\\\",\\\"architecto\\\"]\"}" }, "description": "" }, "response": [] }, { "name": "Upload the logo for the authenticated user's tenant (administrator only).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/me\/logo", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/me\/logo" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "logo", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "Sync User from Keycloak Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/sync", "query": [], "raw": "{{baseUrl}}\/api\/auth\/sync" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Syncs the authenticated user's data from the Keycloak token.\nThe middleware already syncs users on each request, but this provides\nan explicit endpoint for the frontend to call after login to get\nthe complete user profile." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"User synced successfully\",\n \"data\": {\n \"user\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"keycloak_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"email\": \"user@example.com\",\n \"name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"roles\": [\"user\", \"viewer\"],\n \"avatar_url\": null,\n \"timezone\": \"Africa\/Lagos\",\n \"language\": \"en\",\n \"last_login_at\": \"2026-03-12T10:30:00.000000Z\"\n }\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Unauthenticated. Please provide a valid access token.\",\n \"error_code\": \"401\"\n}", "name": "" } ] }, { "name": "Get Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/me", "query": [], "raw": "{{baseUrl}}\/api\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the full profile of the currently authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"user\": {\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"keycloak_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"email\": \"user@example.com\",\n \"name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"roles\": [\"user\", \"viewer\"],\n \"phone\": null,\n \"avatar_url\": null,\n \"bio\": null,\n \"job_title\": null,\n \"company\": null,\n \"department\": null,\n \"country\": \"NG\",\n \"state\": null,\n \"city\": null,\n \"timezone\": \"Africa\/Lagos\",\n \"language\": \"en\",\n \"date_of_birth\": null,\n \"notification_preferences\": null,\n \"dashboard_preferences\": null,\n \"theme_preference\": null,\n \"professional_interests\": null,\n \"expertise_areas\": null,\n \"linkedin_url\": null,\n \"website_url\": null,\n \"profile_completed_at\": null,\n \"last_profile_update\": null,\n \"last_login_at\": \"2026-03-12T10:30:00.000000Z\",\n \"created_at\": \"2026-03-10T08:00:00.000000Z\",\n \"updated_at\": \"2026-03-12T10:30:00.000000Z\"\n }\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Not authenticated\"\n}", "name": "" } ] }, { "name": "Validate Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/validate", "query": [], "raw": "{{baseUrl}}\/api\/auth\/validate" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Validates the Bearer token and returns basic authentication status.\nUseful for checking if the token is still valid without syncing user data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Token is valid\",\n \"data\": {\n \"authenticated\": true,\n \"user_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"keycloak_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"success\": false,\n \"message\": \"Token is invalid or expired\"\n}", "name": "" } ] } ] }, { "name": "Cities", "description": "\nManage cities including their creation, updates, and retrieval.", "item": [ { "name": "Display a list of cities.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities", "query": [], "raw": "{{baseUrl}}\/api\/cities" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show a specific city.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/cities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the city." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store a new city.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities", "query": [], "raw": "{{baseUrl}}\/api\/cities" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"state_id\":\"architecto\",\"state_code\":\"n\",\"country_id\":\"architecto\",\"country_code\":\"ng\",\"latitude\":-89,\"longitude\":-180,\"flag\":false,\"wikiDataId\":\"i\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update a specific city.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/cities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the city." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"state_code\":\"n\",\"country_code\":\"gz\",\"latitude\":-90,\"longitude\":-180,\"flag\":false,\"wikiDataId\":\"y\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a specific city.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/cities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the city." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Retrieve cities by the given country ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/countries\/:country_id", "query": [], "raw": "{{baseUrl}}\/api\/cities\/countries\/:country_id", "variable": [ { "id": "country_id", "key": "country_id", "value": "architecto", "description": "The ID of the country." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve cities by the given state ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/states\/:state_id", "query": [], "raw": "{{baseUrl}}\/api\/cities\/states\/:state_id", "variable": [ { "id": "state_id", "key": "state_id", "value": "architecto", "description": "The ID of the state." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve cities by the given region ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/regions\/:region_id", "query": [], "raw": "{{baseUrl}}\/api\/cities\/regions\/:region_id", "variable": [ { "id": "region_id", "key": "region_id", "value": "architecto", "description": "The ID of the region." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve cities by the given subregion ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/cities\/subregions\/:subregion_id", "query": [], "raw": "{{baseUrl}}\/api\/cities\/subregions\/:subregion_id", "variable": [ { "id": "subregion_id", "key": "subregion_id", "value": "architecto", "description": "The ID of the subregion." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "ClairCloud Integration", "description": "\nAPIs for ClairCloud (ENVEA) CairNet\/CairSens sensor management", "item": [ { "name": "List all ClairCloud sites", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/sites", "query": [], "raw": "{{baseUrl}}\/api\/claircloud\/sites" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves all measurement sites from ClairCloud API.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"sites\": [...],\n \"total\": 4\n }\n}", "name": "" } ] }, { "name": "Get single ClairCloud site", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/sites\/:id", "query": [], "raw": "{{baseUrl}}\/api\/claircloud\/sites\/:id", "variable": [ { "id": "id", "key": "id", "value": "353", "description": "The ClairCloud site ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves detailed information about a specific site.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"site\": {...}\n }\n}", "name": "" } ] }, { "name": "List all ClairCloud measures", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/measures", "query": [], "raw": "{{baseUrl}}\/api\/claircloud\/measures" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves all measurement channels and their associated data streams.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"measures\": [...],\n \"total\": 20\n }\n}", "name": "" } ] }, { "name": "Fetch ClairCloud measurement data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/data", "query": [ { "key": "from", "value": "1741730400", "description": "Start timestamp (Unix epoch).", "disabled": false }, { "key": "to", "value": "1741734000", "description": "End timestamp (Unix epoch).", "disabled": false }, { "key": "streams", "value": "8720%2C8724%2C8728", "description": "Comma-separated list of stream IDs.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/claircloud\/data?from=1741730400&to=1741734000&streams=8720%2C8724%2C8728" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves data from specified streams within a date range.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"data\": [...],\n \"from\": 1741730400,\n \"to\": 1741734000\n }\n}", "name": "" } ] }, { "name": "Get ClairCloud sites status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/status", "query": [ { "key": "sites", "value": "353%2C1256", "description": "optional Comma-separated list of site IDs.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/claircloud\/status?sites=353%2C1256" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves current status and latest values for all or specified sites.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"sites_status\": [...],\n \"total\": 4\n }\n}", "name": "" } ] }, { "name": "List available ClairCloud datasources", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/datasources", "query": [], "raw": "{{baseUrl}}\/api\/claircloud\/datasources" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves all ClairCloud sites formatted as datasources for station registration.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"datasources\": [...],\n \"total\": 4,\n \"registered\": 2,\n \"available\": 2\n }\n}", "name": "" } ] }, { "name": "Register ClairCloud site as station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/register", "query": [], "raw": "{{baseUrl}}\/api\/claircloud\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"datasource_id\":\"353\",\"site_id\":353,\"tenant_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"manufacturer_id\":\"ed1d52f2-84ed-4aaf-a95c-057ed75a28fe\",\"owner\":\"CIAPOL\",\"station_class\":\"reference\",\"station_type\":\"urban\"}" }, "description": "Creates a Henddu station from a ClairCloud site with all associated equipment.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"ClairCloud site registered successfully\",\n \"data\": {\n \"station\": {...},\n \"device_integration\": {...},\n \"streams_count\": 10\n }\n}", "name": "" } ] }, { "name": "Batch register all ClairCloud sites", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/claircloud\/register\/batch", "query": [], "raw": "{{baseUrl}}\/api\/claircloud\/register\/batch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tenant_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"manufacturer_id\":\"architecto\",\"owner\":\"CIAPOL\",\"station_class\":\"reference\",\"station_type\":\"urban\",\"skip_existing\":true}" }, "description": "Automatically registers all available ClairCloud sites as Henddu stations.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Batch registration completed: 3 created, 1 skipped, 0 errors\",\n \"data\": {\n \"created\": 3,\n \"skipped\": 1,\n \"errors\": 0,\n \"results\": [...]\n }\n}", "name": "" } ] }, { "name": "Test ClairCloud provider connection", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/testing\/providers\/claircloud\/test", "query": [], "raw": "{{baseUrl}}\/api\/testing\/providers\/claircloud\/test" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Tests authentication and API connectivity with ClairCloud.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"provider\": \"ClairCloud\",\n \"status\": \"connected\",\n \"message\": \"Successfully connected to ClairCloud API\",\n \"data\": {\n \"sites_count\": 4,\n \"authenticated\": true\n }\n}", "name": "" } ] } ] }, { "name": "Clarity Integration", "description": "\nAPIs for Clarity Movement sensor registration and management", "item": [ { "name": "List all available Clarity datasources", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/clarity\/datasources", "query": [], "raw": "{{baseUrl}}\/api\/clarity\/datasources" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves all Clarity datasources from the API that can be registered.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"datasources\": [...],\n \"total\": 10,\n \"registered\": 5,\n \"available\": 5\n }\n}", "name": "" } ] }, { "name": "Register Clarity sensor by datasource ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/clarity\/register", "query": [], "raw": "{{baseUrl}}\/api\/clarity\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"datasource_id\":\"DGLJI0311\",\"tenant_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"manufacturer_id\":\"ed1d52f2-84ed-4aaf-a95c-057ed75a28fe\",\"owner\":\"CIAPOL\",\"station_class\":\"microstation\",\"station_type\":\"urban\",\"overrides\":[]}" }, "description": "This endpoint automatically fetches all device information from the Clarity API\nand creates the station with complete configuration.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Clarity sensor registered successfully\",\n \"data\": {\n \"station\": {\n \"id\": 123,\n \"station_name\": \"Node-S-ACH7\",\n \"latitude\": 5.41613,\n \"longitude\": -4.01548,\n \"status\": \"active\"\n },\n \"device_integration\": {\n \"id\": 456,\n \"provider_name\": \"clarity\",\n \"external_device_id\": \"DGLJI0311\",\n \"connection_status\": \"connected\",\n \"device_info\": {\n \"datasource_id\": \"DGLJI0311\",\n \"node_id\": \"ACH7GJHX\",\n \"model\": \"Node-S Global\",\n \"has_wind_sensor\": true\n }\n },\n \"connection_test\": {\n \"success\": true,\n \"message\": \"Datasource found and accessible\"\n }\n }\n}", "name": "" } ] }, { "name": "Batch register all available Clarity sensors", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/clarity\/register\/batch", "query": [], "raw": "{{baseUrl}}\/api\/clarity\/register\/batch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tenant_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"manufacturer_id\":\"ed1d52f2-84ed-4aaf-a95c-057ed75a28fe\",\"owner\":\"CIAPOL\",\"station_class\":\"microstation\",\"station_type\":\"urban\",\"skip_existing\":true}" }, "description": "Automatically discovers and registers all Clarity datasources in the organization.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Batch registration completed: 10 successful, 0 failed\",\n \"data\": {\n \"created\": 10,\n \"updated\": 0,\n \"skipped\": 0,\n \"errors\": 0,\n \"stations\": [...]\n }\n}", "name": "" } ] } ] }, { "name": "Correlation Analysis", "description": "\nAPI endpoints for analyzing correlations between air quality pollutants and meteorological parameters.", "item": [ { "name": "Create a new correlation analysis request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/correlation-analysis", "query": [], "raw": "{{baseUrl}}\/api\/correlation-analysis" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"PM2.5 vs Temperature Analysis\",\"description\":\"Analyzing relationships between air quality parameters\",\"analysis_type\":\"pollutant_vs_meteorological\",\"station_ids\":[\"station_001\",\"station_002\"],\"start_date\":\"2025-01-01\",\"end_date\":\"2025-01-31\\n\\n\\\/\\\/ For pollutant vs meteorological analysis\",\"granularity\":\"hourly\",\"include_time_lag_analysis\":true,\"max_lag_hours\":22,\"significance_threshold\":0.05,\"minimum_data_completeness\":70,\"correlation_method\":\"pearson\",\"confidence_level\":0.95,\"outlier_removal\":true,\"seasonal_adjustment\":false,\"locale\":\"en\",\"selected_pollutants\":[\"pm25\",\"no2\"],\"selected_meteorological\":null,\"pollutant_pairs\":[{\"primary\":\"pm25\",\"secondary\":\"pm10\"}],\"auto_generate_pollutant_pairs\":true,\"pollutants_for_pairs\":null}" }, "description": "Submit a correlation analysis request to analyze relationships between:\n1. Air quality pollutants and meteorological parameters (pollutant_vs_meteorological)\n2. Air quality pollutants with each other (pollutant_vs_pollutant)\n\nThe system supports both Pearson and Spearman correlation methods, with comprehensive statistical\noutput including correlation coefficients, linear regression analysis, significance testing,\nand model diagnostics.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "List correlation analysis requests", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/correlation-analysis", "query": [ { "key": "status", "value": "completed", "description": "Filter by analysis status (completed, failed).", "disabled": false }, { "key": "search", "value": "temperature", "description": "Search in analysis names and descriptions.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of items per page (max 50).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/correlation-analysis?status=completed&search=temperature&page=1&per_page=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of all correlation analysis requests for the authenticated user.\nSupports filtering by status and searching by name or description.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get analysis details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/correlation-analysis\/:analysisId", "query": [ { "key": "language", "value": "en", "description": "Language for result interpretation (en, fr). Overrides stored locale.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/correlation-analysis\/:analysisId?language=en", "variable": [ { "id": "analysisId", "key": "analysisId", "value": "9fe2a5b1-805b-42fa-ae25-0c1067fcad39", "description": "The ID of the analysis request." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve details and results for a specific correlation analysis.\nSince analyses are processed synchronously, this returns complete information.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get a summary of correlations with filtering and sorting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/correlation-analysis\/:analysisId\/summary", "query": [], "raw": "{{baseUrl}}\/api\/correlation-analysis\/:analysisId\/summary", "variable": [ { "id": "analysisId", "key": "analysisId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Delete analysis request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/correlation-analysis\/:analysisId", "query": [], "raw": "{{baseUrl}}\/api\/correlation-analysis\/:analysisId", "variable": [ { "id": "analysisId", "key": "analysisId", "value": "9fe2a5b1-805b-42fa-ae25-0c1067fcad39", "description": "The ID of the analysis request." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently delete a correlation analysis request and all associated results and metadata.\nThis action cannot be undone. Only the analysis owner or admin users can delete analyses.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get available parameters for station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/correlation-analysis\/stations\/:stationId\/parameters", "query": [], "raw": "{{baseUrl}}\/api\/correlation-analysis\/stations\/:stationId\/parameters", "variable": [ { "id": "stationId", "key": "stationId", "value": "station_001", "description": "The ID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the available air quality and meteorological parameters for a specific station.\nThis helps users understand what data is available before creating an analysis request.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get scatter plot data for a specific correlation result", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/correlation-analysis\/:analysisId\/scatter-plot", "query": [ { "key": "pollutant_parameter", "value": "pm25", "description": "(for pollutant vs meteorological) The pollutant parameter.", "disabled": false }, { "key": "meteorological_parameter", "value": "temperature", "description": "(for pollutant vs meteorological) The meteorological parameter.", "disabled": false }, { "key": "primary_pollutant", "value": "pm25", "description": "(for pollutant vs pollutant) The primary pollutant parameter.", "disabled": false }, { "key": "secondary_pollutant", "value": "pm10", "description": "(for pollutant vs pollutant) The secondary pollutant parameter.", "disabled": false }, { "key": "station_id", "value": "station_001", "description": "The station ID.", "disabled": false }, { "key": "sample_size", "value": "250", "description": "Optional number of data points to return (default: 250, max: 1000).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/correlation-analysis\/:analysisId\/scatter-plot?pollutant_parameter=pm25&meteorological_parameter=temperature&primary_pollutant=pm25&secondary_pollutant=pm10&station_id=station_001&sample_size=250", "variable": [ { "id": "analysisId", "key": "analysisId", "value": "9fec835d-68f5-4caf-9274-0a95235086a0", "description": "The ID of the correlation analysis." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve scatter plot data points for visualization of a specific correlation analysis result.\nReturns actual data points used in the correlation calculation, with optional sampling.\nSupports both pollutant vs meteorological and pollutant vs pollutant correlations.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Country Management", "description": "\nAPIs to manage countries, including retrieving, creating, updating, and deleting countries.", "item": [ { "name": "Display a list of all countries.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries", "query": [], "raw": "{{baseUrl}}\/api\/countries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all countries from the database, including their related regions,\nsubregions, and states. It provides an overview of all countries available.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show a specific country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/countries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the country." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a country by its ID, including related regions, subregions.\nIf the country does not exist, a 404 error is returned.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store a new country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries", "query": [], "raw": "{{baseUrl}}\/api\/countries" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"region_id\":16,\"subregion_id\":16,\"iso3\":\"ngz\",\"numeric_code\":\"miy\",\"iso2\":\"vd\",\"phonecode\":\"l\",\"capital\":\"j\",\"currency\":\"n\",\"currency_name\":\"i\",\"currency_symbol\":\"k\",\"tld\":\"h\",\"native\":\"w\",\"region\":\"a\",\"subregion\":\"y\",\"nationality\":\"k\",\"timezones\":\"architecto\",\"translations\":\"architecto\",\"latitude\":-89,\"longitude\":-180,\"emoji\":\"z\",\"emojiU\":\"m\",\"flag\":false,\"wikiDataId\":\"i\"}" }, "description": "This endpoint creates a new country. The request must include a country 'name', a 'region_id'\n(which links the country to a specific region), and optionally 'subregion_id', 'iso3', 'capital',\n'currency', and geolocation details (latitude and longitude).", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update a specific country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/countries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the country." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"region_id\":16,\"subregion_id\":16,\"iso3\":\"ngz\",\"numeric_code\":\"miy\",\"iso2\":\"vd\",\"phonecode\":\"l\",\"capital\":\"j\",\"currency\":\"n\",\"currency_name\":\"i\",\"currency_symbol\":\"k\",\"tld\":\"h\",\"native\":\"w\",\"region\":\"a\",\"subregion\":\"y\",\"nationality\":\"k\",\"timezones\":\"architecto\",\"translations\":\"architecto\",\"latitude\":-89,\"longitude\":-180,\"emoji\":\"z\",\"emojiU\":\"m\",\"flag\":true,\"wikiDataId\":\"i\"}" }, "description": "This endpoint allows updating the details of an existing country. It supports partial updates,\nwhere only the provided fields are updated, such as 'name', 'iso3', 'capital', or 'region_id'.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a specific country.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/countries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the country." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a country by its ID from the database. If the country does not exist,\na 404 error is returned. On success, a success message is returned.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Retrieve countries by region ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries\/regions\/:region_id", "query": [], "raw": "{{baseUrl}}\/api\/countries\/regions\/:region_id", "variable": [ { "id": "region_id", "key": "region_id", "value": "architecto", "description": "The ID of the region." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint fetches all countries that belong to a specific region, identified by the\nprovided 'region_id'. Related data such as region, subregion, and states are included.\nIf no countries are found for the given region, a 404 error is returned.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve countries by subregion ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/countries\/subregions\/:subregion_id", "query": [], "raw": "{{baseUrl}}\/api\/countries\/subregions\/:subregion_id", "variable": [ { "id": "subregion_id", "key": "subregion_id", "value": "architecto", "description": "The ID of the subregion." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint fetches all countries that belong to a specific subregion, identified by\nthe provided 'subregion_id'. It also includes related data such as region, subregion, and\nstates. If no countries are found for the given subregion, a 404 error is returned.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Data Analytics and Reporting", "description": "\nProvides insights and trends on air quality by analyzing collected data.", "item": [ { "name": "Get the average concentration of all pollutants by Stations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-analytics\/average-concentration-by-stations", "query": [], "raw": "{{baseUrl}}\/api\/data-analytics\/average-concentration-by-stations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_ids\":[\"9ca44a28-824b-45f3-a12b-19df647e07bb\",\"7d1e6348-b993-45a7-91e3-f230e75baf9a\"],\"pollutants\":[\"PM2.5\",\"CO\",\"O3\"],\"meteorological_parameters\":[\"precipitation\"],\"start_date\":\"2025-01-20T00:00:00Z\",\"end_date\":\"2025-01-29T23:59:59Z\",\"include_hourly\":true}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get the average concentration of pollutants grouped by pollutant and station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-analytics\/average-concentration-by-pollutants", "query": [], "raw": "{{baseUrl}}\/api\/data-analytics\/average-concentration-by-pollutants" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"state_ids\":[2625,2627,2633],\"influence_zones\":[\"Urban\",\"Rural\"],\"pollutants\":[\"PM2.5\",\"CO\",\"O3\"],\"meteorological_parameters\":[\"precipitation\"],\"start_date\":\"2025-01-20T00:00:00Z\",\"end_date\":\"2025-01-29T23:59:59Z\",\"include_hourly\":true}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Export Analytics Data as CSV", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-analytics\/export", "query": [], "raw": "{{baseUrl}}\/api\/data-analytics\/export" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_ids\":[\"6ff8f7f6-1eb3-3525-be4a-3932c805afed\"],\"state_ids\":[16],\"influence_zones\":[\"Rural\"],\"pollutants\":[\"architecto\"],\"meteorological_parameters\":[\"wind_speed\"],\"start_date\":\"2026-06-20T08:19:52\",\"end_date\":\"2052-07-13\",\"include_hourly\":false,\"format\":\"csv\"}" }, "description": "Stream a CSV download of pollutant and\/or meteorological data for the requested\nstations and date range.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Station Report with Pollutants and Weather Data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/data-analytics\/station-report\/:station_id", "query": [ { "key": "start_date", "value": "2025-10-28T00%3A00%3A00Z", "description": "The start time of the interval (ISO-8601 format).", "disabled": false }, { "key": "end_date", "value": "2025-11-04T23%3A59%3A59Z", "description": "The end time of the interval (ISO-8601 format).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/data-analytics\/station-report\/:station_id?start_date=2025-10-28T00%3A00%3A00Z&end_date=2025-11-04T23%3A59%3A59Z", "variable": [ { "id": "station_id", "key": "station_id", "value": "55aa507d-90f3-4353-b5a2-49df660c1cdc", "description": "The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2026-06-20T08:19:52\",\"end_date\":\"2052-07-13\"}" }, "description": "Retrieve comprehensive data for a single station including all pollutant measurements\nand meteorological\/weather data within a specified time range.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Station report retrieved successfully.\",\n \"data\": {\n \"station\": {\n \"id\": \"55aa507d-90f3-4353-b5a2-49df660c1cdc\",\n \"name\": \"Downtown Station\",\n \"city\": \"Abidjan\",\n \"latitude\": \"5.3600\",\n \"longitude\": \"-4.0083\"\n },\n \"time_range\": {\n \"start\": \"2025-10-28T00:00:00Z\",\n \"end\": \"2025-11-04T23:59:59Z\"\n },\n \"pollutants\": [\n {\n \"symbol\": \"CO2\",\n \"name\": \"Carbon Dioxide\",\n \"unit\": \"\u00b5g\/m\u00b3\",\n \"average_concentration\": 450.5,\n \"min_concentration\": 380.2,\n \"max_concentration\": 520.8,\n \"data_points\": 168\n }\n ],\n \"weather\": {\n \"temperature\": {\n \"average\": 28.5,\n \"min\": 24.2,\n \"max\": 32.1,\n \"unit\": \"\u00b0C\"\n },\n \"humidity\": {\n \"average\": 65.3,\n \"min\": 45.0,\n \"max\": 85.0,\n \"unit\": \"%\"\n }\n }\n }\n}", "name": "" } ] } ] }, { "name": "Manufacturers", "description": "\nManage manufacturers including their creation, updates, and retrieval.", "item": [ { "name": "Get all manufacturers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/manufacturers", "query": [], "raw": "{{baseUrl}}\/api\/manufacturers" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all manufacturers.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get a single manufacturer by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/manufacturers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/manufacturers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the manufacturer." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific manufacturer by its ID.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new manufacturer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/manufacturers", "query": [], "raw": "{{baseUrl}}\/api\/manufacturers" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"country\":\"n\",\"contact_email\":\"ashly64@example.com\",\"website\":\"v\",\"certification_status\":\"d\",\"founded_year\":5}" }, "description": "This endpoint creates a new manufacturer.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update an existing manufacturer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/manufacturers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/manufacturers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the manufacturer to update." } ] }, "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"country\":\"n\",\"contact_email\":\"ashly64@example.com\",\"website\":\"v\",\"certification_status\":\"d\",\"founded_year\":5}" }, "description": "This endpoint updates an existing manufacturer by ID.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a manufacturer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/manufacturers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/manufacturers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the manufacturer to delete." } ] }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a manufacturer by ID.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get all stations for a specific manufacturer.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/manufacturers\/:id\/stations", "query": [], "raw": "{{baseUrl}}\/api\/manufacturers\/:id\/stations", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the manufacturer." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {token}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all stations for a specific manufacturer by ID.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Meteorological Parameter", "description": "\nAPIs to manage meteorological parameters.", "item": [ { "name": "Display a list of all meteorological parameters.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meteorological-parameters", "query": [], "raw": "{{baseUrl}}\/api\/meteorological-parameters" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves and returns all meteorological parameters from the database.\nIt can be used to get an overview of the existing meteorological parameters.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store a new meteorological parameter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meteorological-parameters", "query": [], "raw": "{{baseUrl}}\/api\/meteorological-parameters" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Temperature\",\"symbol\":\"\u00b0C\",\"unit\":\"Celsius\",\"description\":\"The air temperature\",\"category\":\"Meteorological\",\"min_value\":-50,\"max_value\":50,\"is_derived\":false,\"formula\":\"N\\\/A\",\"source\":\"Sensor A\",\"is_active\":true}" }, "description": "This endpoint creates a new meteorological parameter in the database. The request must include\nthe necessary fields for the meteorological parameter such as 'name', 'unit', 'description', etc.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Show a specific meteorological parameter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meteorological-parameters\/:meteorologicalParameter", "query": [], "raw": "{{baseUrl}}\/api\/meteorological-parameters\/:meteorologicalParameter", "variable": [ { "id": "meteorologicalParameter", "key": "meteorologicalParameter", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific meteorological parameter based on the provided parameter ID.\nIf the parameter does not exist, it will return a 404 error.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a specific meteorological parameter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meteorological-parameters\/:meteorologicalParameter", "query": [], "raw": "{{baseUrl}}\/api\/meteorological-parameters\/:meteorologicalParameter", "variable": [ { "id": "meteorologicalParameter", "key": "meteorologicalParameter", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Temperature\",\"symbol\":\"\u00b0C\",\"unit\":\"Celsius\",\"description\":\"The air temperature\",\"category\":\"Meteorological\",\"min_value\":-50,\"max_value\":50,\"is_derived\":false,\"formula\":\"N\\\/A\",\"source\":\"Sensor A\",\"is_active\":true}" }, "description": "This endpoint allows updating the details of an existing meteorological parameter. Only the fields\nprovided in the request will be updated (e.g., 'name', 'unit', etc.).", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a specific meteorological parameter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meteorological-parameters\/:meteorologicalParameter", "query": [], "raw": "{{baseUrl}}\/api\/meteorological-parameters\/:meteorologicalParameter", "variable": [ { "id": "meteorologicalParameter", "key": "meteorologicalParameter", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a meteorological parameter from the database based on the provided parameter ID.\nIf the parameter does not exist, it will return a 404 error.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "News & Air Pollution Information", "description": "\nAPIs for managing news articles and air pollution educational content with multi-language support.", "item": [ { "name": "Get All News Articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr).", "disabled": false }, { "key": "category", "value": "air_quality", "description": "Filter by category key.", "disabled": false }, { "key": "tags", "value": "abidjan%2Cpollution", "description": "Comma-separated tags to filter by.", "disabled": false }, { "key": "featured", "value": "1", "description": "Get only featured articles.", "disabled": false }, { "key": "search", "value": "air+quality", "description": "Search term for title and content.", "disabled": false }, { "key": "sort", "value": "latest", "description": "Sort order: latest, popular, trending.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of articles per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news?language=en&category=air_quality&tags=abidjan%2Cpollution&featured=1&search=air+quality&sort=latest&limit=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a paginated list of published news articles with optional filtering and search capabilities.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Articles retrieved successfully\",\n \"data\": {\n \"articles\": [\n {\n \"id\": \"uuid\",\n \"title\": {\"en\": \"Air Quality in Abidjan\", \"fr\": \"Qualit\u00e9 de l'air \u00e0 Abidjan\"},\n \"slug\": \"air-quality-abidjan\",\n \"excerpt\": {\"en\": \"Brief summary...\", \"fr\": \"Bref r\u00e9sum\u00e9...\"},\n \"category\": {\"key\": \"air_quality\", \"name\": {\"en\": \"Air Quality\", \"fr\": \"Qualit\u00e9 de l'air\"}},\n \"author\": {\"id\": \"uuid\", \"name\": \"John Doe\"},\n \"featured_image\": \"https:\/\/example.com\/image.jpg\",\n \"is_featured\": true,\n \"published_at\": \"2025-08-26T10:00:00Z\",\n \"views_count\": 1250,\n \"likes_count\": 45,\n \"reading_time_minutes\": 8\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total\": 150,\n \"total_pages\": 8\n }\n }\n}", "name": "Success" } ] }, { "name": "Get Single Article", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/:slug", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news\/:slug?language=en", "variable": [ { "id": "slug", "key": "slug", "value": "air-quality-abidjan", "description": "Article slug." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a single article by its slug with related articles and air quality context.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Article retrieved successfully\",\n \"data\": {\n \"article\": {\n \"id\": \"uuid\",\n \"title\": \"Air Quality in Abidjan\",\n \"content\": \"Full article content...\",\n \"excerpt\": \"Brief summary...\",\n \"air_quality_info\": {\n \"topics\": [\"urban_air\", \"health_effects\"],\n \"recommendations\": [\"Stay indoors during high pollution\"]\n }\n },\n \"related_articles\": [],\n \"air_quality_context\": {\n \"general_tips\": [\"Tips for cleaner air\"],\n \"educational_content\": {}\n }\n }\n}", "name": "Success" } ] }, { "name": "Get Featured Articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/featured\/articles", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr). Default: en.", "disabled": false }, { "key": "limit", "value": "5", "description": "Number of articles to return (max 50). Default: 10.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news\/featured\/articles?language=en&limit=5" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a curated list of featured articles highlighted by editors.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Featured articles retrieved successfully\",\n \"data\": [\n {\n \"id\": \"uuid\",\n \"title\": \"Understanding Air Quality Index in C\u00f4te d'Ivoire\",\n \"slug\": \"understanding-aqi-cote-divoire\",\n \"excerpt\": \"A comprehensive guide to understanding air quality measurements...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": \"Air Quality\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"Dr. Marie Kouadio\",\n \"avatar_url\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"tags\": [\n {\n \"id\": \"uuid\",\n \"name\": \"aqi\",\n \"display_name\": \"Air Quality Index\"\n }\n ],\n \"featured_image\": \"https:\/\/example.com\/featured.jpg\",\n \"is_featured\": true,\n \"published_at\": \"2025-08-26T10:00:00Z\",\n \"views_count\": 2450,\n \"likes_count\": 87,\n \"shares_count\": 23,\n \"reading_time_minutes\": 12\n }\n ]\n}", "name": "Featured articles retrieved" } ] }, { "name": "Get Articles by Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/category\/:categoryKey", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr). Default: en.", "disabled": false }, { "key": "limit", "value": "15", "description": "Number of articles per page (max 100). Default: 20.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. Default: 1.", "disabled": false }, { "key": "featured", "value": "1", "description": "Filter only featured articles.", "disabled": false }, { "key": "sort", "value": "popular", "description": "Sort order: latest, popular, trending. Default: latest.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news\/category\/:categoryKey?language=en&limit=15&page=1&featured=1&sort=popular", "variable": [ { "id": "categoryKey", "key": "categoryKey", "value": "air_quality", "description": "Category key identifier." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all articles from a specific category with pagination and filtering.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Articles retrieved successfully\",\n \"data\": {\n \"articles\": [\n {\n \"id\": \"uuid\",\n \"title\": \"Health Effects of Air Pollution\",\n \"slug\": \"health-effects-air-pollution\",\n \"excerpt\": \"Understanding how air pollution affects your health...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"health\",\n \"name\": \"Health\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"Dr. Aminata Traor\u00e9\",\n \"avatar_url\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"tags\": [\n {\n \"id\": \"uuid\",\n \"name\": \"health\",\n \"display_name\": \"Health\"\n }\n ],\n \"featured_image\": \"https:\/\/example.com\/health.jpg\",\n \"is_featured\": false,\n \"published_at\": \"2025-08-25T14:30:00Z\",\n \"views_count\": 1320,\n \"likes_count\": 54,\n \"shares_count\": 18,\n \"reading_time_minutes\": 9\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 42,\n \"total_pages\": 3\n }\n }\n}", "name": "Category articles retrieved" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Category not found\",\n \"data\": null\n}", "name": "Category not found" } ] }, { "name": "Create New Article", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news", "query": [], "raw": "{{baseUrl}}\/api\/news" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title[en]", "value": "Air Quality in Abidjan", "type": "text", "description": "" }, { "key": "title[fr]", "value": "Qualit\u00e9 de l'air \u00e0 Abidjan", "type": "text", "description": "" }, { "key": "content[en]", "value": "Article content...", "type": "text", "description": "" }, { "key": "content[fr]", "value": "Contenu de l'article...", "type": "text", "description": "" }, { "key": "excerpt[en]", "value": "Brief summary...", "type": "text", "description": "" }, { "key": "excerpt[fr]", "value": "Bref r\u00e9sum\u00e9...", "type": "text", "description": "" }, { "key": "category_id", "value": "\"uuid\"", "type": "text", "description": "Category UUID." }, { "key": "slug", "value": "i", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "air_quality_info[topics][0]", "value": "health_effects", "type": "text", "description": "" }, { "key": "air_quality_info[pollution_sources][0]", "value": "natural", "type": "text", "description": "" }, { "key": "air_quality_info[health_impact_level]", "value": "moderate", "type": "text", "description": "" }, { "key": "air_quality_info[affected_groups][0]", "value": "children", "type": "text", "description": "" }, { "key": "air_quality_info[recommendations][en][0]", "value": "y", "type": "text", "description": "" }, { "key": "air_quality_info[recommendations][fr][0]", "value": "v", "type": "text", "description": "" }, { "key": "status", "value": "draft", "type": "text", "description": "Article status: draft, published, archived." }, { "key": "is_featured", "value": "", "type": "text", "description": "Whether article is featured." }, { "key": "published_at", "value": "\"2025-08-26T10:00:00Z\"", "type": "text", "description": "Publication date (ISO format)." }, { "key": "tags[0]", "value": "abidjan", "type": "text", "description": "" }, { "key": "tags[1]", "value": "air_quality", "type": "text", "description": "" }, { "key": "seo[meta_title][en]", "value": "l", "type": "text", "description": "" }, { "key": "seo[meta_title][fr]", "value": "j", "type": "text", "description": "" }, { "key": "seo[meta_description][en]", "value": "n", "type": "text", "description": "" }, { "key": "seo[meta_description][fr]", "value": "i", "type": "text", "description": "" }, { "key": "seo[keywords][0]", "value": "k", "type": "text", "description": "" }, { "key": "images[0][caption][en]", "value": "h", "type": "text", "description": "" }, { "key": "images[0][caption][fr]", "value": "w", "type": "text", "description": "" }, { "key": "images[0][alt_text][en]", "value": "a", "type": "text", "description": "" }, { "key": "images[0][alt_text][fr]", "value": "y", "type": "text", "description": "" }, { "key": "featured_image", "src": [], "type": "file" }, { "key": "images[][file]", "src": [], "type": "file" } ] }, "description": "Create a new news article with multi-language content and air quality information." }, "response": [] }, { "name": "Update Article", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/:newsArticle_id", "query": [], "raw": "{{baseUrl}}\/api\/news\/:newsArticle_id", "variable": [ { "id": "newsArticle_id", "key": "newsArticle_id", "value": "architecto", "description": "The ID of the newsArticle." }, { "id": "newsArticle", "key": "newsArticle", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Article UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title[en]", "value": "Updated Air Quality in Abidjan", "type": "text", "description": "" }, { "key": "title[fr]", "value": "Qualit\u00e9 de l'air mise \u00e0 jour \u00e0 Abidjan", "type": "text", "description": "" }, { "key": "content[en]", "value": "Updated article content...", "type": "text", "description": "" }, { "key": "content[fr]", "value": "Contenu de l'article mis \u00e0 jour...", "type": "text", "description": "" }, { "key": "excerpt[en]", "value": "Updated summary...", "type": "text", "description": "" }, { "key": "excerpt[fr]", "value": "R\u00e9sum\u00e9 mis \u00e0 jour...", "type": "text", "description": "" }, { "key": "category_id", "value": "\"uuid\"", "type": "text", "description": "Category UUID." }, { "key": "slug", "value": "i", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "air_quality_info[topics][0]", "value": "prevention_tips", "type": "text", "description": "" }, { "key": "air_quality_info[pollution_sources][0]", "value": "construction", "type": "text", "description": "" }, { "key": "air_quality_info[health_impact_level]", "value": "moderate", "type": "text", "description": "" }, { "key": "air_quality_info[affected_groups][0]", "value": "children", "type": "text", "description": "" }, { "key": "air_quality_info[recommendations][en][0]", "value": "y", "type": "text", "description": "" }, { "key": "air_quality_info[recommendations][fr][0]", "value": "v", "type": "text", "description": "" }, { "key": "status", "value": "published", "type": "text", "description": "Article status: draft, published, archived." }, { "key": "is_featured", "value": "1", "type": "text", "description": "Whether article is featured." }, { "key": "published_at", "value": "\"2025-08-26T10:00:00Z\"", "type": "text", "description": "Publication date (ISO format)." }, { "key": "tags[0]", "value": "abidjan", "type": "text", "description": "" }, { "key": "tags[1]", "value": "air_quality", "type": "text", "description": "" }, { "key": "tags[2]", "value": "updated", "type": "text", "description": "" }, { "key": "seo[meta_title][en]", "value": "l", "type": "text", "description": "" }, { "key": "seo[meta_title][fr]", "value": "j", "type": "text", "description": "" }, { "key": "seo[meta_description][en]", "value": "n", "type": "text", "description": "" }, { "key": "seo[meta_description][fr]", "value": "i", "type": "text", "description": "" }, { "key": "seo[keywords][0]", "value": "k", "type": "text", "description": "" }, { "key": "images[0][caption][en]", "value": "h", "type": "text", "description": "" }, { "key": "images[0][caption][fr]", "value": "w", "type": "text", "description": "" }, { "key": "images[0][alt_text][en]", "value": "a", "type": "text", "description": "" }, { "key": "images[0][alt_text][fr]", "value": "y", "type": "text", "description": "" }, { "key": "featured_image", "src": [], "type": "file" }, { "key": "images[][file]", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Update an existing article with new content, metadata, or settings. Users can only update their own articles unless they have admin role." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Article updated successfully\",\n \"data\": {\n \"id\": \"uuid\",\n \"title\": \"Updated Air Quality in Abidjan\",\n \"slug\": \"updated-air-quality-abidjan\",\n \"content\": \"Updated comprehensive article content...\",\n \"excerpt\": \"Updated summary of the article...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": \"Air Quality\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"Dr. Marie Kouadio\",\n \"avatar_url\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"tags\": [\n {\n \"id\": \"uuid\",\n \"name\": \"updated\",\n \"display_name\": \"Updated\"\n }\n ],\n \"featured_image\": \"https:\/\/example.com\/updated-featured.jpg\",\n \"is_featured\": true,\n \"published_at\": \"2025-08-26T10:00:00Z\",\n \"views_count\": 1250,\n \"likes_count\": 45,\n \"shares_count\": 12,\n \"reading_time_minutes\": 10,\n \"air_quality_info\": {\n \"topics\": [\"urban_air\", \"health_effects\"],\n \"recommendations\": [\"Stay indoors during high pollution\"]\n },\n \"images\": [],\n \"seo\": {\n \"meta_title\": \"Updated Air Quality in Abidjan\",\n \"meta_description\": \"Updated comprehensive guide...\",\n \"keywords\": [\"air\", \"quality\", \"abidjan\", \"updated\"]\n }\n }\n}", "name": "Article updated successfully" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized to update this article\",\n \"data\": null\n}", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Article not found\",\n \"data\": null\n}", "name": "Article not found" } ] }, { "name": "Update Article", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/:newsArticle_id", "query": [], "raw": "{{baseUrl}}\/api\/news\/:newsArticle_id", "variable": [ { "id": "newsArticle_id", "key": "newsArticle_id", "value": "architecto", "description": "The ID of the newsArticle." }, { "id": "newsArticle", "key": "newsArticle", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Article UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title[en]", "value": "Updated Air Quality in Abidjan", "type": "text", "description": "" }, { "key": "title[fr]", "value": "Qualit\u00e9 de l'air mise \u00e0 jour \u00e0 Abidjan", "type": "text", "description": "" }, { "key": "content[en]", "value": "Updated article content...", "type": "text", "description": "" }, { "key": "content[fr]", "value": "Contenu de l'article mis \u00e0 jour...", "type": "text", "description": "" }, { "key": "excerpt[en]", "value": "Updated summary...", "type": "text", "description": "" }, { "key": "excerpt[fr]", "value": "R\u00e9sum\u00e9 mis \u00e0 jour...", "type": "text", "description": "" }, { "key": "category_id", "value": "\"uuid\"", "type": "text", "description": "Category UUID." }, { "key": "slug", "value": "i", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "air_quality_info[topics][0]", "value": "indoor_air", "type": "text", "description": "" }, { "key": "air_quality_info[pollution_sources][0]", "value": "construction", "type": "text", "description": "" }, { "key": "air_quality_info[health_impact_level]", "value": "moderate", "type": "text", "description": "" }, { "key": "air_quality_info[affected_groups][0]", "value": "pregnant_women", "type": "text", "description": "" }, { "key": "air_quality_info[recommendations][en][0]", "value": "y", "type": "text", "description": "" }, { "key": "air_quality_info[recommendations][fr][0]", "value": "v", "type": "text", "description": "" }, { "key": "status", "value": "published", "type": "text", "description": "Article status: draft, published, archived." }, { "key": "is_featured", "value": "1", "type": "text", "description": "Whether article is featured." }, { "key": "published_at", "value": "\"2025-08-26T10:00:00Z\"", "type": "text", "description": "Publication date (ISO format)." }, { "key": "tags[0]", "value": "abidjan", "type": "text", "description": "" }, { "key": "tags[1]", "value": "air_quality", "type": "text", "description": "" }, { "key": "tags[2]", "value": "updated", "type": "text", "description": "" }, { "key": "seo[meta_title][en]", "value": "l", "type": "text", "description": "" }, { "key": "seo[meta_title][fr]", "value": "j", "type": "text", "description": "" }, { "key": "seo[meta_description][en]", "value": "n", "type": "text", "description": "" }, { "key": "seo[meta_description][fr]", "value": "i", "type": "text", "description": "" }, { "key": "seo[keywords][0]", "value": "k", "type": "text", "description": "" }, { "key": "images[0][caption][en]", "value": "h", "type": "text", "description": "" }, { "key": "images[0][caption][fr]", "value": "w", "type": "text", "description": "" }, { "key": "images[0][alt_text][en]", "value": "a", "type": "text", "description": "" }, { "key": "images[0][alt_text][fr]", "value": "y", "type": "text", "description": "" }, { "key": "featured_image", "src": [], "type": "file" }, { "key": "images[][file]", "src": [], "type": "file" }, { "key": "_method", "value": "PATCH", "type": "text" } ] }, "description": "Update an existing article with new content, metadata, or settings. Users can only update their own articles unless they have admin role." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Article updated successfully\",\n \"data\": {\n \"id\": \"uuid\",\n \"title\": \"Updated Air Quality in Abidjan\",\n \"slug\": \"updated-air-quality-abidjan\",\n \"content\": \"Updated comprehensive article content...\",\n \"excerpt\": \"Updated summary of the article...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": \"Air Quality\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"Dr. Marie Kouadio\",\n \"avatar_url\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"tags\": [\n {\n \"id\": \"uuid\",\n \"name\": \"updated\",\n \"display_name\": \"Updated\"\n }\n ],\n \"featured_image\": \"https:\/\/example.com\/updated-featured.jpg\",\n \"is_featured\": true,\n \"published_at\": \"2025-08-26T10:00:00Z\",\n \"views_count\": 1250,\n \"likes_count\": 45,\n \"shares_count\": 12,\n \"reading_time_minutes\": 10,\n \"air_quality_info\": {\n \"topics\": [\"urban_air\", \"health_effects\"],\n \"recommendations\": [\"Stay indoors during high pollution\"]\n },\n \"images\": [],\n \"seo\": {\n \"meta_title\": \"Updated Air Quality in Abidjan\",\n \"meta_description\": \"Updated comprehensive guide...\",\n \"keywords\": [\"air\", \"quality\", \"abidjan\", \"updated\"]\n }\n }\n}", "name": "Article updated successfully" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized to update this article\",\n \"data\": null\n}", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Article not found\",\n \"data\": null\n}", "name": "Article not found" } ] }, { "name": "Delete Article", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/:newsArticle_id", "query": [], "raw": "{{baseUrl}}\/api\/news\/:newsArticle_id", "variable": [ { "id": "newsArticle_id", "key": "newsArticle_id", "value": "architecto", "description": "The ID of the newsArticle." }, { "id": "newsArticle", "key": "newsArticle", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Article UUID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently delete an article and all its associated data. Users can only delete their own articles unless they have admin role. This action cannot be undone." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Article deleted successfully\",\n \"data\": null\n}", "name": "Article deleted successfully" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"Unauthorized to delete this article\",\n \"data\": null\n}", "name": "Unauthorized" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Article not found\",\n \"data\": null\n}", "name": "Article not found" } ] }, { "name": "Toggle Article Like", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/:newsArticle_id\/like", "query": [], "raw": "{{baseUrl}}\/api\/news\/:newsArticle_id\/like", "variable": [ { "id": "newsArticle_id", "key": "newsArticle_id", "value": "architecto", "description": "The ID of the newsArticle." }, { "id": "newsArticle", "key": "newsArticle", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Article UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Like or unlike an article. If the user has already liked the article, it will be unliked. If not, it will be liked." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Article liked\",\n \"data\": {\n \"liked\": true,\n \"likes_count\": 46,\n \"user_liked\": true\n }\n}", "name": "Article liked" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Article unliked\",\n \"data\": {\n \"liked\": false,\n \"likes_count\": 45,\n \"user_liked\": false\n }\n}", "name": "Article unliked" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Article not found\",\n \"data\": null\n}", "name": "Article not found" } ] }, { "name": "Share Article", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/:newsArticle_id\/share", "query": [], "raw": "{{baseUrl}}\/api\/news\/:newsArticle_id\/share", "variable": [ { "id": "newsArticle_id", "key": "newsArticle_id", "value": "architecto", "description": "The ID of the newsArticle." }, { "id": "newsArticle", "key": "newsArticle", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Article UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"twitter\",\"url\":\"https:\\\/\\\/twitter.com\\\/user\\\/status\\\/123\",\"message\":\"\\\"Great article about air quality!\\\"\"}" }, "description": "Record an article share event with optional metadata about the sharing platform and context." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Article shared successfully\",\n \"data\": {\n \"shares_count\": 13\n }\n}", "name": "Article shared successfully" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Article not found\",\n \"data\": null\n}", "name": "Article not found" } ] }, { "name": "Get User's Articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/my\/articles", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr). Default: en.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by article status: draft, published, archived.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. Default: 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news\/my\/articles?language=en&status=published&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve articles created by the authenticated user with filtering options." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Your articles retrieved successfully\",\n \"data\": {\n \"articles\": [\n {\n \"id\": \"uuid\",\n \"title\": \"My Article on Air Quality\",\n \"slug\": \"my-article-air-quality\",\n \"excerpt\": \"This is my personal research on air quality...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"research\",\n \"name\": \"Research\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"Current User\",\n \"avatar_url\": \"https:\/\/example.com\/user-avatar.jpg\"\n },\n \"tags\": [],\n \"featured_image\": null,\n \"is_featured\": false,\n \"published_at\": \"2025-08-26T08:00:00Z\",\n \"views_count\": 125,\n \"likes_count\": 8,\n \"shares_count\": 2,\n \"reading_time_minutes\": 5\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total\": 5,\n \"total_pages\": 1\n }\n }\n}", "name": "User articles retrieved" } ] }, { "name": "Bulk Publish Articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news\/bulk-publish", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news\/bulk-publish" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"article_ids\":[\"uuid1\",\"uuid2\",\"uuid3\"]}" }, "description": "Publish multiple articles at once. Sets status to 'published' and published_at to current timestamp." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"3 articles published successfully\",\n \"data\": {\n \"updated_count\": 3\n }\n}", "name": "Articles published successfully" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"article_ids\": [\"The article_ids field is required.\"]\n }\n}", "name": "Validation error" } ] }, { "name": "Bulk Archive Articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news\/bulk-archive", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news\/bulk-archive" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"article_ids\":[\"uuid1\",\"uuid2\",\"uuid3\"]}" }, "description": "Archive multiple articles at once. Changes status to 'archived' for selected articles." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"5 articles archived successfully\",\n \"data\": {\n \"updated_count\": 5\n }\n}", "name": "Articles archived successfully" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"article_ids\": [\"The article_ids field is required.\"]\n }\n}", "name": "Validation error" } ] }, { "name": "Bulk Delete Articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news\/bulk-delete", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news\/bulk-delete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"article_ids\":[\"uuid1\",\"uuid2\",\"uuid3\"]}" }, "description": "Permanently delete multiple articles at once. This action cannot be undone and removes all associated data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"2 articles deleted successfully\",\n \"data\": {\n \"deleted_count\": 2\n }\n}", "name": "Articles deleted successfully" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"article_ids\": [\"The article_ids field is required.\"]\n }\n}", "name": "Validation error" } ] }, { "name": "Analytics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news\/analytics", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news\/analytics" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get comprehensive news analytics data for admin dashboard including article statistics, popular content, and trends." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Analytics data retrieved successfully\",\n \"data\": {\n \"total_articles\": 127,\n \"published_articles\": 98,\n \"draft_articles\": 23,\n \"archived_articles\": 6,\n \"total_views\": 45230,\n \"total_likes\": 1847,\n \"total_shares\": 392,\n \"top_categories\": [\n {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": {\"en\": \"Air Quality\", \"fr\": \"Qualit\u00e9 de l'air\"},\n \"articles_count\": 34\n },\n {\n \"id\": \"uuid\",\n \"key\": \"health\",\n \"name\": {\"en\": \"Health\", \"fr\": \"Sant\u00e9\"},\n \"articles_count\": 28\n }\n ],\n \"top_authors\": [\n {\n \"id\": \"uuid\",\n \"name\": \"Dr. Marie Kouadio\",\n \"articles_count\": 15\n },\n {\n \"id\": \"uuid\",\n \"name\": \"Dr. Aminata Traor\u00e9\",\n \"articles_count\": 12\n }\n ],\n \"trending_articles\": [\n {\n \"id\": \"uuid\",\n \"title\": \"Understanding Air Quality Index in C\u00f4te d'Ivoire\",\n \"slug\": \"understanding-aqi-cote-divoire\",\n \"views_count\": 2450,\n \"category\": \"Air Quality\"\n }\n ],\n \"views_by_month\": [\n {\n \"month\": \"2025-09\",\n \"views\": 3240\n },\n {\n \"month\": \"2025-10\",\n \"views\": 3890\n },\n {\n \"month\": \"2025-08\",\n \"views\": 4520\n }\n ]\n }\n}", "name": "Analytics retrieved successfully" } ] }, { "name": "Admin Index - Get All Articles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news\/all", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr). Default: en.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status: draft, published, archived.", "disabled": false }, { "key": "author", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "Filter by author UUID.", "disabled": false }, { "key": "category", "value": "air_quality", "description": "Filter by category key.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. Default: 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/news\/all?language=en&status=published&author=550e8400-e29b-41d4-a716-446655440000&category=air_quality&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all articles including drafts and archived articles for admin users with comprehensive filtering." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"All articles retrieved successfully\",\n \"data\": {\n \"articles\": [\n {\n \"id\": \"uuid\",\n \"title\": \"Draft Article on Pollution\",\n \"slug\": \"draft-article-pollution\",\n \"excerpt\": \"This is a draft article...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": \"Air Quality\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"John Doe\",\n \"avatar_url\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"tags\": [],\n \"featured_image\": null,\n \"is_featured\": false,\n \"published_at\": null,\n \"views_count\": 0,\n \"likes_count\": 0,\n \"shares_count\": 0,\n \"reading_time_minutes\": 7,\n \"status\": \"draft\",\n \"created_at\": \"2025-08-26T10:00:00Z\",\n \"updated_at\": \"2025-08-26T10:30:00Z\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 50,\n \"total\": 127,\n \"total_pages\": 3\n },\n \"stats\": {\n \"total_articles\": 127,\n \"published_articles\": 98,\n \"draft_articles\": 23,\n \"archived_articles\": 6\n }\n }\n}", "name": "All articles retrieved" } ] }, { "name": "Basic Search", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/search", "query": [ { "key": "q", "value": "%22air+quality%22", "description": "Search query term.", "disabled": false }, { "key": "language", "value": "en", "description": "Language preference (en or fr). Default: en.", "disabled": false }, { "key": "category", "value": "air_quality", "description": "Filter by category key.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news\/search?q=%22air+quality%22&language=en&category=air_quality" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search articles by title and content with simple filtering options.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Search results retrieved successfully\",\n \"data\": {\n \"articles\": [\n {\n \"id\": \"uuid\",\n \"title\": \"Air Quality Monitoring in Abidjan\",\n \"slug\": \"air-quality-monitoring-abidjan\",\n \"excerpt\": \"Learn about air quality monitoring systems...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": \"Air Quality\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"Dr. Marie Kouadio\",\n \"avatar_url\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"tags\": [],\n \"featured_image\": \"https:\/\/example.com\/featured.jpg\",\n \"is_featured\": false,\n \"published_at\": \"2025-08-26T10:00:00Z\",\n \"views_count\": 856,\n \"likes_count\": 32,\n \"shares_count\": 8,\n \"reading_time_minutes\": 6\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total\": 15,\n \"total_pages\": 1\n },\n \"search_query\": \"air quality\",\n \"language\": \"en\"\n }\n}", "name": "Search success" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Search query is required\",\n \"data\": null\n}", "name": "Missing search query" } ] }, { "name": "Advanced Search", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news\/search\/advanced", "query": [ { "key": "query", "value": "%22air+pollution%22", "description": "Optional search term to find in article titles and content.", "disabled": false }, { "key": "language", "value": "en", "description": "Language preference (en or fr). Default: en.", "disabled": false }, { "key": "filters[]", "value": "", "description": "Advanced filtering options.", "disabled": true }, { "key": "filters.category[0]", "value": "air_quality", "description": "Filter by category keys.", "disabled": false }, { "key": "filters.category[1]", "value": "health", "description": "Filter by category keys.", "disabled": false }, { "key": "filters.tags[0]", "value": "abidjan", "description": "Filter by tag names.", "disabled": false }, { "key": "filters.tags[1]", "value": "pollution", "description": "Filter by tag names.", "disabled": false }, { "key": "filters.tags[2]", "value": "health", "description": "Filter by tag names.", "disabled": false }, { "key": "filters.date_range[]", "value": "", "description": "Date range filter.", "disabled": true }, { "key": "filters.date_range.start", "value": "%222025-01-01%22", "description": "Start date (ISO format).", "disabled": false }, { "key": "filters.date_range.end", "value": "%222025-12-31%22", "description": "End date (ISO format).", "disabled": false }, { "key": "filters.author_ids[0]", "value": "uuid1", "description": "Filter by author UUIDs.", "disabled": false }, { "key": "filters.author_ids[1]", "value": "uuid2", "description": "Filter by author UUIDs.", "disabled": false }, { "key": "filters.has_air_quality_info", "value": "1", "description": "Only articles with air quality information.", "disabled": false }, { "key": "filters.reading_time[]", "value": "", "description": "Reading time range filter.", "disabled": true }, { "key": "filters.reading_time.min", "value": "5", "description": "Minimum reading time in minutes.", "disabled": false }, { "key": "filters.reading_time.max", "value": "15", "description": "Maximum reading time in minutes.", "disabled": false }, { "key": "sort[]", "value": "", "description": "Sorting configuration.", "disabled": true }, { "key": "sort.field", "value": "views_count", "description": "Sort field: published_at, views_count, likes_count, created_at. Default: published_at.", "disabled": false }, { "key": "sort.direction", "value": "desc", "description": "Sort direction: asc, desc. Default: desc.", "disabled": false }, { "key": "pagination[]", "value": "", "description": "Pagination settings.", "disabled": true }, { "key": "pagination.page", "value": "1", "description": "Page number. Default: 1.", "disabled": false }, { "key": "pagination.limit", "value": "20", "description": "Items per page (max 100). Default: 20.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news\/search\/advanced?query=%22air+pollution%22&language=en&filters[]=&filters.category[0]=air_quality&filters.category[1]=health&filters.tags[0]=abidjan&filters.tags[1]=pollution&filters.tags[2]=health&filters.date_range[]=&filters.date_range.start=%222025-01-01%22&filters.date_range.end=%222025-12-31%22&filters.author_ids[0]=uuid1&filters.author_ids[1]=uuid2&filters.has_air_quality_info=1&filters.reading_time[]=&filters.reading_time.min=5&filters.reading_time.max=15&sort[]=&sort.field=views_count&sort.direction=desc&pagination[]=&pagination.page=1&pagination.limit=20" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Comprehensive search functionality with multiple filters, criteria, and sorting options for finding specific news articles.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Advanced search results retrieved successfully\",\n \"data\": {\n \"articles\": [\n {\n \"id\": \"uuid\",\n \"title\": \"Understanding Air Quality in Abidjan\",\n \"slug\": \"understanding-air-quality-abidjan\",\n \"excerpt\": \"Comprehensive guide to air quality monitoring...\",\n \"category\": {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": \"Air Quality\"\n },\n \"author\": {\n \"id\": \"uuid\",\n \"name\": \"Dr. Marie Kouadio\",\n \"avatar_url\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"tags\": [\n {\n \"id\": \"uuid\",\n \"name\": \"abidjan\",\n \"display_name\": \"Abidjan\"\n }\n ],\n \"featured_image\": \"https:\/\/example.com\/featured.jpg\",\n \"is_featured\": false,\n \"published_at\": \"2025-08-26T10:00:00Z\",\n \"views_count\": 1250,\n \"likes_count\": 45,\n \"shares_count\": 12,\n \"reading_time_minutes\": 8\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total\": 87,\n \"total_pages\": 5\n },\n \"search_query\": \"air pollution\",\n \"filters_applied\": {\n \"category\": [\"air_quality\", \"health\"],\n \"tags\": [\"abidjan\"],\n \"date_range\": {\n \"start\": \"2025-01-01\",\n \"end\": \"2025-12-31\"\n },\n \"has_air_quality_info\": true,\n \"reading_time\": {\n \"min\": 5,\n \"max\": 15\n }\n },\n \"language\": \"en\"\n }\n}", "name": "Advanced search success" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Invalid filter parameters\",\n \"data\": null\n}", "name": "Invalid filters" } ] } ] }, { "name": "News Categories", "description": "\nAPIs for managing news article categories with multi-language support.", "item": [ { "name": "Get All Categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news-categories", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news-categories?language=en" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all active news categories with multi-language names.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Categories retrieved successfully\",\n \"data\": [\n {\n \"id\": \"uuid\",\n \"key\": \"air_quality\",\n \"name\": \"Air Quality\",\n \"description\": \"Articles about air quality monitoring and improvement\",\n \"color\": \"#007bff\",\n \"icon\": \"air-quality-icon\",\n \"articles_count\": 25\n }\n ]\n}", "name": "Success" } ] }, { "name": "Get Single Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/news-categories\/:key", "query": [ { "key": "language", "value": "en", "description": "Language preference (en or fr).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/news-categories\/:key?language=en", "variable": [ { "id": "key", "key": "key", "value": "air_quality", "description": "Category key." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve a single category by its key.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news-categories", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news-categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"b\",\"name\":{\"en\":\"b\",\"fr\":\"n\"},\"description\":{\"en\":\"g\",\"fr\":\"z\"},\"color\":\"#2815Df\",\"icon\":\"n\",\"is_active\":false,\"sort_order\":5}" }, "description": "Create a new news category." }, "response": [] }, { "name": "Update Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news-categories\/:newsCategory_id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news-categories\/:newsCategory_id", "variable": [ { "id": "newsCategory_id", "key": "newsCategory_id", "value": "architecto", "description": "The ID of the newsCategory." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"b\",\"name\":{\"en\":\"b\",\"fr\":\"n\"},\"description\":{\"en\":\"g\",\"fr\":\"z\"},\"color\":\"#2815Df\",\"icon\":\"n\",\"is_active\":false,\"sort_order\":5}" }, "description": "Update an existing news category." }, "response": [] }, { "name": "Update Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news-categories\/:newsCategory_id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news-categories\/:newsCategory_id", "variable": [ { "id": "newsCategory_id", "key": "newsCategory_id", "value": "architecto", "description": "The ID of the newsCategory." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"b\",\"name\":{\"en\":\"b\",\"fr\":\"n\"},\"description\":{\"en\":\"g\",\"fr\":\"z\"},\"color\":\"#2815Df\",\"icon\":\"n\",\"is_active\":false,\"sort_order\":5}" }, "description": "Update an existing news category." }, "response": [] }, { "name": "Delete Category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news-categories\/:newsCategory_id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news-categories\/:newsCategory_id", "variable": [ { "id": "newsCategory_id", "key": "newsCategory_id", "value": "architecto", "description": "The ID of the newsCategory." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a news category and all its associated data.\nThis will cascade delete all articles, images, interactions, and tags associated with this category." }, "response": [] }, { "name": "Admin Index - Get All Categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/news-categories\/all", "query": [], "raw": "{{baseUrl}}\/api\/admin\/news-categories\/all" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all categories including inactive ones for admin users." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Notifications", "description": "\nManage user notification preferences and view notification history.", "item": [ { "name": "Get notification settings for the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/settings", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves or creates the notification settings for the current user.\nIf settings don't exist, it will create default settings.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update notification settings for the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/settings", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/settings" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email_enabled\":true,\"sms_enabled\":false,\"in_app_enabled\":true,\"email_addresses\":[\"b\"],\"email_address\":\"user@henddu.com\",\"phone_number\":\"+12345678900\",\"quiet_hours_start\":\"08:19\",\"quiet_hours_end\":\"08:19\",\"emergency_override\":false,\"notification_frequency\":\"hourly\",\"digest_enabled\":true,\"digest_schedule\":\"daily\"}" }, "description": "This endpoint updates the notification preferences for the current user.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Create a new notification for a user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications", "query": [], "raw": "{{baseUrl}}\/api\/notifications" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Alert Updated\",\"message\":\"Your alert \\\"Server CPU Usage\\\" has been updated\",\"type\":\"alert_update\",\"channel\":\"in_app\",\"user_id\":\"9ca44a28-824b-45f3-a12b-19df647e07bb\",\"alert_id\":\"9ca44a28-824b-45f3-a12b-19df647e07bb\",\"priority\":\"normal\",\"metadata\":{\"alert_type\":\"threshold\",\"threshold_value\":\"90%\"}}" }, "description": "This endpoint creates a new notification for the specified user or the authenticated user.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get notification history for the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/history", "query": [ { "key": "channel", "value": "email", "description": "Filter by notification channel (email, sms, in_app).", "disabled": false }, { "key": "status", "value": "read", "description": "Filter by notification status (sent, delivered, read, failed).", "disabled": false }, { "key": "alert_id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "Filter by related alert ID.", "disabled": false }, { "key": "date_from", "value": "2025-01-01", "description": "Filter by date sent (from).", "disabled": false }, { "key": "date_to", "value": "2025-01-31", "description": "Filter by date sent (to).", "disabled": false }, { "key": "with", "value": "alert", "description": "Comma-separated list of relationships to include (alert, user).", "disabled": false }, { "key": "per_page", "value": "50", "description": "Number of items per page. Default: 20.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/notifications\/history?channel=email&status=read&alert_id=9ca44a28-824b-45f3-a12b-19df647e07bb&date_from=2025-01-01&date_to=2025-01-31&with=alert&per_page=50" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the notification history for the current user with filtering options.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Mark a notification as read.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/:id\/read", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/:id\/read", "variable": [ { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The ID of the notification." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint marks a specific notification as read for the current user.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Mark all notifications as read.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/read", "query": [ { "key": "channel", "value": "in_app", "description": "Filter by notification channel (email, sms, in_app).", "disabled": false }, { "key": "alert_id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "Filter by related alert ID.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/notifications\/read?channel=in_app&alert_id=9ca44a28-824b-45f3-a12b-19df647e07bb" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint marks all unread notifications as read for the current user.\nThe request can be filtered by channel and alert ID.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get notification statistics.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/statistics", "query": [ { "key": "date_from", "value": "2025-01-01", "description": "Filter by date range (from).", "disabled": false }, { "key": "date_to", "value": "2025-01-31", "description": "Filter by date range (to).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/notifications\/statistics?date_from=2025-01-01&date_to=2025-01-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint provides summary statistics about user notifications.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Pollutants", "description": "\nAPIs to manage pollutants", "item": [ { "name": "Get all pollutants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/pollutants?language=en" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method retrieves all pollutants from the database.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get all WHO thresholds for all pollutants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/who-thresholds", "query": [ { "key": "time_period", "value": "24h", "description": "Filter by time period (1h, 8h, 24h, annual).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/pollutants\/who-thresholds?time_period=24h" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves WHO guideline thresholds for all pollutants in a\nsimplified format optimized for frontend chart rendering.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get a specific pollutant by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:id", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/pollutants\/:id?language=en", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the pollutant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method retrieves the details of a specific pollutant.\nIf the pollutant is not found, a 404 error is returned.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new pollutant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants", "query": [], "raw": "{{baseUrl}}\/api\/pollutants" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Particulate Matter\",\"unit\":\"\u00b5g\\\/m\u00b3\",\"symbol\":\"PM2.5\",\"description\":\"Fine particulate matter with diameter less than 2.5 micrometers\",\"pollutant_type\":\"Particulate\",\"acceptable_range_min\":0,\"acceptable_range_max\":35.4,\"hazardous_threshold\":250.4,\"regulatory_thresholds\":[4326.41688],\"regulatory_authority\":\"m\",\"regulation_effective_date\":\"2026-06-20T08:19:52\",\"regulatory_notes\":\"architecto\",\"translations\":[\"architecto\"]}" }, "description": "This method creates a new pollutant in the database.\nIt also supports storing translations for multi-language support.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update an existing pollutant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the pollutant." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Particulate Matter\",\"unit\":\"\u00b5g\\\/m\u00b3\",\"symbol\":\"PM2.5\",\"description\":\"Fine particulate matter with diameter less than 2.5 micrometers\",\"pollutant_type\":\"Particulate\",\"translations\":[\"architecto\"],\"acceptable_range_min\":0,\"acceptable_range_max\":35.4,\"hazardous_threshold\":250.4}" }, "description": "This method updates the details of an existing pollutant by its ID.\nIt also supports updating translations.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a specific pollutant by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:id", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the pollutant." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method deletes a pollutant from the database by its ID.\nIf the pollutant doesn't exist, a 404 error is returned.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get all stations associated with a specific pollutant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/stations", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/stations", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method retrieves all stations that are linked to a given pollutant.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get all stations of a specific state associated with a specific pollutant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/:stateId\/stations", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/:stateId\/stations", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "" }, { "id": "stateId", "key": "stateId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method retrieves all stations that are linked to a given pollutant.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Associate a pollutant with a station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/stations\/:stationId", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/stations\/:stationId", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "The ID of the pollutant." }, { "id": "stationId", "key": "stationId", "value": "architecto", "description": "The ID of the station." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint allows you to associate a specific pollutant with a specific station.\nThe request requires the IDs of the pollutant and the station. The pollutant will\nbe attached to the station.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove the association of a pollutant from a station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/stations\/:stationId", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/stations\/:stationId", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "16", "description": "The ID of the pollutant." }, { "id": "stationId", "key": "stationId", "value": "16", "description": "The ID of the station." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint allows you to remove an existing association between a pollutant\nand a station. The pollutant will be detached from the station.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get regulatory thresholds for a pollutant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/regulatory-thresholds", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/regulatory-thresholds", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "The ID of the pollutant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all regulatory thresholds for a specific pollutant.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get regulatory thresholds for a specific authority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/regulatory-thresholds\/:authority", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/regulatory-thresholds\/:authority", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "The ID of the pollutant." }, { "id": "authority", "key": "authority", "value": "architecto", "description": "The regulatory authority (e.g., 'EPA', 'WHO')." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the regulatory thresholds for a specific authority and pollutant.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update or add regulatory thresholds for a specific authority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/regulatory-thresholds\/:authority", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/regulatory-thresholds\/:authority", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "The ID of the pollutant." }, { "id": "authority", "key": "authority", "value": "architecto", "description": "The regulatory authority (e.g., 'EPA', 'WHO')." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"thresholds\":\"{\\\"24h\\\": 35.0, \\\"annual\\\": 12.0}\",\"effective_date\":\"2021-09-22\",\"notes\":\"National Ambient Air Quality Standards\"}" }, "description": "This endpoint updates or adds regulatory thresholds for a specific authority and pollutant.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove regulatory thresholds for a specific authority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/pollutants\/:pollutantId\/regulatory-thresholds\/:authority", "query": [], "raw": "{{baseUrl}}\/api\/pollutants\/:pollutantId\/regulatory-thresholds\/:authority", "variable": [ { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "The ID of the pollutant." }, { "id": "authority", "key": "authority", "value": "architecto", "description": "The regulatory authority (e.g., 'EPA', 'WHO')." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint removes the regulatory thresholds for a specific authority from a pollutant.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Quiz Categories", "description": "\nAPIs for managing quiz categories and browsing available quizzes", "item": [ { "name": "Get all quiz categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/categories", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false }, { "key": "difficulty", "value": "beginner", "description": "Filter by difficulty level.", "disabled": false }, { "key": "active", "value": "1", "description": "Show only active categories. Default: true.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/categories?language=en&difficulty=beginner&active=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all available quiz categories with user progress information.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz categories retrieved successfully\",\n \"data\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec175\",\n \"key\": \"air_quality_basics\",\n \"name\": \"Air Quality Basics\",\n \"description\": \"Learn fundamental concepts about air quality monitoring and measurement\",\n \"icon\": \"air-quality\",\n \"difficulty_level\": \"beginner\",\n \"total_questions\": 25,\n \"estimated_time_minutes\": 15,\n \"user_progress\": {\n \"total_sessions\": 3,\n \"best_score\": 85.5,\n \"mastery_level\": \"intermediate\"\n }\n }\n ]\n}", "name": "" } ] }, { "name": "Get specific category details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/categories\/:categoryKey", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/categories\/:categoryKey?language=en", "variable": [ { "id": "categoryKey", "key": "categoryKey", "value": "air_quality_basics", "description": "The category key." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed information about a specific category including available quizzes.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Category details retrieved successfully\",\n \"data\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec175\",\n \"key\": \"air_quality_basics\",\n \"name\": \"Air Quality Basics\",\n \"description\": \"Learn fundamental concepts about air quality monitoring and measurement\",\n \"icon\": \"air-quality\",\n \"difficulty_level\": \"beginner\",\n \"available_quizzes\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": \"Beginner Air Quality Quiz\",\n \"description\": \"Perfect for getting started with air quality concepts\",\n \"difficulty_level\": \"easy\",\n \"question_count\": 10,\n \"time_limit_minutes\": 15,\n \"passing_score_percentage\": 70.0,\n \"user_progress\": {\n \"attempts_count\": 2,\n \"best_score\": 85.0,\n \"is_passed\": true,\n \"last_attempt_at\": \"2025-08-25T14:30:00Z\"\n }\n }\n ]\n }\n}", "name": "" } ] } ] }, { "name": "Quiz Management", "description": "\nAPIs for managing quizzes and quiz details", "item": [ { "name": "Get all quizzes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes", "query": [ { "key": "category_key", "value": "air_quality_basics", "description": "Filter by specific category.", "disabled": false }, { "key": "difficulty_level", "value": "easy", "description": "Filter by difficulty (easy, medium, hard).", "disabled": false }, { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false }, { "key": "active", "value": "1", "description": "Show only active quizzes. Default: true.", "disabled": false }, { "key": "include_progress", "value": "1", "description": "Include user progress data. Default: true.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes?category_key=air_quality_basics&difficulty_level=easy&language=en&active=1&include_progress=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a list of all available quizzes across all categories with filtering options.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quizzes retrieved successfully\",\n \"data\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": \"Beginner Air Quality Quiz\",\n \"description\": \"Perfect for getting started with air quality concepts\",\n \"category\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec175\",\n \"key\": \"air_quality_basics\",\n \"name\": \"Air Quality Basics\",\n \"icon\": \"air-quality\"\n },\n \"difficulty_level\": \"easy\",\n \"question_count\": 10,\n \"time_limit_minutes\": 15,\n \"passing_score_percentage\": 70.0,\n \"is_randomized\": false,\n \"estimated_completion_time\": \"12-15 minutes\",\n \"user_progress\": {\n \"attempts_count\": 2,\n \"best_score\": 85.0,\n \"is_passed\": true,\n \"last_attempt_at\": \"2025-08-25T14:30:00Z\"\n }\n }\n ]\n}", "name": "" } ] }, { "name": "Get quiz details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/:quizId", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/:quizId?language=en", "variable": [ { "id": "quizId", "key": "quizId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The quiz UUID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed information about a specific quiz.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz details retrieved successfully\",\n \"data\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": \"Beginner Air Quality Quiz\",\n \"description\": \"Perfect for getting started with air quality concepts. This quiz covers fundamental concepts including AQI, common pollutants, and basic measurement techniques.\",\n \"category\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec175\",\n \"key\": \"air_quality_basics\",\n \"name\": \"Air Quality Basics\",\n \"description\": \"Learn fundamental concepts about air quality monitoring and measurement\",\n \"icon\": \"air-quality\",\n \"difficulty_level\": \"beginner\"\n },\n \"difficulty_level\": \"easy\",\n \"question_count\": 10,\n \"time_limit_minutes\": 15,\n \"passing_score_percentage\": 70.0,\n \"is_randomized\": false,\n \"topics_covered\": [\n \"Air Quality Index (AQI)\",\n \"Common Pollutants\",\n \"Measurement Methods\",\n \"Basic Health Effects\"\n ],\n \"learning_objectives\": [\n \"Understand what AQI represents\",\n \"Identify major air pollutants\",\n \"Recognize measurement units\"\n ],\n \"prerequisites\": [],\n \"estimated_completion_time\": \"12-15 minutes\",\n \"user_progress\": {\n \"attempts_count\": 2,\n \"best_score\": 85.0,\n \"average_score\": 78.5,\n \"is_passed\": true,\n \"first_attempt_at\": \"2025-08-20T14:00:00Z\",\n \"last_attempt_at\": \"2025-08-25T14:30:00Z\",\n \"improvement_trend\": \"+7.5%\"\n },\n \"quiz_statistics\": {\n \"total_attempts\": 1247,\n \"average_score\": 76.3,\n \"completion_rate\": 89.2,\n \"average_time_minutes\": 13.5\n }\n }\n}", "name": "" } ] }, { "name": "User Progress", "description": "", "item": [ { "name": "Get user quiz progress", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/my\/progress", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/my\/progress?language=en" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get comprehensive progress statistics for the authenticated user across all quizzes." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"User progress retrieved successfully\",\n \"data\": {\n \"overall_stats\": {\n \"total_quizzes_attempted\": 5,\n \"total_quizzes_passed\": 3,\n \"total_points_earned\": 245,\n \"average_score\": 78.5,\n \"completion_rate\": 60.0\n },\n \"quiz_progress\": [\n {\n \"quiz_id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"quiz_title\": \"Beginner Air Quality Quiz\",\n \"category\": \"Air Quality Basics\",\n \"attempts_count\": 2,\n \"best_score_percentage\": 85.0,\n \"average_score\": 72.5,\n \"is_passed\": true,\n \"first_attempt_at\": \"2023-10-01T10:00:00Z\",\n \"last_attempt_at\": \"2023-10-15T14:30:00Z\"\n }\n ]\n }\n}", "name": "" } ] }, { "name": "Get user achievements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/my\/achievements", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/my\/achievements?language=en" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get achievements earned by the user and available achievements with progress." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"User achievements retrieved successfully\",\n \"data\": {\n \"earned_achievements\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"achievement\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"name\": \"First Quiz Completed\",\n \"description\": \"Complete your first quiz\",\n \"icon\": \"trophy\",\n \"points\": 10\n },\n \"earned_at\": \"2023-10-01T10:30:00Z\",\n \"progress_when_earned\": {\n \"quiz_title\": \"Beginner Air Quality Quiz\",\n \"score\": 85.0\n }\n }\n ],\n \"available_achievements\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"name\": \"Perfect Score\",\n \"description\": \"Score 100% on any quiz\",\n \"icon\": \"star\",\n \"points\": 50,\n \"progress\": {\n \"current\": 85,\n \"required\": 100,\n \"percentage\": 85.0\n }\n }\n ],\n \"summary\": {\n \"total_earned\": 3,\n \"total_available\": 12,\n \"total_points\": 95\n }\n }\n}", "name": "" } ] } ] }, { "name": "Leaderboard", "description": "", "item": [ { "name": "Get quiz leaderboard", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/leaderboard", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false }, { "key": "timeframe", "value": "month", "description": "Time period for rankings (week, month, all_time). Default: all_time.", "disabled": false }, { "key": "category", "value": "air_quality_basics", "description": "Filter by category key.", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of top users to return. Default: 50.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/leaderboard?language=en&timeframe=month&category=air_quality_basics&limit=20" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the quiz leaderboard with user rankings based on points and performance." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Leaderboard retrieved successfully\",\n \"data\": {\n \"leaderboard\": [\n {\n \"rank\": 1,\n \"user\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"name\": \"John Doe\",\n \"avatar\": \"https:\/\/example.com\/avatar.jpg\"\n },\n \"total_points\": 450,\n \"quizzes_completed\": 8,\n \"average_score\": 87.5,\n \"achievements_count\": 12\n }\n ],\n \"user_position\": {\n \"rank\": 15,\n \"total_points\": 220,\n \"quizzes_completed\": 4,\n \"average_score\": 78.2\n },\n \"filters\": {\n \"timeframe\": \"all_time\",\n \"category\": \"all\",\n \"limit\": 50\n }\n }\n}", "name": "" } ] } ] }, { "name": "Categories (Admin)", "description": "", "item": [ { "name": "Create a new quiz category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/categories", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/categories" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"air_quality_advanced\",\"name\":{\"en\":\"Advanced Air Quality\",\"fr\":\"Qualit\u00e9 de l'Air Avanc\u00e9e\"},\"description\":{\"en\":\"Advanced concepts in air quality monitoring\",\"fr\":\"Concepts avanc\u00e9s en surveillance de la qualit\u00e9 de l'air\"},\"icon\":\"air-quality-advanced\",\"difficulty_level\":\"advanced\",\"is_active\":true,\"sort_order\":10}" }, "description": "Create a new quiz category. Admin access required." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Quiz category created successfully\",\n \"data\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec178\",\n \"key\": \"air_quality_advanced\",\n \"name\": {\n \"en\": \"Advanced Air Quality\",\n \"fr\": \"Qualit\u00e9 de l'Air Avanc\u00e9e\"\n },\n \"description\": {\n \"en\": \"Advanced concepts in air quality monitoring\",\n \"fr\": \"Concepts avanc\u00e9s en surveillance de la qualit\u00e9 de l'air\"\n },\n \"icon\": \"air-quality-advanced\",\n \"difficulty_level\": \"advanced\",\n \"is_active\": true,\n \"sort_order\": 10,\n \"created_at\": \"2025-08-27T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:00:00.000000Z\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"status\": \"error\",\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"key\": [\"The key field is required.\"],\n \"name.en\": [\"The name.en field is required.\"]\n }\n}", "name": "" } ] }, { "name": "Update quiz category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "9fbbcd8b-cd82-4a29-a77c-06e974cec174", "description": "Category UUID." } ] }, "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"key\":\"air_quality_intermediate\",\"name\":{\"en\":\"Intermediate Air Quality\",\"fr\":\"Qualit\u00e9 de l'Air Interm\u00e9diaire\"},\"description\":{\"en\":\"Intermediate concepts in air quality\",\"fr\":\"Concepts interm\u00e9diaires en qualit\u00e9 de l'air\"},\"icon\":\"air-quality-intermediate\",\"difficulty_level\":\"intermediate\",\"is_active\":true,\"sort_order\":5}" }, "description": "Update an existing quiz category. Admin access required." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz category updated successfully\",\n \"data\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"key\": \"air_quality_intermediate\",\n \"name\": {\n \"en\": \"Intermediate Air Quality\",\n \"fr\": \"Qualit\u00e9 de l'Air Interm\u00e9diaire\"\n },\n \"description\": {\n \"en\": \"Intermediate concepts in air quality\",\n \"fr\": \"Concepts interm\u00e9diaires en qualit\u00e9 de l'air\"\n },\n \"icon\": \"air-quality-intermediate\",\n \"difficulty_level\": \"intermediate\",\n \"is_active\": true,\n \"sort_order\": 5,\n \"created_at\": \"2025-08-27T09:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:30:00.000000Z\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Category not found\",\n \"error_code\": \"CATEGORY_NOT_FOUND\",\n \"data\": null\n}", "name": "" } ] }, { "name": "Delete quiz category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "9fbbcd8b-cd82-4a29-a77c-06e974cec174", "description": "Category UUID." } ] }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an existing quiz category. Admin access required. Category must have no associated quizzes." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz category deleted successfully\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Cannot delete category with existing quizzes\",\n \"data\": {\n \"quiz_count\": 3\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Category not found\",\n \"data\": null\n}", "name": "" } ] } ] }, { "name": "Quizzes (Admin)", "description": "", "item": [ { "name": "Create a new quiz", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quiz_category_id\":\"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\"title\":{\"en\":\"Advanced Air Quality Assessment\",\"fr\":\"\u00c9valuation Avanc\u00e9e de la Qualit\u00e9 de l'Air\"},\"description\":{\"en\":\"Comprehensive assessment of advanced air quality concepts\",\"fr\":\"\u00c9valuation compl\u00e8te des concepts avanc\u00e9s de qualit\u00e9 de l'air\"},\"difficulty_level\":\"hard\",\"question_count\":20,\"time_limit_minutes\":30,\"passing_score_percentage\":80,\"is_randomized\":true,\"is_active\":true}" }, "description": "Create a new quiz within a category. Admin access required." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Quiz created successfully\",\n \"data\": {\n \"id\": \"9fbbce4a-dfda-4656-970f-08e6d7302200\",\n \"quiz_category_id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": {\n \"en\": \"Advanced Air Quality Assessment\",\n \"fr\": \"\u00c9valuation Avanc\u00e9e de la Qualit\u00e9 de l'Air\"\n },\n \"description\": {\n \"en\": \"Comprehensive assessment of advanced air quality concepts\",\n \"fr\": \"\u00c9valuation compl\u00e8te des concepts avanc\u00e9s de qualit\u00e9 de l'air\"\n },\n \"difficulty_level\": \"hard\",\n \"question_count\": 20,\n \"time_limit_minutes\": 30,\n \"passing_score_percentage\": \"80.00\",\n \"is_randomized\": true,\n \"is_active\": true,\n \"created_at\": \"2025-08-27T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:00:00.000000Z\"\n }\n}", "name": "" } ] }, { "name": "Update quiz", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/:id", "variable": [ { "id": "id", "key": "id", "value": "9fbbce4a-dfda-4656-970f-08e6d7302200", "description": "Quiz UUID." } ] }, "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quiz_category_id\":\"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\"title\":{\"en\":\"Updated Air Quality Assessment\",\"fr\":\"\u00c9valuation Actualis\u00e9e de la Qualit\u00e9 de l'Air\"},\"description\":{\"en\":\"Updated comprehensive assessment\",\"fr\":\"\u00c9valuation compl\u00e8te actualis\u00e9e\"},\"difficulty_level\":\"medium\",\"question_count\":15,\"time_limit_minutes\":25,\"passing_score_percentage\":75,\"is_randomized\":false,\"is_active\":true}" }, "description": "Update an existing quiz. Admin access required." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz updated successfully\",\n \"data\": {\n \"id\": \"9fbbce4a-dfda-4656-970f-08e6d7302200\",\n \"quiz_category_id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": {\n \"en\": \"Updated Air Quality Assessment\",\n \"fr\": \"\u00c9valuation Actualis\u00e9e de la Qualit\u00e9 de l'Air\"\n },\n \"description\": {\n \"en\": \"Updated comprehensive assessment\",\n \"fr\": \"\u00c9valuation compl\u00e8te actualis\u00e9e\"\n },\n \"difficulty_level\": \"medium\",\n \"question_count\": 15,\n \"time_limit_minutes\": 25,\n \"passing_score_percentage\": \"75.00\",\n \"is_randomized\": false,\n \"is_active\": true,\n \"created_at\": \"2025-08-27T09:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:30:00.000000Z\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Quiz not found\",\n \"data\": null\n}", "name": "" } ] }, { "name": "Delete quiz", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/:id", "variable": [ { "id": "id", "key": "id", "value": "9fbbce4a-dfda-4656-970f-08e6d7302200", "description": "Quiz UUID." } ] }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an existing quiz. Admin access required. Quiz must have no active sessions." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz deleted successfully\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Cannot delete quiz with active sessions\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Quiz not found\",\n \"data\": null\n}", "name": "" } ] } ] }, { "name": "Get all questions for a quiz", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/:quizId\/questions", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false }, { "key": "include_options", "value": "1", "description": "Include question options. Default: true.", "disabled": false }, { "key": "difficulty", "value": "medium", "description": "Filter by difficulty (easy, medium, hard).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/:quizId\/questions?language=en&include_options=1&difficulty=medium", "variable": [ { "id": "quizId", "key": "quizId", "value": "9fbbcd8b-cd82-4a29-a77c-06e974cec174", "description": "Quiz UUID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a list of all questions for a specific quiz.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz questions retrieved successfully\",\n \"data\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec178\",\n \"question_text\": \"What does PM2.5 stand for?\",\n \"question_type\": \"multiple_choice\",\n \"difficulty_level\": \"medium\",\n \"points\": 15,\n \"time_limit_seconds\": 60,\n \"explanation\": \"PM2.5 refers to particulate matter with diameter less than 2.5 micrometers\",\n \"is_active\": true,\n \"options\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec179\",\n \"option_text\": \"Fine particulate matter\",\n \"is_correct\": true\n }\n ],\n \"created_at\": \"2025-08-27T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:00:00.000000Z\"\n }\n ]\n}", "name": "" } ] }, { "name": "Get a specific question", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/questions\/:id", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false }, { "key": "include_options", "value": "1", "description": "Include question options. Default: true.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/questions\/:id?language=en&include_options=1", "variable": [ { "id": "id", "key": "id", "value": "9fbbcd8b-cd82-4a29-a77c-06e974cec178", "description": "Question UUID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get details of a specific quiz question.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Question retrieved successfully\",\n \"data\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec178\",\n \"question_text\": \"What does PM2.5 stand for?\",\n \"question_type\": \"multiple_choice\",\n \"difficulty_level\": \"medium\",\n \"points\": 15,\n \"time_limit_seconds\": 60,\n \"explanation\": \"PM2.5 refers to particulate matter with diameter less than 2.5 micrometers\",\n \"is_active\": true,\n \"category\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec175\",\n \"key\": \"air_quality_basics\",\n \"name\": \"Air Quality Basics\"\n },\n \"options\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec179\",\n \"option_text\": \"Fine particulate matter\",\n \"is_correct\": true\n }\n ],\n \"created_at\": \"2025-08-27T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:00:00.000000Z\"\n }\n}", "name": "" } ] }, { "name": "Questions (Admin)", "description": "", "item": [ { "name": "Create a new question", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/questions", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/questions" }, "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quiz_category_id\":\"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\"question_text\":{\"en\":\"What is the primary component of PM2.5?\",\"fr\":\"Quel est le composant principal des PM2.5?\"},\"question_type\":\"multiple_choice\",\"difficulty_level\":\"medium\",\"explanation\":{\"en\":\"PM2.5 refers to particulate matter with diameter less than 2.5 micrometers\",\"fr\":\"PM2.5 fait r\u00e9f\u00e9rence aux particules d'un diam\u00e8tre inf\u00e9rieur \u00e0 2,5 microm\u00e8tres\"},\"points\":15,\"time_limit_seconds\":60,\"options\":{\"0\":{\"text\":{\"en\":\"architecto\",\"fr\":\"architecto\"}},\"*\":{\"text\":{\"en\":\"Fine particulate matter\",\"fr\":\"Particules fines\"}}}}" }, "description": "Create a new question that can be used in quizzes. Admin access required." }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Question created successfully\",\n \"data\": {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d05\",\n \"quiz_category_id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"question_text\": {\n \"en\": \"What is the primary component of PM2.5?\",\n \"fr\": \"Quel est le composant principal des PM2.5?\"\n },\n \"question_type\": \"multiple_choice\",\n \"difficulty_level\": \"medium\",\n \"explanation\": {\n \"en\": \"PM2.5 refers to particulate matter with diameter less than 2.5 micrometers\",\n \"fr\": \"PM2.5 fait r\u00e9f\u00e9rence aux particules d'un diam\u00e8tre inf\u00e9rieur \u00e0 2,5 microm\u00e8tres\"\n },\n \"points\": 15,\n \"time_limit_seconds\": 60,\n \"is_active\": true,\n \"created_by_user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"options\": [\n {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d06\",\n \"quiz_question_id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d05\",\n \"option_text\": {\n \"en\": \"Fine particulate matter\",\n \"fr\": \"Particules fines\"\n },\n \"is_correct\": true,\n \"sort_order\": 1\n },\n {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d07\",\n \"quiz_question_id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d05\",\n \"option_text\": {\n \"en\": \"Coarse particles\",\n \"fr\": \"Particules grossi\u00e8res\"\n },\n \"is_correct\": false,\n \"sort_order\": 2\n }\n ],\n \"created_at\": \"2025-08-27T10:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:00:00.000000Z\"\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"At least one option must be marked as correct\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"question_text.en\": [\"The question text.en field is required.\"],\n \"options\": [\"The options field must have at least 2 items.\"]\n }\n}", "name": "" } ] }, { "name": "Update question", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/questions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/questions\/:id", "variable": [ { "id": "id", "key": "id", "value": "9fbbce71-3fe4-4a3d-af52-ce6eda1c3d05", "description": "Question UUID." } ] }, "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"question_text\":{\"en\":\"What is the safe level of PM2.5?\",\"fr\":\"Quel est le niveau s\u00fbr de PM2.5?\"},\"question_type\":\"multiple_choice\",\"difficulty_level\":\"hard\",\"explanation\":{\"en\":\"WHO guidelines recommend PM2.5 levels below 15 \u03bcg\\\/m\u00b3\",\"fr\":\"Les directives de l'OMS recommandent des niveaux de PM2.5 inf\u00e9rieurs \u00e0 15 \u03bcg\\\/m\u00b3\"},\"points\":20,\"time_limit_seconds\":90,\"is_active\":true}" }, "description": "Update an existing question. Admin access required." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Question updated successfully\",\n \"data\": {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d05\",\n \"quiz_category_id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"question_text\": {\n \"en\": \"What is the safe level of PM2.5?\",\n \"fr\": \"Quel est le niveau s\u00fbr de PM2.5?\"\n },\n \"question_type\": \"multiple_choice\",\n \"difficulty_level\": \"hard\",\n \"explanation\": {\n \"en\": \"WHO guidelines recommend PM2.5 levels below 15 \u03bcg\/m\u00b3\",\n \"fr\": \"Les directives de l'OMS recommandent des niveaux de PM2.5 inf\u00e9rieurs \u00e0 15 \u03bcg\/m\u00b3\"\n },\n \"points\": 20,\n \"time_limit_seconds\": 90,\n \"is_active\": true,\n \"created_at\": \"2025-08-27T09:00:00.000000Z\",\n \"updated_at\": \"2025-08-27T10:30:00.000000Z\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Question not found\",\n \"data\": null\n}", "name": "" } ] }, { "name": "Delete question", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/questions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/questions\/:id", "variable": [ { "id": "id", "key": "id", "value": "9fbbce71-3fe4-4a3d-af52-ce6eda1c3d05", "description": "Question UUID." } ] }, "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an existing question. Admin access required." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Question deleted successfully\",\n \"data\": null\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Question not found\",\n \"data\": null\n}", "name": "" } ] } ] }, { "name": "Analytics (Admin)", "description": "", "item": [ { "name": "Get quiz analytics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/admin\/quizzes\/analytics", "query": [], "raw": "{{baseUrl}}\/api\/admin\/quizzes\/analytics" }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get comprehensive analytics data for all quizzes. Admin access required." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Analytics data retrieved successfully\",\n \"data\": {\n \"overview\": {\n \"total_quizzes\": 15,\n \"total_questions\": 150,\n \"total_sessions\": 1250,\n \"completed_sessions\": 950,\n \"completion_rate\": 76.0,\n \"average_score\": 78.5\n },\n \"popular_quizzes\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": \"Beginner Air Quality Quiz\",\n \"sessions_count\": 125,\n \"average_score\": 82.3,\n \"completion_rate\": 89.5\n }\n ],\n \"recent_activity\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec176\",\n \"user\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec177\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"quiz\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": \"Advanced Air Quality Assessment\"\n },\n \"status\": \"completed\",\n \"score\": 85.0,\n \"started_at\": \"2025-08-27T09:30:00.000000Z\",\n \"completed_at\": \"2025-08-27T09:45:00.000000Z\"\n }\n ],\n \"difficulty_distribution\": [\n {\n \"difficulty_level\": \"easy\",\n \"count\": 60\n },\n {\n \"difficulty_level\": \"medium\",\n \"count\": 70\n },\n {\n \"difficulty_level\": \"hard\",\n \"count\": 20\n }\n ],\n \"category_performance\": [\n {\n \"category\": \"Air Quality Basics\",\n \"total_attempts\": 500,\n \"average_score\": 81.2,\n \"completion_rate\": 85.6\n }\n ]\n }\n}", "name": "" } ] } ] } ] }, { "name": "Quiz Sessions", "description": "\nAPIs for managing quiz sessions, answering questions, and tracking progress", "item": [ { "name": "Start a quiz session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/sessions\/start", "query": [], "raw": "{{baseUrl}}\/api\/quizzes\/sessions\/start" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quiz_id\":\"123e4567-e89b-12d3-a456-426614174000\",\"language\":\"en\"}" }, "description": "Start a new quiz session for the authenticated user.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz session started successfully\",\n \"data\": {\n \"quiz_session_id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec179\",\n \"quiz\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec174\",\n \"title\": \"Beginner Air Quality Quiz\",\n \"category\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec175\",\n \"key\": \"air_quality_basics\",\n \"name\": \"Air Quality Basics\"\n },\n \"difficulty_level\": \"easy\",\n \"question_count\": 10,\n \"time_limit_minutes\": 15,\n \"passing_score_percentage\": 70.0\n },\n \"session_info\": {\n \"current_question\": 1,\n \"total_questions\": 10,\n \"time_remaining_seconds\": 900,\n \"started_at\": \"2025-08-26T10:00:00Z\"\n }\n }\n}", "name": "" } ] }, { "name": "Get current question", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/sessions\/:sessionId\/question", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/sessions\/:sessionId\/question?language=en", "variable": [ { "id": "sessionId", "key": "sessionId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The quiz session UUID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the current question for an active quiz session.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Question retrieved successfully\",\n \"data\": {\n \"question\": {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d05\",\n \"question_text\": \"What is the primary cause of ground-level ozone formation?\",\n \"question_type\": \"multiple_choice\",\n \"difficulty_level\": \"medium\",\n \"points\": 15,\n \"time_limit_seconds\": 60,\n \"options\": [\n {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d06\",\n \"option_text\": \"Direct emissions from vehicles\"\n },\n {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d07\",\n \"option_text\": \"Chemical reactions between NOx and VOCs in sunlight\"\n }\n ]\n },\n \"session_info\": {\n \"current_question\": 3,\n \"total_questions\": 10,\n \"time_remaining_seconds\": 840,\n \"current_score\": 25\n }\n }\n}", "name": "" } ] }, { "name": "Submit answer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/sessions\/:sessionId\/answer", "query": [], "raw": "{{baseUrl}}\/api\/quizzes\/sessions\/:sessionId\/answer", "variable": [ { "id": "sessionId", "key": "sessionId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The quiz session UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"quiz_question_option_id\":\"123e4567-e89b-12d3-a456-426614174000\",\"time_taken_seconds\":45,\"language\":\"en\"}" }, "description": "Submit an answer for the current question in a quiz session.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Answer submitted successfully\",\n \"data\": {\n \"is_correct\": true,\n \"points_earned\": 15,\n \"user_selected_option\": {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d07\",\n \"option_text\": \"Chemical reactions between NOx and VOCs in sunlight\"\n },\n \"correct_option\": {\n \"id\": \"9fbbce71-3fe4-4a3d-af52-ce6eda1c3d07\",\n \"option_text\": \"Chemical reactions between NOx and VOCs in sunlight\"\n },\n \"explanation\": \"Ground-level ozone forms when nitrogen oxides (NOx) and volatile organic compounds (VOCs) react in the presence of sunlight. This is why ozone levels are typically highest during sunny, hot days.\",\n \"session_progress\": {\n \"current_question\": 4,\n \"total_questions\": 10,\n \"correct_answers\": 3,\n \"total_points\": 40,\n \"current_percentage\": 75.0\n },\n \"next_question_available\": true\n }\n}", "name": "" } ] }, { "name": "Results", "description": "", "item": [ { "name": "Get quiz session results", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/sessions\/:sessionId\/results", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/sessions\/:sessionId\/results?language=en", "variable": [ { "id": "sessionId", "key": "sessionId", "value": "9fbbcd8b-cd82-4a29-a77c-06e974cec179", "description": "Quiz session UUID." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer your-token-here" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get comprehensive results for a completed quiz session." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Quiz results retrieved successfully\",\n \"data\": {\n \"session_summary\": {\n \"quiz_session_id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec179\",\n \"quiz_title\": \"Beginner Air Quality Quiz\",\n \"category\": \"Air Quality Basics\",\n \"status\": \"completed\",\n \"started_at\": \"2023-10-01T10:00:00Z\",\n \"completed_at\": \"2023-10-01T10:08:30Z\",\n \"completion_time\": \"8 minutes 30 seconds\"\n },\n \"score_summary\": {\n \"total_points\": 25,\n \"max_possible_points\": 30,\n \"percentage_score\": 83.33,\n \"passing_score\": 70.0,\n \"is_passed\": true,\n \"correct_answers\": 5,\n \"total_questions\": 6\n },\n \"question_results\": [\n {\n \"question_number\": 1,\n \"question_text\": \"What does AQI stand for?\",\n \"user_answer\": \"Air Quality Index\",\n \"correct_answer\": \"Air Quality Index\",\n \"is_correct\": true,\n \"points_earned\": 5,\n \"time_taken\": \"15 seconds\",\n \"explanation\": \"AQI stands for Air Quality Index...\"\n }\n ],\n \"performance_insights\": {\n \"strength_areas\": [\"Basic Concepts\", \"Measurement Units\"],\n \"improvement_areas\": [\"Advanced Topics\"],\n \"time_efficiency\": \"good\",\n \"accuracy_rate\": 83.33\n }\n }\n}", "name": "" } ] } ] }, { "name": "Get user quiz sessions with pagination support.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/my\/sessions", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of sessions per page. Default: 10.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/my\/sessions?language=en&per_page=20" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"User sessions retrieved successfully\",\n \"data\": {\n \"sessions\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"quiz\": {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"title\": \"Beginner Air Quality Quiz\",\n \"category\": \"Air Quality Basics\"\n },\n \"status\": \"completed\",\n \"started_at\": \"2023-10-01T10:00:00Z\",\n \"completed_at\": \"2023-10-01T10:08:30Z\",\n \"completion_time\": \"8 minutes 30 seconds\",\n \"percentage_score\": 85.0,\n \"total_points\": 85,\n \"correct_answers\": 8,\n \"total_questions\": 10,\n \"is_passed\": true\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"total_pages\": 3,\n \"per_page\": 10,\n \"total_items\": 25\n }\n }\n}", "name": "" } ] }, { "name": "Get all available quiz achievements with localized names and descriptions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/quizzes\/achievements", "query": [ { "key": "language", "value": "en", "description": "Language preference (en\/fr). Default: en.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/quizzes\/achievements?language=en" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Achievements retrieved successfully\",\n \"data\": [\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"name\": \"First Quiz Completed\",\n \"description\": \"Complete your first quiz\",\n \"icon\": \"trophy\",\n \"achievement_type\": \"quiz_completion\",\n \"points\": 10,\n \"criteria\": {\n \"quizzes_required\": 1\n },\n \"rarity\": \"common\"\n },\n {\n \"id\": \"9fbbcd8b-cd82-4a29-a77c-06e974cec180\",\n \"name\": \"Perfect Score\",\n \"description\": \"Score 100% on any quiz\",\n \"icon\": \"star\",\n \"achievement_type\": \"score_threshold\",\n \"points\": 50,\n \"criteria\": {\n \"score_required\": 100\n },\n \"rarity\": \"legendary\"\n }\n ]\n}", "name": "" } ] } ] }, { "name": "Region Management", "description": "\nAPIs to manage regions.", "item": [ { "name": "Display a list of all regions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/regions", "query": [], "raw": "{{baseUrl}}\/api\/regions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves and returns all regions from the database.\nIt can be used to get an overview of the existing regions.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show a specific region.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/regions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/regions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the region." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific region based on the provided region ID.\nIf the region does not exist, it will return a 404 error.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store a new region.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/regions", "query": [], "raw": "{{baseUrl}}\/api\/regions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"translations\":\"architecto\",\"flag\":true,\"wikiDataId\":\"n\"}" }, "description": "This endpoint creates a new region in the database. The request must include the\n'name' of the region and optionally, a 'translations' field for the region's name\nin different languages.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update a specific region.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/regions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/regions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the region." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"translations\":\"architecto\",\"flag\":false,\"wikiDataId\":\"n\"}" }, "description": "This endpoint allows updating the details of an existing region. Only the fields\nprovided in the request will be updated (e.g., 'name' or 'translations').", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a specific region.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/regions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/regions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the region." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a region from the database based on the provided region ID.\nIf the region does not exist, it will return a 404 error.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Reports", "description": "\nEndpoints for fetching air quality reports.", "item": [ { "name": "Retrieve air quality data for the last 1 day.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/last-one-day\/:station_id", "query": [ { "key": "include", "value": "architecto", "description": "optional Include hourly data. Use 'hourly' to include hourly concentrations and meteorological data.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/last-one-day\/:station_id?include=architecto", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "uuid required The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve air quality data for the last 7 days.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/last-seven-days\/:station_id", "query": [ { "key": "include", "value": "architecto", "description": "optional Include hourly data. Use 'hourly' to include hourly concentrations and meteorological data.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/last-seven-days\/:station_id?include=architecto", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "uuid required The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve air quality data for the last 1 month.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/last-one-month\/:station_id", "query": [ { "key": "include", "value": "architecto", "description": "optional Include hourly data. Use 'hourly' to include hourly concentrations and meteorological data.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/last-one-month\/:station_id?include=architecto", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "uuid required The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve air quality data for the last 1 year.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/last-one-year\/:station_id", "query": [ { "key": "include", "value": "architecto", "description": "optional Include hourly data. Use 'hourly' to include hourly concentrations and meteorological data.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/last-one-year\/:station_id?include=architecto", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "uuid required The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve air quality data for a Specific Year.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/annual-air-quality-calendar\/:station_id\/:year", "query": [], "raw": "{{baseUrl}}\/api\/reports\/annual-air-quality-calendar\/:station_id\/:year", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "The UUID of the station." }, { "id": "year", "key": "year", "value": "2025", "description": "The year for which to retrieve data." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get pollutant-wise AQI category days count for a specific year and category.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/stations\/:station_id\/aqi-category-days\/:year\/:category", "query": [], "raw": "{{baseUrl}}\/api\/reports\/stations\/:station_id\/aqi-category-days\/:year\/:category", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "The UUID of the station." }, { "id": "year", "key": "year", "value": "2025", "description": "The year for which to retrieve data." }, { "id": "category", "key": "category", "value": "Moderate", "description": "The AQI category to filter by. Must be one of: Good, Moderate, Unhealthy for Sensitive Groups, Unhealthy, Very Unhealthy, Hazardous." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve air quality data for a custom date range.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/custom-date-range\/:station_id\/:start_date\/:end_date", "query": [ { "key": "include", "value": "architecto", "description": "optional Include hourly data. Use 'hourly' to include hourly concentrations and meteorological data.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/reports\/custom-date-range\/:station_id\/:start_date\/:end_date?include=architecto", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "The UUID of the station." }, { "id": "start_date", "key": "start_date", "value": "2025-01-20", "description": "The start date in YYYY-MM-DD custom interval (ISO-8601 format)." }, { "id": "end_date", "key": "end_date", "value": "2025-01-29", "description": "The end date in YYYY-MM-DD custom interval (ISO-8601 format)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2022-07-14\",\"end_date\":\"2052-07-13\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get last 6 periodic air quality data for a specific all stations.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/top-stations", "query": [], "raw": "{{baseUrl}}\/api\/reports\/top-stations", "variable": [ { "id": "time_range", "key": "time_range", "value": "month", "description": "The time range for the report. Must be one of `day`, `week`, `month`, `year`, or `custom`." }, { "id": "start_date", "key": "start_date", "value": "2025-06-01", "description": "required_if:time_range,custom The start date for the custom range (YYYY-MM-DD format). Required when `time_range` is `custom`." }, { "id": "end_date", "key": "end_date", "value": "2025-06-31", "description": "required_if:time_range,custom The end date for the custom range (YYYY-MM-DD format). Must be the same or after `start_date`." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"time_range\":\"day\",\"start_date\":\"2026-06-20T08:19:51\",\"end_date\":\"2052-07-13\",\"page\":22,\"per_page\":7,\"include_concentrations\":true,\"include_meteorological\":true,\"min_aqi\":12,\"max_aqi\":77,\"category\":\"architecto\"}" }, "description": "Retrieves the best and worst air quality stations based on the specified time range.\nSupports predefined time ranges (`day`, `week`, `month`, `year`) as well as a custom range.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get daily profile for a station and pollutant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/daily-profile\/:station_id\/:start_date\/:end_date\/:pollutant", "query": [], "raw": "{{baseUrl}}\/api\/reports\/daily-profile\/:station_id\/:start_date\/:end_date\/:pollutant", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "The UUID of the station." }, { "id": "start_date", "key": "start_date", "value": "2025-02-20", "description": "The start date in YYYY-MM-DD custom interval (ISO-8601 format)." }, { "id": "end_date", "key": "end_date", "value": "2025-02-28", "description": "The end date in YYYY-MM-DD custom interval (ISO-8601 format)." }, { "id": "pollutant", "key": "pollutant", "value": "O3", "description": "The pollutant symbol." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2022-07-14\",\"end_date\":\"2052-07-13\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get meteorological analysis report details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/meteorological-analysis\/:station_id\/:time_range\/:start_date\/:end_date", "query": [], "raw": "{{baseUrl}}\/api\/reports\/meteorological-analysis\/:station_id\/:time_range\/:start_date\/:end_date", "variable": [ { "id": "station_id", "key": "station_id", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "The UUID of the station." }, { "id": "time_range", "key": "time_range", "value": "custom", "description": "The time range for the report. Must be one of (day, week, month, year, or custom)." }, { "id": "start_date", "key": "start_date", "value": "2025-01-20", "description": "optional The start date in YYYY-MM-DD custom interval (ISO-8601 format)." }, { "id": "end_date", "key": "end_date", "value": "2025-02-29", "description": "optional The end date in YYYY-MM-DD custom interval (ISO-8601 format)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Seasonal Analysis", "description": "", "item": [ { "name": "Get states available for seasonal analysis.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/seasonal-analysis\/states", "query": [], "raw": "{{baseUrl}}\/api\/reports\/seasonal-analysis\/states" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get stations by state and optional station types.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/seasonal-analysis\/states\/:state_id\/stations", "query": [ { "key": "station_types", "value": "industrial%2Curban", "description": "optional Comma-separated station types to filter by.", "disabled": false }, { "key": "include_all_types", "value": "", "description": "optional Include all station types.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/reports\/seasonal-analysis\/states\/:state_id\/stations?station_types=industrial%2Curban&include_all_types=", "variable": [ { "id": "state_id", "key": "state_id", "value": "2634", "description": "The ID of the state." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Generate seasonal analysis report.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/seasonal-analysis", "query": [], "raw": "{{baseUrl}}\/api\/reports\/seasonal-analysis" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"state_id\":2634,\"station_ids\":[\"03c1d280-c8d8-4c5c-87c8-3a4ff601c694\"],\"date_range\":{\"start_date\":\"2025-01-01\",\"end_date\":\"2025-12-31\"},\"seasons\":[\"dry_season\",\"rainy_season\"],\"year\":2024,\"station_types\":[\"urban\",\"industrial\"],\"pollutants\":[\"PM2.5\",\"PM10\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Seasonal analysis completed successfully.\",\n \"data\": {\n \"analysis_metadata\": {...},\n \"seasonal_analysis\": {...},\n \"daily_profiles\": {\n \"PM2.5\": {\n \"pollutant_info\": {...},\n \"temporal_patterns\": {\n \"hourly\": [...],\n \"daily\": [...],\n \"monthly\": [...]\n },\n \"statistical_summary\": {...},\n \"weekend_vs_weekday\": {...},\n \"station_contributions\": [...]\n }\n },\n \"station_details\": [...],\n \"comparative_analysis\": [...],\n \"recommendations\": [...]\n }\n}", "name": "" } ] } ] }, { "name": "States", "description": "\nManage states including their creation, updates, and retrieval.", "item": [ { "name": "Display a list of states.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states", "query": [], "raw": "{{baseUrl}}\/api\/states" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show a specific state.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states\/:id", "query": [], "raw": "{{baseUrl}}\/api\/states\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the state." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store a new state.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states", "query": [], "raw": "{{baseUrl}}\/api\/states" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Texas\",\"country_id\":1,\"country_code\":\"ng\",\"fips_code\":\"z\",\"iso2\":\"m\",\"type\":\"i\",\"level\":16,\"parent_id\":16,\"latitude\":31.9686,\"longitude\":-99.9018,\"flag\":false,\"wikiDataId\":\"z\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update a specific state.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states\/:id", "query": [], "raw": "{{baseUrl}}\/api\/states\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the state." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Texas\",\"country_id\":1,\"country_code\":\"ng\",\"fips_code\":\"z\",\"iso2\":\"m\",\"type\":\"i\",\"level\":16,\"parent_id\":16,\"latitude\":31.9686,\"longitude\":-99.9018,\"flag\":true,\"wikiDataId\":\"z\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a specific state.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states\/:id", "query": [], "raw": "{{baseUrl}}\/api\/states\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the state." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Retrieve states by the given country ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states\/countries\/:country_id", "query": [], "raw": "{{baseUrl}}\/api\/states\/countries\/:country_id", "variable": [ { "id": "country_id", "key": "country_id", "value": "1", "description": "The ID of the country." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve states by the given region ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/states\/regions\/:region_id", "query": [], "raw": "{{baseUrl}}\/api\/states\/regions\/:region_id", "variable": [ { "id": "region_id", "key": "region_id", "value": "1", "description": "The ID of the region." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Station Calibration", "description": "\nEndpoints for managing station calibration processes, including creating calibration records,\ncollecting measurements, calculating calibration parameters, and validating results.", "item": [ { "name": "Get All Calibrations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations", "query": [ { "key": "status", "value": "completed", "description": "Filter by calibration status.", "disabled": false }, { "key": "method", "value": "collocation-reference", "description": "Filter by calibration method (collocation-reference or collocation-peer).", "disabled": false }, { "key": "start_date", "value": "2025-01-01", "description": "Filter by calibration date (from).", "disabled": false }, { "key": "end_date", "value": "2025-05-15", "description": "date Filter by calibration date (to).", "disabled": false }, { "key": "limit", "value": "20", "description": "Number of results per page. Default: 15.", "disabled": false }, { "key": "page", "value": "2", "description": "The page number. Default: 1.", "disabled": false }, { "key": "include", "value": "station%2CreferenceStation", "description": "Comma-separated list of relationships to include.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/calibrations?status=completed&method=collocation-reference&start_date=2025-01-01&end_date=2025-05-15&limit=20&page=2&include=station%2CreferenceStation" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"skipped\",\"method\":\"collocation-peer\",\"start_date\":\"2026-06-20T08:19:52\",\"end_date\":\"2052-07-13\",\"limit\":22}" }, "description": "Returns all calibrations across all stations with pagination and filtering.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create Calibration Record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations", "query": [], "raw": "{{baseUrl}}\/api\/calibrations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_id\":\"03c1d280-c8d8-4c5c-87c8-3a4ff601c694\",\"reference_station_id\":\"259a5821-6eb9-4a7a-8350-762ff4e767fa\",\"calibration_date\":\"2025-05-15T10:00:00Z\",\"next_calibration_due\":\"2025-08-15T10:00:00Z\",\"status\":\"failed\",\"calibration_method\":\"collocation-reference\",\"duration_hours\":72,\"environmental_conditions\":{\"temperature\":25,\"humidity\":60,\"pressure\":1013},\"comment\":\"architecto\"}" }, "description": "Creates a new calibration record for a station and updates the station's calibration dates.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get Station Calibration Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:stationId\/status", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:stationId\/status", "variable": [ { "id": "stationId", "key": "stationId", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves calibration status information for a station, including last calibration date and next due date.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Find Collocation Candidates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:stationId\/candidates", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:stationId\/candidates", "variable": [ { "id": "stationId", "key": "stationId", "value": "03c1d280-c8d8-4c5c-87c8-3a4ff601c694", "description": "The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Finds suitable stations for collocation calibration based on proximity and monitored pollutants.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show Calibration Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:calibrationId", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:calibrationId", "variable": [ { "id": "calibrationId", "key": "calibrationId", "value": "259a5821-6eb9-4a7a-8350-762ff4e767fa", "description": "The UUID of the calibration record." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves detailed information about a specific calibration record, including results.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Add Collocation Measurements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:calibrationId\/measurements", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:calibrationId\/measurements", "variable": [ { "id": "calibrationId", "key": "calibrationId", "value": "259a5821-6eb9-4a7a-8350-762ff4e767fa", "description": "The UUID of the calibration record." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_id\":\"4c67dabb-09e1-4deb-ad34-252008f9c56c\",\"measurements\":[{\"timestamp\":\"2025-05-15T13:30:00Z\",\"reference_value\":35.7,\"target_value\":42.3,\"temperature\":24.5,\"humidity\":65.2}]}" }, "description": "Stores measurement data collected during a collocation calibration for a specific pollutant.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Calculate Calibration Parameters", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:calibrationId\/calculate", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:calibrationId\/calculate", "variable": [ { "id": "calibrationId", "key": "calibrationId", "value": "259a5821-6eb9-4a7a-8350-762ff4e767fa", "description": "The UUID of the calibration record." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_id\":\"4c67dabb-09e1-4deb-ad34-252008f9c56c\"}" }, "description": "Analyzes measurement data and calculates calibration parameters (slope, intercept, R\u00b2) for a specific pollutant.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Validate Calibration Model", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:calibrationId\/validate", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:calibrationId\/validate", "variable": [ { "id": "calibrationId", "key": "calibrationId", "value": "259a5821-6eb9-4a7a-8350-762ff4e767fa", "description": "The UUID of the calibration record." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_id\":\"7bad1c8f-c1c2-4e32-b229-83b35dcc1db5\",\"comment\":\"\\\"Collocation with reference station successfully done with good results.\\\"\"}" }, "description": "Tests the calibration model by computing quality metrics and validating against acceptance thresholds.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Complete Calibration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:calibrationId\/complete", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:calibrationId\/complete", "variable": [ { "id": "calibrationId", "key": "calibrationId", "value": "259a5821-6eb9-4a7a-8350-762ff4e767fa", "description": "The UUID of the calibration record." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Finalizes the calibration process, marks it as completed, and updates the station's calibration dates.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Generate Collocation Measurements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:calibrationId\/generate-from-measures", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:calibrationId\/generate-from-measures", "variable": [ { "id": "calibrationId", "key": "calibrationId", "value": "259a5821-6eb9-4a7a-8350-762ff4e767fa", "description": "The UUID of the calibration record." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_ids\":[\"39e6e068-ce8d-4316-9c12-3a923ec0a930\",\"7bad1c8f-c1c2-4e32-b229-83b35dcc1db5\"],\"start_time\":\"2025-05-10T00:00:00Z\",\"end_time\":\"2025-05-15T00:00:00Z\",\"max_time_difference\":10}" }, "description": "Creates collocation measurements from existing station measures by matching data points between the target and reference stations.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete Calibration Record", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/calibrations\/:calibrationId", "query": [], "raw": "{{baseUrl}}\/api\/calibrations\/:calibrationId", "variable": [ { "id": "calibrationId", "key": "calibrationId", "value": "259a5821-6eb9-4a7a-8350-762ff4e767fa", "description": "The UUID of the calibration record to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes a calibration record and all associated data including collocation measurements and calibration results.\nThis action cannot be undone.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Station Image Management", "description": "\nEnhanced endpoints for station image upload and management", "item": [ { "name": "Upload Station Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:station_id\/images\/upload", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:station_id\/images\/upload", "variable": [ { "id": "station_id", "key": "station_id", "value": "3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb", "description": "The UUID of the station." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"image_url\":\"http:\\\/\\\/localhost:8000\\\/img\\\/clarity.png\"}" }, "description": "Upload an image for a station. Supports both file uploads and URL strings.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Station image updated successfully\",\n \"data\": {\n \"station_id\": \"3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb\",\n \"image_url\": \"http:\/\/localhost:8000\/storage\/station-photos\/station_2025-10-19_15-55-30_abc12345.png\",\n \"previous_image\": \"http:\/\/localhost:8000\/img\/clarity.png\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"image\": [\"The image must be less than 10MB.\"]\n }\n}", "name": "" } ] }, { "name": "Remove Station Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:station_id\/images\/remove", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:station_id\/images\/remove", "variable": [ { "id": "station_id", "key": "station_id", "value": "3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb", "description": "The UUID of the station." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"use_default\":true}" }, "description": "Remove the current image from a station and optionally set to default.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Station image removed successfully\",\n \"data\": {\n \"station_id\": \"3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb\",\n \"image_url\": null,\n \"removed_image\": \"http:\/\/localhost:8000\/storage\/station-photos\/station_2025-10-19_15-55-30_abc12345.png\"\n }\n}", "name": "" } ] }, { "name": "Set Default Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:station_id\/images\/default", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:station_id\/images\/default", "variable": [ { "id": "station_id", "key": "station_id", "value": "3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb", "description": "The UUID of the station." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Set a station's image to the default clarity.png image.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Station image set to default\",\n \"data\": {\n \"station_id\": \"3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb\",\n \"image_url\": \"http:\/\/localhost:8000\/img\/clarity.png\",\n \"previous_image\": null\n }\n}", "name": "" } ] }, { "name": "Get Image Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:station_id\/images\/config", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:station_id\/images\/config", "variable": [ { "id": "station_id", "key": "station_id", "value": "architecto", "description": "The ID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get image upload configuration and capabilities.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"enabled\": true,\n \"max_size_mb\": 10,\n \"allowed_extensions\": [\"jpg\", \"jpeg\", \"png\", \"webp\"],\n \"default_image\": \"http:\/\/localhost:8000\/img\/clarity.png\",\n \"upload_formats\": {\n \"file_upload\": \"Use multipart\/form-data with 'image' field\",\n \"url_string\": \"Provide image URL as string in JSON\"\n }\n }\n}", "name": "" } ] }, { "name": "Batch Set Default Images", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/images\/batch-default", "query": [], "raw": "{{baseUrl}}\/api\/stations\/images\/batch-default" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_ids\":[\"3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb\",\"86c0c9d7-0f4c-4bcb-a851-79576ecfaaa8\"]}" }, "description": "Set default clarity.png image for multiple stations at once.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Default images set for 2 stations\",\n \"data\": {\n \"updated_stations\": [\n {\n \"station_id\": \"3bf7197d-bd6c-49a2-82ec-8e362bf3cfeb\",\n \"station_name\": \"UNEP West Africa Office\",\n \"image_url\": \"http:\/\/localhost:8000\/img\/clarity.png\"\n }\n ],\n \"errors\": []\n }\n}", "name": "" } ] }, { "name": "Get Image Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/images\/config", "query": [], "raw": "{{baseUrl}}\/api\/stations\/images\/config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get image upload configuration and capabilities.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"enabled\": true,\n \"max_size_mb\": 10,\n \"allowed_extensions\": [\"jpg\", \"jpeg\", \"png\", \"webp\"],\n \"default_image\": \"http:\/\/localhost:8000\/img\/clarity.png\",\n \"upload_formats\": {\n \"file_upload\": \"Use multipart\/form-data with 'image' field\",\n \"url_string\": \"Provide image URL as string in JSON\"\n }\n }\n}", "name": "" } ] } ] }, { "name": "Station Management", "description": "\nAPIs for unified station and sensor management", "item": [ { "name": "Register a single station with provider integration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/register", "query": [], "raw": "{{baseUrl}}\/api\/stations\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station\":{\"name\":\"Central Park Air Monitor\",\"latitude\":40.7829,\"longitude\":-73.9654,\"city_id\":1,\"tenant_id\":1,\"manufacturer_id\":1,\"image\":\"architecto\"},\"provider\":{\"type\":\"iqair\",\"device_id\":\"device_001\",\"api_key\":\"architecto\",\"config\":[]},\"options\":{\"import_data\":true}}" }, "description": "Creates a new station with its associated provider integration in a single transaction.\nThis endpoint validates station data, provider configuration, and optionally uploads images.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Station registered successfully\",\n \"data\": {\n \"station\": {\n \"id\": 1,\n \"name\": \"Central Park Air Monitor\",\n \"latitude\": 40.7829,\n \"longitude\": -73.9654,\n \"city_id\": 1,\n \"tenant_id\": 1,\n \"manufacturer_id\": 1,\n \"created_at\": \"2025-10-19T10:00:00.000000Z\",\n \"updated_at\": \"2025-10-19T10:00:00.000000Z\"\n },\n \"provider_integration\": {\n \"id\": 1,\n \"station_id\": 1,\n \"provider_type\": \"iqair\",\n \"device_id\": \"device_001\",\n \"is_active\": true,\n \"created_at\": \"2025-10-19T10:00:00.000000Z\",\n \"updated_at\": \"2025-10-19T10:00:00.000000Z\"\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"station.name\": [\"The station name field is required.\"],\n \"provider.type\": [\"The provider type field is required.\"]\n }\n}", "name": "" } ] }, { "name": "Register multiple stations in batch", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/batch-register", "query": [], "raw": "{{baseUrl}}\/api\/stations\/batch-register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"stations\":[\"architecto\"],\"options\":{\"continue_on_error\":true,\"import_data\":false}}" }, "description": "Creates multiple stations with their provider integrations in a single batch operation.\nAll registrations are processed in individual transactions with rollback support.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Batch registration completed\",\n \"data\": {\n \"total\": 3,\n \"successful\": 2,\n \"failed\": 1,\n \"results\": [\n {\n \"success\": true,\n \"data\": {\n \"station\": {...},\n \"provider_integration\": {...}\n }\n },\n {\n \"success\": false,\n \"error\": \"Validation failed for station name\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Batch validation failed\",\n \"errors\": {\n \"stations\": [\"The stations field is required.\"]\n }\n}", "name": "" } ] }, { "name": "Get available providers and their templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/providers", "query": [], "raw": "{{baseUrl}}\/api\/stations\/providers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves all supported sensor providers with their configuration templates,\nsupported pollutants, and integration requirements.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"supported_providers\": [\"iqair\", \"clarity\", \"henddu\"],\n \"provider_templates\": {\n \"iqair\": {\n \"name\": \"IQAir\",\n \"description\": \"IQAir sensor network integration\",\n \"required_fields\": [\"device_id\"],\n \"optional_fields\": [\"api_key\"],\n \"supported_pollutants\": [\"PM2.5\", \"PM10\", \"NO2\", \"O3\"],\n \"data_frequency\": \"hourly\",\n \"requires_api_key\": false\n },\n \"clarity\": {\n \"name\": \"Clarity Movement\",\n \"description\": \"Clarity sensor network integration\",\n \"required_fields\": [\"device_id\", \"api_key\"],\n \"optional_fields\": [\"location_id\"],\n \"supported_pollutants\": [\"PM2.5\", \"PM10\", \"NO2\"],\n \"data_frequency\": \"15min\",\n \"requires_api_key\": true\n },\n \"henddu\": {\n \"name\": \"Henddu Development\",\n \"description\": \"Henddu internal testing and development sensor integration\",\n \"required_fields\": [\"device_id\"],\n \"optional_fields\": [\"config\"],\n \"supported_pollutants\": \"configurable\",\n \"data_frequency\": \"configurable\",\n \"requires_api_key\": false\n }\n }\n }\n}", "name": "" } ] }, { "name": "Get provider-specific template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/providers\/:provider\/template", "query": [], "raw": "{{baseUrl}}\/api\/stations\/providers\/:provider\/template", "variable": [ { "id": "provider", "key": "provider", "value": "iqair", "description": "The provider name (iqair, clarity, henddu)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the configuration template and requirements for a specific sensor provider,\nincluding required fields, supported pollutants, and validation rules.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": {\n \"provider\": \"iqair\",\n \"template\": {\n \"name\": \"IQAir\",\n \"description\": \"IQAir sensor network integration\",\n \"required_fields\": [\"device_id\"],\n \"optional_fields\": [\"api_key\"],\n \"supported_pollutants\": [\"PM2.5\", \"PM10\", \"NO2\", \"O3\"],\n \"data_frequency\": \"hourly\",\n \"requires_api_key\": false,\n \"validation_rules\": {\n \"device_id\": {\n \"type\": \"string\",\n \"pattern\": \"^[A-Za-z0-9_-]+$\",\n \"max_length\": 100\n }\n },\n \"example_config\": {\n \"device_id\": \"iqair_sensor_001\"\n }\n }\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Provider 'unknown_provider' not supported\"\n}", "name": "" } ] }, { "name": "Get device creation configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/config", "query": [], "raw": "{{baseUrl}}\/api\/stations\/config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the complete device creation configuration.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get validation rules", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/config\/validation", "query": [], "raw": "{{baseUrl}}\/api\/stations\/config\/validation" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the validation rules for station and provider data.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Test validation endpoint", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/config\/validate", "query": [], "raw": "{{baseUrl}}\/api\/stations\/config\/validate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station\":{\"name\":\"Test Station\",\"latitude\":40.7829,\"longitude\":-73.9654},\"provider\":{\"type\":\"iqair\",\"device_id\":\"test_device_001\"},\"batch\":[\"architecto\"]}" }, "description": "Validates station and provider data without creating any records.\nUseful for testing data before submission and getting validation feedback.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Validation completed successfully\",\n \"data\": {\n \"station\": {\n \"valid\": true,\n \"validated_data\": {\n \"name\": \"Test Station\",\n \"latitude\": 40.7829,\n \"longitude\": -73.9654\n }\n },\n \"provider\": {\n \"valid\": true,\n \"validated_data\": {\n \"type\": \"iqair\",\n \"device_id\": \"test_device_001\"\n }\n }\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"data\": {\n \"station\": {\n \"valid\": false,\n \"errors\": {\n \"latitude\": [\"The latitude must be between -90 and 90.\"]\n }\n }\n }\n}", "name": "" } ] }, { "name": "List all stations with filtering and optional pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations", "query": [ { "key": "provider_type", "value": "iqair", "description": "Filter by provider type (iqair, clarity, henddu).", "disabled": false }, { "key": "status", "value": "active", "description": "Filter by station status (active, inactive, maintenance).", "disabled": false }, { "key": "city_id", "value": "1", "description": "Filter by city ID.", "disabled": false }, { "key": "state_id", "value": "1", "description": "Filter by state ID.", "disabled": false }, { "key": "tenant_id", "value": "1", "description": "Filter by tenant ID.", "disabled": false }, { "key": "manufacturer_id", "value": "1", "description": "Filter by manufacturer ID.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Number of stations per page (max 100). Only used if pagination requested.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number. Triggers pagination when provided.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/stations?provider_type=iqair&status=active&city_id=1&state_id=1&tenant_id=1&manufacturer_id=1&per_page=20&page=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves a list of stations with their provider integrations and related data.\nSupports filtering by provider type, status, and geographic location.\nReturns paginated response only when pagination parameters are provided, otherwise returns simple array for backward compatibility.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"00d8b873-69fc-4be9-a54b-02684332164e\",\n \"tenant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"state_id\": 2640,\n \"city_id\": 18871,\n \"manufacturer_id\": \"600ccf37-129a-4963-903b-67ba14a045eb\",\n \"owner\": \"Greenfelder, Lesch and Murazik\",\n \"station_name\": \"Arrah Station 1\",\n \"serial_number\": \"SN-8081-bs53\",\n \"status\": \"active\",\n \"city_name\": \"Arrah\",\n \"state_name\": \"Lacs\",\n \"country_name\": \"Cote D'Ivoire (Ivory Coast)\",\n \"latitude\": \"6.67342000\",\n \"longitude\": \"-3.96938000\",\n \"aqi\": {\n \"overall_aqi\": 135,\n \"overall_category\": \"Unhealthy for Sensitive Groups\",\n \"overall_color\": \"orange\"\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"per_page\": 20,\n \"total\": 150,\n \"last_page\": 8\n }\n}", "name": "Paginated response (when page or per_page provided)" }, { "header": [], "code": 200, "body": "[\n {\n \"id\": \"00d8b873-69fc-4be9-a54b-02684332164e\",\n \"tenant_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"state_id\": 2640,\n \"city_id\": 18871,\n \"manufacturer_id\": \"600ccf37-129a-4963-903b-67ba14a045eb\",\n \"owner\": \"Greenfelder, Lesch and Murazik\",\n \"station_name\": \"Arrah Station 1\",\n \"serial_number\": \"SN-8081-bs53\",\n \"status\": \"active\",\n \"city_name\": \"Arrah\",\n \"state_name\": \"Lacs\",\n \"country_name\": \"Cote D'Ivoire (Ivory Coast)\",\n \"latitude\": \"6.67342000\",\n \"longitude\": \"-3.96938000\",\n \"aqi\": {\n \"overall_aqi\": 135,\n \"overall_category\": \"Unhealthy for Sensitive Groups\",\n \"overall_color\": \"orange\",\n \"aqi_results\": [...],\n \"concentrations\": [...],\n \"meteorological_concentration\": [...]\n }\n }\n]", "name": "Simple array response (backward compatibility)" } ] }, { "name": "Create a new station (traditional endpoint compatibility).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations", "query": [], "raw": "{{baseUrl}}\/api\/stations" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint creates a new air pollution station in the system using the traditional structure.\nThis maintains backward compatibility with existing clients.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get detailed station information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the station." }, { "id": "station", "key": "station", "value": "1", "description": "The station ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves comprehensive information about a specific station including all relationships,\nprovider integrations, pollutant associations, and recent data metrics.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Station details retrieved successfully\",\n \"data\": {\n \"id\": 1,\n \"name\": \"Central Park Air Monitor\",\n \"latitude\": 40.7829,\n \"longitude\": -73.9654,\n \"elevation\": 15.5,\n \"status\": \"active\",\n \"installation_date\": \"2024-01-15\",\n \"city\": {\n \"id\": 1,\n \"name\": \"New York\",\n \"country_code\": \"US\"\n },\n \"state\": {\n \"id\": 1,\n \"name\": \"New York\",\n \"country_code\": \"US\"\n },\n \"tenant\": {\n \"id\": 1,\n \"name\": \"Environmental Agency\"\n },\n \"manufacturer\": {\n \"id\": 1,\n \"name\": \"IQAir\",\n \"website\": \"https:\/\/www.iqair.com\"\n },\n \"provider_integrations\": [\n {\n \"id\": 1,\n \"provider_type\": \"iqair\",\n \"device_id\": \"device_001\",\n \"is_active\": true,\n \"last_sync\": \"2025-10-19T09:30:00.000000Z\",\n \"sync_status\": \"success\"\n }\n ],\n \"pollutants\": [\n {\n \"id\": 1,\n \"name\": \"PM2.5\",\n \"symbol\": \"PM2.5\",\n \"unit\": \"\u00b5g\/m\u00b3\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Station not found\"\n}", "name": "" } ] }, { "name": "Update station and provider configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the station." }, { "id": "station", "key": "station", "value": "1", "description": "The station ID to update." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station\":{\"name\":\"Updated Monitor Name\",\"latitude\":40.783,\"longitude\":-73.9655,\"status\":\"maintenance\"},\"provider\":{\"device_id\":\"new_device_001\",\"api_key\":\"architecto\",\"config\":[],\"is_active\":false}}" }, "description": "Updates station information and\/or provider integration configuration.\nChanges are validated and applied within a database transaction.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Station updated successfully\",\n \"data\": {\n \"station\": {\n \"id\": 1,\n \"name\": \"Updated Monitor Name\",\n \"latitude\": 40.7830,\n \"longitude\": -73.9655,\n \"status\": \"maintenance\",\n \"updated_at\": \"2025-10-19T10:15:00.000000Z\"\n },\n \"provider_integration\": {\n \"id\": 1,\n \"device_id\": \"new_device_001\",\n \"is_active\": false,\n \"updated_at\": \"2025-10-19T10:15:00.000000Z\"\n }\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Station not found\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation failed\",\n \"errors\": {\n \"station.name\": [\"The station name must be a string.\"]\n }\n}", "name": "" } ] }, { "name": "Delete station and provider integrations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the station." }, { "id": "station", "key": "station", "value": "1", "description": "The station ID to delete." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Permanently removes a station and all its associated provider integrations, pollutant associations,\nand measurement data. This operation cannot be undone.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Station deleted successfully\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"Station not found\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"success\": false,\n \"message\": \"Cannot delete station with active data collection. Please disable provider integrations first.\"\n}", "name": "" } ] }, { "name": "Bulk-update station visibility flags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/bulk\/visibility", "query": [], "raw": "{{baseUrl}}\/api\/stations\/bulk\/visibility" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_ids\":[\"uuid-1\",\"uuid-2\"],\"show_on_map\":false,\"include_in_analytics\":false}" }, "description": "Updates show_on_map and\/or include_in_analytics for multiple stations in one call.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update station visibility flags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:id\/visibility", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:id\/visibility", "variable": [ { "id": "id", "key": "id", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "description": "The station UUID." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"show_on_map\":false,\"include_in_analytics\":true}" }, "description": "Updates the show_on_map and\/or include_in_analytics flags for a single station.\nAt least one flag must be provided.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get connectivity summary statistics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/connectivity\/summary", "query": [], "raw": "{{baseUrl}}\/api\/stations\/connectivity\/summary" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get provider connectivity breakdown", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/connectivity\/providers", "query": [], "raw": "{{baseUrl}}\/api\/stations\/connectivity\/providers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns detailed online\/offline statistics per provider", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get offline devices across all stations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/connectivity\/offline", "query": [], "raw": "{{baseUrl}}\/api\/stations\/connectivity\/offline" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Test device connectivity for a specific station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/connectivity\/test\/:stationId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/connectivity\/test\/:stationId", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get all stations by city ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/city\/:cityId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/city\/:cityId", "variable": [ { "id": "cityId", "key": "cityId", "value": "1", "description": "The city ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves all monitoring stations located within a specific city,\nincluding their provider integrations and operational status.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Stations retrieved successfully for city\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Central Park Air Monitor\",\n \"latitude\": 40.7829,\n \"longitude\": -73.9654,\n \"status\": \"active\",\n \"city\": {\n \"id\": 1,\n \"name\": \"New York\",\n \"country_code\": \"US\"\n },\n \"provider_integrations\": [\n {\n \"id\": 1,\n \"provider_type\": \"iqair\",\n \"device_id\": \"device_001\",\n \"is_active\": true\n }\n ]\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"City not found\"\n}", "name": "" } ] }, { "name": "Get all stations by state ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/state\/:stateId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/state\/:stateId", "variable": [ { "id": "stateId", "key": "stateId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all stations for a given state with provider integration information.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get all stations by country ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/country\/:countryId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/country\/:countryId", "variable": [ { "id": "countryId", "key": "countryId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all stations for a given country with provider integration information.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get pollutants associated with a specific station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all pollutants linked to the station, including additional information\nsuch as the measuring cell lifetime (if applicable) and provider configuration.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Associate a station with a pollutant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" }, { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint allows you to associate a specific station with a specific pollutant.\nThe request requires the IDs of both the station and the pollutant. The station will\nbe associated with the pollutant.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Remove the association of a station from a pollutant", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" }, { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint allows you to remove the association between a station and a pollutant.\nThe station will be detached from the pollutant.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Set the visibility of a pollutant for a specific station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId\/visibility", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId\/visibility", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" }, { "id": "pollutantId", "key": "pollutantId", "value": "architecto", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Controls whether this pollutant's data is shown to end users across the entire\nplatform (monitoring dashboard, public website, reports, data exports).\nSetting is_visible=false hides the pollutant from all user-facing surfaces\nwhile data collection and AQI calculation continue unaffected.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET \/api\/stations\/{id}\/settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:id\/settings", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:id\/settings", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the station's persisted settings merged with defaults so every\nkey is always present in the response even before the user saves for\nthe first time.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "PUT \/api\/stations\/{id}\/settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:id\/settings", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:id\/settings", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the station." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Persists station settings. Unknown keys are silently ignored so the\nstored payload stays clean.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "GET \/api\/stations\/{id}\/weather-parameters", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:id\/weather-parameters", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:id\/weather-parameters", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the meteorological parameters this station actually measures,\nderived from its weather_data rows. Each entry includes name, symbol,\nunit, and the most-recent recorded value.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] } ] }, { "name": "Station Meteorological Data", "description": "\nAPIs to manage meteorological data for a specific station.", "item": [ { "name": "Get the average value of meteorological data for a specific station along with parameter details.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/meteorological-data\/average", "query": [ { "key": "start", "value": "2025-01-20T00%3A00%3A00Z", "description": "Optional start of the custom interval (ISO-8601 format).", "disabled": false }, { "key": "end", "value": "2025-01-29T23%3A59%3A59Z", "description": "Optional end of the custom interval (ISO-8601 format).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/meteorological-data\/average?start=2025-01-20T00%3A00%3A00Z&end=2025-01-29T23%3A59%3A59Z", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Retrieve a list of meteorological data for a specific station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/meteorological-data", "query": [ { "key": "filter", "value": "today", "description": "Optional date filter preset. Options: \"today\", \"last_7_days\", \"last_30_days\".", "disabled": false }, { "key": "start", "value": "2025-01-20T00%3A00%3A00Z", "description": "Optional start date for custom range (ISO-8601 format).", "disabled": false }, { "key": "end", "value": "2025-01-29T23%3A59%3A59Z", "description": "Optional end date for custom range (ISO-8601 format).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/meteorological-data?filter=today&start=2025-01-20T00%3A00%3A00Z&end=2025-01-29T23%3A59%3A59Z", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store new meteorological data for a specific station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/meteorological-data", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/meteorological-data", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"parameter_id\":\"456e7890-e12d-34f5-b678-123456789abc\",\"value\":23.5}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Retrieve a specific meteorological data record for a station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/meteorological-data\/:meteorologicalDataId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/meteorological-data\/:meteorologicalDataId", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." }, { "id": "meteorologicalDataId", "key": "meteorologicalDataId", "value": "789e0123-f45g-67h8-9i01-23456789abcd", "description": "The UUID of the meteorological data." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a meteorological data record for a station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/meteorological-data\/:meteorologicalDataId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/meteorological-data\/:meteorologicalDataId", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." }, { "id": "meteorologicalDataId", "key": "meteorologicalDataId", "value": "789e0123-f45g-67h8-9i01-23456789abcd", "description": "The UUID of the meteorological data." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"parameter\":\"architecto\",\"value\":25}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a meteorological data record for a station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/meteorological-data\/:meteorologicalDataId", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/meteorological-data\/:meteorologicalDataId", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." }, { "id": "meteorologicalDataId", "key": "meteorologicalDataId", "value": "789e0123-f45g-67h8-9i01-23456789abcd", "description": "The UUID of the meteorological data." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Stations Maintenance Logs", "description": "\nAPIs for managing maintenance logs associated with monitoring stations.", "item": [ { "name": "Get all maintenance logs for a specific station.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/maintenance-logs", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/maintenance-logs", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all maintenance logs for the station identified by the given station ID.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new maintenance log.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/maintenance-logs", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/maintenance-logs", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_id\":\"123e4567-e89b-12d3-a456-426614174000\",\"maintenance_date\":\"2025-01-20\",\"maintenance_type\":\"Regular Checkup\",\"description\":\"Checked all stations and cleaned air filters.\",\"technician\":\"John Doe\",\"status\":\"completed\"}" }, "description": "Store a new maintenance log for a specific station.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get a specific maintenance log by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/maintenance-logs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/maintenance-logs\/:id", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." }, { "id": "id", "key": "id", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "The UUID of the maintenance log." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the details of a specific maintenance log by its unique ID.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a maintenance log by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/maintenance-logs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/maintenance-logs\/:id", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." }, { "id": "id", "key": "id", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "The UUID of the maintenance log." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_id\":\"123e4567-e89b-12d3-a456-426614174000\",\"maintenance_date\":\"2025-01-20\",\"maintenance_type\":\"Regular Checkup\",\"description\":\"Checked all stations and cleaned air filters.\",\"technician\":\"John Doe\",\"status\":\"completed\"}" }, "description": "Modify the details of an existing maintenance log.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a maintenance log.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/maintenance-logs\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/maintenance-logs\/:id", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "The UUID of the station." }, { "id": "id", "key": "id", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "The UUID of the maintenance log." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a specific maintenance log from the system.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Stations Measures", "description": "\nAPI endpoints for managing air quality measures.", "item": [ { "name": "List all measures", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId\/measures", "query": [ { "key": "filter", "value": "%7B%22dateRange%22%3A%7B%22from%22%3A%222025-01-01%22%2C%22to%22%3A%222025-01-31%22%7D%7D", "description": "Optional filters for measures.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId\/measures?filter=%7B%22dateRange%22%3A%7B%22from%22%3A%222025-01-01%22%2C%22to%22%3A%222025-01-31%22%7D%7D", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "uuid required The ID of the station." }, { "id": "pollutantId", "key": "pollutantId", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "uuid required The ID of the pollutant." } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "required The authorization token. Example: Bearer eyJhbGciOiJIUzI1..." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve all measures for a given station and pollutant.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new measure", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId\/measures", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId\/measures", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "uuid required The ID of the station." }, { "id": "pollutantId", "key": "pollutantId", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "uuid required The ID of the pollutant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"station_id\":\"architecto\",\"pollutant_id\":\"architecto\",\"value\":42.5,\"unit\":\"\u00b5g\\\/m\u00b3\",\"symbol\":\"i\",\"metadata\":\"{\\\"sensorType\\\":\\\"TypeA\\\",\\\"accuracy\\\":95}\"}" }, "description": "Store a newly created measure for a specific station and pollutant.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Retrieve a specific measure", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId\/measures\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId\/measures\/:id", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "uuid required The ID of the station." }, { "id": "pollutantId", "key": "pollutantId", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "uuid required The ID of the pollutant." }, { "id": "id", "key": "id", "value": "123e4567-e89b-12d3-a456-426614174002", "description": "uuid required The ID of the measure." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get details of a specific measure by its ID for a given station and pollutant.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a measure", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId\/measures\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId\/measures\/:id", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "uuid required The ID of the station." }, { "id": "pollutantId", "key": "pollutantId", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "uuid required The ID of the pollutant." }, { "id": "id", "key": "id", "value": "123e4567-e89b-12d3-a456-426614174002", "description": "uuid required The ID of the measure." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"value\":50.5,\"symbol\":\"m\",\"unit\":\"\u00b5g\\\/m\u00b3\",\"metadata\":\"{\\\"sensorType\\\":\\\"TypeB\\\",\\\"accuracy\\\":97}\"}" }, "description": "Update details of an existing measure.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a measure", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/stations\/:stationId\/pollutants\/:pollutantId\/measures\/:id", "query": [], "raw": "{{baseUrl}}\/api\/stations\/:stationId\/pollutants\/:pollutantId\/measures\/:id", "variable": [ { "id": "stationId", "key": "stationId", "value": "123e4567-e89b-12d3-a456-426614174000", "description": "uuid required The ID of the station." }, { "id": "pollutantId", "key": "pollutantId", "value": "123e4567-e89b-12d3-a456-426614174001", "description": "uuid required The ID of the pollutant." }, { "id": "id", "key": "id", "value": "123e4567-e89b-12d3-a456-426614174002", "description": "uuid required The ID of the measure." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove a specific measure.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Sub Region Management", "description": "\nAPIs to manage subregions, including retrieving, creating, updating, and deleting subregions.", "item": [ { "name": "Display a list of all subregions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subregions", "query": [], "raw": "{{baseUrl}}\/api\/subregions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Show a specific subregion.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subregions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/subregions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the subregion." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Store a new subregion.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subregions", "query": [], "raw": "{{baseUrl}}\/api\/subregions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"region_id\":\"architecto\",\"translations\":\"architecto\",\"flag\":false,\"wikiDataId\":\"n\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update a specific subregion.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subregions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/subregions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the subregion." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"translations\":\"architecto\",\"flag\":false,\"wikiDataId\":\"n\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a specific subregion.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/subregions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/subregions\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the subregion." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Tenant Partners", "description": "", "item": [ { "name": "Get all tenant partners.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant_id\/partners", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant_id\/partners", "variable": [ { "id": "tenant_id", "key": "tenant_id", "value": "architecto", "description": "The ID of the tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Get a specific tenant partner.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant_id\/partners\/:partner_id", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant_id\/partners\/:partner_id", "variable": [ { "id": "tenant_id", "key": "tenant_id", "value": "architecto", "description": "The ID of the tenant." }, { "id": "partner_id", "key": "partner_id", "value": "architecto", "description": "The ID of the partner." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new tenant partner.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant_id\/partners", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant_id\/partners", "variable": [ { "id": "tenant_id", "key": "tenant_id", "value": "architecto", "description": "The ID of the tenant." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"phone_number\":\"iyvdljnikhwaykcm\",\"logo\":\"y\",\"description\":\"Eius et animi quos velit et.\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Update an existing tenant partner.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant_id\/partners\/:partner_id", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant_id\/partners\/:partner_id", "variable": [ { "id": "tenant_id", "key": "tenant_id", "value": "architecto", "description": "The ID of the tenant." }, { "id": "partner_id", "key": "partner_id", "value": "architecto", "description": "The ID of the partner." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"phone_number\":\"iyvdljnikhwaykcm\",\"logo\":\"y\",\"description\":\"Eius et animi quos velit et.\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a tenant partner.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant_id\/partners\/:partner_id", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant_id\/partners\/:partner_id", "variable": [ { "id": "tenant_id", "key": "tenant_id", "value": "architecto", "description": "The ID of the tenant." }, { "id": "partner_id", "key": "partner_id", "value": "architecto", "description": "The ID of the partner." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Tenants", "description": "APIs related to tenant management.", "item": [ { "name": "Get all tenants.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants", "query": [], "raw": "{{baseUrl}}\/api\/tenants" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants", "query": [], "raw": "{{baseUrl}}\/api\/tenants" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"logo\":\"i\",\"phone_number\":\"yvdljnikhwaykcmy\",\"description\":\"Eius et animi quos velit et.\",\"start_date\":\"2026-06-20T08:19:52\",\"end_date\":\"2052-07-13\",\"tenant_manager\":\"n\",\"budget\":84,\"funding_source\":\"z\",\"coordinates\":\"[\\\"architecto\\\",\\\"architecto\\\"]\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get a specific tenant by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update an existing tenant.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"logo\":\"i\",\"phone_number\":\"yvdljnikhwaykcmy\",\"description\":\"Eius et animi quos velit et.\",\"start_date\":\"2026-06-20T08:19:52\",\"end_date\":\"2052-07-13\",\"tenant_manager\":\"n\",\"budget\":84,\"funding_source\":\"z\",\"coordinates\":\"[\\\"architecto\\\",\\\"architecto\\\"]\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a tenant by ID.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tenants\/:tenant", "query": [], "raw": "{{baseUrl}}\/api\/tenants\/:tenant", "variable": [ { "id": "tenant", "key": "tenant", "value": "architecto", "description": "The tenant." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Thresholds", "description": "\nManage pollutant thresholds for air quality monitoring.", "item": [ { "name": "Get all pollutant thresholds.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/thresholds", "query": [ { "key": "pollutant_id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "Filter thresholds by pollutant ID.", "disabled": false }, { "key": "station_id", "value": "0034fd43-245f-4ce2-ac4f-4683a8cf4722", "description": "Filter thresholds by station ID.", "disabled": false }, { "key": "threshold_type", "value": "warning", "description": "Filter thresholds by type ('Critical', 'Warning', 'Standard').", "disabled": false }, { "key": "is_global", "value": "1", "description": "Filter thresholds by global status.", "disabled": false }, { "key": "per_page", "value": "25", "description": "Number of items per page. Default: 15.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/thresholds?pollutant_id=9ca44a28-824b-45f3-a12b-19df647e07bb&station_id=0034fd43-245f-4ce2-ac4f-4683a8cf4722&threshold_type=warning&is_global=1&per_page=25" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all pollutant thresholds in the system with optional filtering.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Create a new pollutant threshold.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/thresholds", "query": [], "raw": "{{baseUrl}}\/api\/thresholds" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_id\":\"9ca44a28-824b-45f3-a12b-19df647e07bb\",\"station_id\":\"0034fd43-245f-4ce2-ac4f-4683a8cf4722\",\"is_global\":false,\"threshold_type\":\"warning\",\"moderate_threshold\":39,\"unhealthy_sensitive_threshold\":84,\"unhealthy_threshold\":12,\"very_unhealthy_threshold\":77,\"hazardous_threshold\":8,\"time_period\":43,\"notification_channels\":{\"email\":true,\"sms\":false,\"in_app\":true},\"alert_frequency\":\"hourly\",\"value\":\"50.5\",\"unit\":\"\u00b5g\\\/m\u00b3\",\"description\":\"PM2.5 warning level for sensitive groups\"}" }, "description": "This endpoint creates a new pollutant threshold in the system.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get a specific pollutant threshold.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/thresholds\/:threshold", "query": [], "raw": "{{baseUrl}}\/api\/thresholds\/:threshold", "variable": [ { "id": "threshold", "key": "threshold", "value": "architecto", "description": "The threshold." }, { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The ID of the threshold." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves a specific pollutant threshold by its unique ID.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"code\":401,\"locale\":\"en\",\"message\":\"Unauthenticated. Please provide a valid access token.\",\"data\":null}", "name": "" } ] }, { "name": "Update a pollutant threshold.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/thresholds\/:threshold", "query": [], "raw": "{{baseUrl}}\/api\/thresholds\/:threshold", "variable": [ { "id": "threshold", "key": "threshold", "value": "architecto", "description": "The threshold." }, { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The ID of the threshold." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"pollutant_id\":\"9ca44a28-824b-45f3-a12b-19df647e07bb\",\"station_id\":\"0034fd43-245f-4ce2-ac4f-4683a8cf4722\",\"is_global\":true,\"threshold_type\":\"critical\",\"moderate_threshold\":39,\"unhealthy_sensitive_threshold\":84,\"unhealthy_threshold\":12,\"very_unhealthy_threshold\":77,\"hazardous_threshold\":8,\"time_period\":43,\"notification_channels\":{\"email\":false,\"sms\":false,\"in_app\":false},\"alert_frequency\":\"immediate\",\"value\":\"75.2\",\"unit\":\"\u00b5g\\\/m\u00b3\",\"description\":\"PM2.5 critical level\",\"with\":\"pollutant\"}" }, "description": "This endpoint updates the details of a specific pollutant threshold by its ID.", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Delete a pollutant threshold.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/thresholds\/:threshold", "query": [], "raw": "{{baseUrl}}\/api\/thresholds\/:threshold", "variable": [ { "id": "threshold", "key": "threshold", "value": "architecto", "description": "The threshold." }, { "id": "id", "key": "id", "value": "9ca44a28-824b-45f3-a12b-19df647e07bb", "description": "The ID of the threshold." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint deletes a specific pollutant threshold by its ID.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "User Profile", "description": "\nAPIs for managing user profiles, preferences and personal settings.", "item": [ { "name": "Get Current User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/profile", "query": [], "raw": "{{baseUrl}}\/api\/user\/profile" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the complete profile information of the authenticated user,\nincluding personal details, preferences, and profile completion status.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile retrieved successfully.\",\n \"data\": {\n \"id\": \"1b5e37a0-8f3c-4b70-98ba-ac4c8b25108d\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+1234567890\",\n \"avatar_url\": \"https:\/\/example.com\/storage\/avatars\/user_avatar.jpg\",\n \"bio\": \"Environmental scientist with expertise in air quality monitoring\",\n \"job_title\": \"Senior Air Quality Analyst\",\n \"company\": \"Environmental Solutions Inc.\",\n \"department\": \"Research\",\n \"country\": \"Nigeria\",\n \"state\": \"Lagos\",\n \"city\": \"Lagos\",\n \"timezone\": \"Africa\/Lagos\",\n \"language\": \"en\",\n \"theme_preference\": \"light\",\n \"is_profile_public\": true,\n \"profile_completion_percentage\": 85\n }\n}", "name": "Success" } ] }, { "name": "Update User Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/profile", "query": [], "raw": "{{baseUrl}}\/api\/user\/profile" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"phone\":\"+1234567890\",\"bio\":\"Environmental scientist with 10+ years experience\",\"job_title\":\"Senior Air Quality Specialist\",\"company\":\"Environmental Solutions Ltd\",\"department\":\"Research & Development\",\"country\":\"Nigeria\",\"state\":\"Lagos\",\"city\":\"Lagos\",\"timezone\":\"Africa\\\/Lagos\",\"language\":\"en\",\"date_of_birth\":\"1990-01-15\",\"professional_interests\":[\"architecto\"],\"expertise_areas\":[\"architecto\"],\"linkedin_url\":\"https:\\\/\\\/linkedin.com\\\/in\\\/johndoe\",\"website_url\":\"https:\\\/\\\/johndoe.com\",\"is_profile_public\":true,\"theme_preference\":\"light\",\"professional_interests[]\":\"data_science\",\"expertise_areas[]\":\"iot_stations\"}" }, "description": "This endpoint updates the profile information of the authenticated user.\nAll fields are optional and only the provided fields will be updated.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile updated successfully.\",\n \"data\": {\n \"id\": \"1b5e37a0-8f3c-4b70-98ba-ac4c8b25108d\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+1234567890\",\n \"bio\": \"Environmental scientist with 10+ years experience\",\n \"job_title\": \"Senior Air Quality Specialist\",\n \"company\": \"Environmental Solutions Ltd\",\n \"department\": \"Research & Development\",\n \"profile_completion_percentage\": 92\n }\n}", "name": "Success" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"phone\": [\"The phone format is invalid.\"],\n \"linkedin_url\": [\"The linkedin url must be a valid URL.\"]\n }\n}", "name": "Validation Error" } ] }, { "name": "Upload Profile Avatar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/profile\/avatar", "query": [], "raw": "{{baseUrl}}\/api\/user\/profile\/avatar" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "avatar", "src": [], "type": "file" } ] }, "description": "This endpoint allows the authenticated user to upload a profile picture.\nThe image will be stored on the server and the URL will be updated in the user's profile.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Avatar uploaded successfully.\",\n \"data\": {\n \"avatar_url\": \"https:\/\/example.com\/storage\/avatars\/avatar_1b5e37a0_1630000000.jpg\"\n }\n}", "name": "Success" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"avatar\": [\n \"The avatar must be an image.\",\n \"The avatar must be less than 2MB.\"\n ]\n }\n}", "name": "Validation Error" } ] }, { "name": "Remove Profile Avatar", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/profile\/avatar", "query": [], "raw": "{{baseUrl}}\/api\/user\/profile\/avatar" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint removes the authenticated user's profile picture and deletes the associated file.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Avatar removed successfully.\",\n \"data\": null\n}", "name": "Success" } ] }, { "name": "Update Profile Visibility", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/profile\/visibility", "query": [], "raw": "{{baseUrl}}\/api\/user\/profile\/visibility" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_profile_public\":true}" }, "description": "This endpoint updates the visibility settings of the authenticated user's profile.\nWhen a profile is set to public, it can be viewed by other users via the public profile endpoint.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile visibility updated successfully.\",\n \"data\": {\n \"is_profile_public\": true\n }\n}", "name": "Success" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"is_profile_public\": [\"The is profile public field is required.\"]\n }\n}", "name": "Validation Error" } ] }, { "name": "Get Profile Completion Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/profile\/completion-status", "query": [], "raw": "{{baseUrl}}\/api\/user\/profile\/completion-status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the profile completion status of the authenticated user,\nincluding percentage complete, completed sections, and suggested next steps.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Profile completion status retrieved successfully.\",\n \"data\": {\n \"completion_percentage\": 75\n }\n}", "name": "Success" } ] }, { "name": "Get User Preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/preferences", "query": [], "raw": "{{baseUrl}}\/api\/user\/preferences" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves all user preferences for the authenticated user,\nincluding notification settings, dashboard settings, and theme preference.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"User preferences retrieved successfully.\",\n \"data\": {\n \"notification_preferences\": {\n \"email_notifications\": true,\n \"push_notifications\": false,\n \"alert_threshold\": \"medium\",\n \"frequency\": \"daily\"\n },\n \"dashboard_preferences\": {\n \"default_view\": \"map\",\n \"chart_type\": \"line\",\n \"time_range\": \"week\"\n },\n \"theme_preference\": \"light\"\n }\n}", "name": "Success" } ] }, { "name": "Update User Preferences", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/preferences\/:type", "query": [], "raw": "{{baseUrl}}\/api\/user\/preferences\/:type", "variable": [ { "id": "type", "key": "type", "value": "notifications", "description": "The type of preferences to update. Must be one of: notifications, dashboard, theme." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"preferences\":[\"architecto\"],\"theme\":\"dark\"}" }, "description": "This endpoint updates user preferences for notifications, dashboard, or theme.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Notifications preferences updated successfully.\",\n \"data\": {\n \"notification_preferences\": {\n \"email_alerts\": true,\n \"push_notifications\": false,\n \"alert_threshold\": \"medium\",\n \"frequency\": \"daily\"\n }\n }\n}", "name": "Update Notifications Success" }, { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Theme preference updated successfully.\",\n \"data\": {\n \"theme_preference\": \"dark\"\n }\n}", "name": "Update Theme Success" }, { "header": [], "code": 400, "body": "{\n \"success\": false,\n \"message\": \"Invalid preference type.\",\n \"data\": null\n}", "name": "Invalid Type" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"preferences\": [\"The preferences field is required.\"]\n }\n}", "name": "Validation Error" } ] }, { "name": "Get Public Profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:userId\/profile\/public", "query": [], "raw": "{{baseUrl}}\/api\/users\/:userId\/profile\/public", "variable": [ { "id": "userId", "key": "userId", "value": "1b5e37a0-8f3c-4b70-98ba-ac4c8b25108d", "description": "The UUID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint retrieves the public profile information of a user.\nOnly returns information for profiles that have been set to public.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Public profile retrieved successfully.\",\n \"data\": {\n \"id\": \"1b5e37a0-8f3c-4b70-98ba-ac4c8b25108d\",\n \"name\": \"John Doe\",\n \"avatar_url\": \"https:\/\/example.com\/storage\/avatars\/avatar_1b5e37a0_1630000000.jpg\",\n \"bio\": \"Environmental scientist with 10+ years experience\",\n \"job_title\": \"Senior Air Quality Specialist\",\n \"company\": \"Environmental Solutions Ltd\",\n \"country\": \"Nigeria\",\n \"state\": \"Lagos\",\n \"city\": \"Lagos\",\n \"professional_interests\": [\"air_quality\", \"climate_change\", \"data_science\"],\n \"expertise_areas\": [\"data_analysis\", \"environmental_monitoring\"],\n \"linkedin_url\": \"https:\/\/linkedin.com\/in\/johndoe\",\n \"website_url\": \"https:\/\/johndoe.com\"\n }\n}", "name": "Success" }, { "header": [], "code": 403, "body": "{\n \"success\": false,\n \"message\": \"This profile is not public.\",\n \"data\": null\n}", "name": "Not Public" }, { "header": [], "code": 404, "body": "{\n \"success\": false,\n \"message\": \"User not found.\",\n \"data\": null\n}", "name": "Not Found" } ] } ] }, { "name": "Zwinsoft\/Henddu Integration", "description": "\nAPIs for Zwinsoft\/Henddu sensor registration and management", "item": [ { "name": "List available Zwinsoft providers configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zwinsoft\/config", "query": [], "raw": "{{baseUrl}}\/api\/zwinsoft\/config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the current Zwinsoft provider configuration status.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Zwinsoft provider configuration\",\n \"data\": {\n \"provider_name\": \"zwinsoft\",\n \"display_name\": \"Henddu (Zwinsoft)\",\n \"active\": true,\n \"configured\": true,\n \"supported_pollutants\": [\"PM2.5\", \"PM10\", \"TSP\", \"SO2\", \"NO2\", \"O3\", \"CO2\", \"VOC\", \"CH4\"],\n \"supported_data_types\": {\n \"realtime\": 2011,\n \"minute\": 2051,\n \"hourly\": 2061,\n \"daily\": 2031\n }\n }\n}", "name": "" } ] }, { "name": "Test connection to a Zwinsoft device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zwinsoft\/test-connection", "query": [], "raw": "{{baseUrl}}\/api\/zwinsoft\/test-connection" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"device_sn\":\"00402424122400342014\"}" }, "description": "Tests connectivity to a device by serial number before registration.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Device is online with data\",\n \"data\": {\n \"device_sn\": \"00402424122400342014\",\n \"status\": \"connected\",\n \"last_data_timestamp\": \"2026-02-05T18:00:00\",\n \"data_points_count\": 17,\n \"response_time_ms\": 245.5\n }\n}", "name": "" } ] }, { "name": "Register a Zwinsoft\/Henddu station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zwinsoft\/register", "query": [], "raw": "{{baseUrl}}\/api\/zwinsoft\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"device_sn\":\"00402424122400342014\",\"station_name\":\"CIAPOL Si\u00e8ge - Henddu Monitor\",\"tenant_id\":\"550e8400-e29b-41d4-a716-446655440000\",\"latitude\":5.3647,\"longitude\":-3.9815,\"manufacturer_id\":\"7a8b9c10-129a-4963-903b-67ba14a045ec\",\"owner\":\"CIAPOL\",\"station_class\":\"microstation\",\"station_type\":\"urban\",\"street_address\":\"Carrefour Kaiser, Cocody\",\"building_name\":\"CIAPOL Headquarters\",\"installation_position\":\"rooftop\",\"data_type\":2011,\"test_connection\":true}" }, "description": "Creates a new station with the Zwinsoft device integration.\nTests the device connectivity during registration.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"success\": true,\n \"message\": \"Zwinsoft\/Henddu station registered successfully\",\n \"data\": {\n \"station\": {\n \"id\": \"7b10638b-0ec5-4431-a9de-9b1ad879db44\",\n \"station_name\": \"CIAPOL Si\u00e8ge - Henddu Monitor\",\n \"latitude\": 5.3647,\n \"longitude\": -3.9815,\n \"status\": \"active\"\n },\n \"device_integration\": {\n \"id\": \"e0fa5003-0ca0-4e02-9956-2df4c3b26d65\",\n \"provider_name\": \"zwinsoft\",\n \"external_device_id\": \"00402424122400342014\",\n \"connection_status\": \"connected\"\n },\n \"pollutants\": [\"PM2.5\", \"PM10\", \"TSP\", \"SO2\", \"NO2\", \"O3\", \"CO2\", \"VOC\", \"CH4\"],\n \"connection_test\": {\n \"success\": true,\n \"message\": \"Device is online with data\"\n }\n }\n}", "name": "" } ] }, { "name": "List registered Zwinsoft stations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zwinsoft\/stations", "query": [], "raw": "{{baseUrl}}\/api\/zwinsoft\/stations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all stations with Zwinsoft device integrations.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Found 1 Zwinsoft station(s)\",\n \"data\": [\n {\n \"station_id\": \"7b10638b-0ec5-4431-a9de-9b1ad879db44\",\n \"station_name\": \"CIAPOL Si\u00e8ge - Henddu Monitor\",\n \"device_sn\": \"00402424122400342014\",\n \"latitude\": 5.3647,\n \"longitude\": -3.9815,\n \"status\": \"active\",\n \"connection_status\": \"connected\",\n \"last_connection_check\": \"2026-02-05T18:06:48.000000Z\"\n }\n ]\n}", "name": "" } ] }, { "name": "Collect data for a Zwinsoft station", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/zwinsoft\/stations\/:stationId\/collect", "query": [], "raw": "{{baseUrl}}\/api\/zwinsoft\/stations\/:stationId\/collect", "variable": [ { "id": "stationId", "key": "stationId", "value": "architecto", "description": "" }, { "id": "station_id", "key": "station_id", "value": "7b10638b-0ec5-4431-a9de-9b1ad879db44", "description": "Station UUID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data_type\":2011,\"sync\":true}" }, "description": "Manually triggers data collection for a specific station.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Data collection completed successfully\",\n \"data\": {\n \"station_id\": \"7b10638b-0ec5-4431-a9de-9b1ad879db44\",\n \"timestamp\": \"2026-02-05T18:00:00\",\n \"air_quality_saved\": true,\n \"weather_saved\": true\n }\n}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }