{ "item": [ { "name": "health", "description": "", "item": [ { "id": "6a95a0e7-7a4c-4618-98ef-098aec029b88", "name": "Get system status", "request": { "name": "Get system status", "description": { "content": "Returns comprehensive system status (uptime, versions, database, network). Mounted at root, not under /api/v0.", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e2aa9e5d-17d2-4f81-af4c-b64bb3d5e2dd", "name": "System status information", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\",\n \"timestamp\": \"\",\n \"environment\": \"\",\n \"network\": \"\",\n \"networkId\": \"\",\n \"server\": {\n \"uptime\": \"\",\n \"uptimeSeconds\": \"\",\n \"version\": \"\",\n \"nodeVersion\": \"\",\n \"memoryUsage\": {\n \"rss\": \"\",\n \"heapTotal\": \"\",\n \"heapUsed\": \"\"\n }\n },\n \"frontend\": \"\",\n \"database\": {\n \"status\": \"disconnected\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "752c91a0-9607-4af9-b782-2b09d155bc46", "name": "Internal server error", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "health", "description": "", "item": [ { "id": "7e51f59c-9b9c-4fc2-8141-6c3e42dbf653", "name": "Health check", "request": { "name": "Health check", "description": { "content": "Simple health check for load balancers and monitoring. Always returns 200 with status healthy unless server is down.", "type": "text/plain" }, "url": { "path": [ "health", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c8f9e86f-760e-4469-8b01-0a8952ff65bc", "name": "System is healthy", "originalRequest": { "url": { "path": [ "health", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "db", "description": "", "item": [ { "id": "178431a3-974b-48f9-9f73-fe0fc4d1f0ff", "name": "Database connection status", "request": { "name": "Database connection status", "description": { "content": "Returns the current database connection status.", "type": "text/plain" }, "url": { "path": [ "health", "db" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0d54e77a-18a6-449e-91d9-31725a3f3b41", "name": "Database connection status", "originalRequest": { "url": { "path": [ "health", "db" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"disconnected\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "ballots", "description": "", "item": [ { "name": "voterTypes", "description": "", "item": [ { "id": "f6fac804-e5a4-4e34-8e7c-f916c67b7037", "name": "Get all unique voter types", "request": { "name": "Get all unique voter types", "description": { "content": "Returns an array of all unique voter types from all ballots", "type": "text/plain" }, "url": { "path": [ "ballots", "voterTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c7105896-4910-4e5d-ac1d-ce893276ab2f", "name": "Array of unique voter types", "originalRequest": { "url": { "path": [ "ballots", "voterTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad649cee-3ea9-465d-968d-604ea12586cc", "name": "Internal server error", "originalRequest": { "url": { "path": [ "ballots", "voterTypes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{ballotId}", "description": "", "item": [ { "name": "proposals", "description": "", "item": [ { "id": "bf2be46b-3fb2-4e57-8d06-100c3002b2fa", "name": "Get proposals for a ballot", "request": { "name": "Get proposals for a ballot", "description": { "content": "Get all proposals for a specific ballot with filtering, sorting, and pagination", "type": "text/plain" }, "url": { "path": [ "ballots", ":ballotId", "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "Search term for proposal title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of title,commentCount,voteCount)", "type": "text/plain" }, "key": "sort", "value": "_id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by whether authenticated user has voted (only works when authenticated) (This can only be one of true,false)", "type": "text/plain" }, "key": "hasVoted", "value": "false" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated)", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by categories (comma-separated)", "type": "text/plain" }, "key": "categories", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dcfb9139-1162-4323-ae89-605cc747fe92", "name": "List of proposals with pagination and filter metadata", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "Search term for proposal title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of title,commentCount,voteCount)", "type": "text/plain" }, "key": "sort", "value": "_id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by whether authenticated user has voted (only works when authenticated) (This can only be one of true,false)", "type": "text/plain" }, "key": "hasVoted", "value": "false" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated)", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by categories (comma-separated)", "type": "text/plain" }, "key": "categories", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"ballotId\": \"\",\n \"ipfsHash\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"data\": {},\n \"voteType\": \"choice\",\n \"minSelections\": \"\",\n \"maxSelections\": \"\",\n \"voteIncrement\": \"\",\n \"voterBudget\": \"\",\n \"requireAnswer\": false,\n \"voteOptions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n }\n ],\n \"commentCount\": \"\",\n \"voteCount\": \"\",\n \"votingPower\": \"\",\n \"result\": {},\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"ballotId\": \"\",\n \"ipfsHash\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"data\": {},\n \"voteType\": \"likert\",\n \"minSelections\": \"\",\n \"maxSelections\": \"\",\n \"voteIncrement\": \"\",\n \"voterBudget\": \"\",\n \"requireAnswer\": false,\n \"voteOptions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n }\n ],\n \"commentCount\": \"\",\n \"voteCount\": \"\",\n \"votingPower\": \"\",\n \"result\": {},\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": \"\",\n \"page\": \"\",\n \"limit\": \"\",\n \"totalPages\": \"\"\n },\n \"sort\": {\n \"field\": \"\",\n \"direction\": \"\"\n },\n \"filters\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92132c3c-cd1c-4927-918d-c2f3a6099509", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "Search term for proposal title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of title,commentCount,voteCount)", "type": "text/plain" }, "key": "sort", "value": "_id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by whether authenticated user has voted (only works when authenticated) (This can only be one of true,false)", "type": "text/plain" }, "key": "hasVoted", "value": "false" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated)", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by categories (comma-separated)", "type": "text/plain" }, "key": "categories", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9064b871-220d-4a84-be72-3a90e77b43d8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "Search term for proposal title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of title,commentCount,voteCount)", "type": "text/plain" }, "key": "sort", "value": "_id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by whether authenticated user has voted (only works when authenticated) (This can only be one of true,false)", "type": "text/plain" }, "key": "hasVoted", "value": "false" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated)", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by categories (comma-separated)", "type": "text/plain" }, "key": "categories", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0003433-9fc6-4f58-82cb-dcbb32ab8d1d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "proposals" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" }, { "disabled": false, "description": { "content": "Search term for proposal title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of title,commentCount,voteCount)", "type": "text/plain" }, "key": "sort", "value": "_id" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by whether authenticated user has voted (only works when authenticated) (This can only be one of true,false)", "type": "text/plain" }, "key": "hasVoted", "value": "false" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated)", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by categories (comma-separated)", "type": "text/plain" }, "key": "categories", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "categories", "description": "", "item": [ { "id": "251098b3-5bde-4632-9fc3-9d50c617ed75", "name": "Get unique categories for a ballot", "request": { "name": "Get unique categories for a ballot", "description": { "content": "Get all unique categories from proposals in a specific ballot", "type": "text/plain" }, "url": { "path": [ "ballots", ":ballotId", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "46c29da0-3a56-4118-8c26-85653d392fef", "name": "List of unique categories", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f4e61b7-a3ad-4d42-a142-2ff27c312b49", "name": "Resource not found", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cf2f709-ee47-42b2-9ec3-6c26aa77a047", "name": "Internal server error", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "tags", "description": "", "item": [ { "id": "04d1000f-d0ae-41da-874d-61ad054ecd9c", "name": "Get unique tags for a ballot", "request": { "name": "Get unique tags for a ballot", "description": { "content": "Get all unique tags from proposals in a specific ballot", "type": "text/plain" }, "url": { "path": [ "ballots", ":ballotId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "451db0b0-9c6e-4802-b570-7545d9adc553", "name": "List of unique tags", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n \"\",\n \"\"\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daf475c5-6475-4fc4-ae4c-d147af26c21b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0ab3720-40a2-4f80-91e7-9781a76ee9c8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "ballots", ":ballotId", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "83342cbd-1306-4b6b-b03d-7e523a402a3c", "name": "Get a specific ballot", "request": { "name": "Get a specific ballot", "description": { "content": "Get a specific ballot by ID with voter validation if token is present", "type": "text/plain" }, "url": { "path": [ "ballots", ":ballotId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) The ID of the ballot to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4a9aa2ef-19ec-4b50-bf6c-cf61428f1e7a", "name": "The ballot object with additional voter-specific data if authenticated", "originalRequest": { "url": { "path": [ "ballots", ":ballotId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"ipfsHash\": \"\",\n \"voterType\": \"\",\n \"voterGroups\": [\n {\n \"group\": \"drep\",\n \"powerSource\": \"StakeBased\",\n \"requirements\": {\n \"key_0\": 5700.201963040554,\n \"key_1\": 6391.257796139121\n }\n },\n {\n \"group\": \"drep\",\n \"powerSource\": \"PledgeBased\",\n \"requirements\": {\n \"key_0\": false,\n \"key_1\": \"string\"\n }\n }\n ],\n \"voterDescription\": \"\",\n \"votePeriodStart\": \"\",\n \"votePeriodEnd\": \"\",\n \"voteFilters\": \"\",\n \"voteWeighted\": \"\",\n \"proposalPeriodStart\": \"\",\n \"proposalPeriodEnd\": \"\",\n \"resultTxHash\": \"\",\n \"status\": \"closed\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"voterValidated\": \"\",\n \"votingPower\": \"\",\n \"votingPowerByGroup\": {\n \"key_0\": \"\"\n },\n \"eligibleVoterCountByGroup\": {\n \"key_0\": \"\"\n },\n \"activeVotingPowerByGroup\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"activeVoterCountByGroup\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"votingPowerSourceInfo\": {},\n \"totalAllowedVoterCount\": \"\",\n \"totalVotingPower\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56afd7bc-39ac-4872-9a52-84760504732e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "ballots", ":ballotId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa7f2816-97be-4ee5-a1ff-76f8da1bdd6a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "ballots", ":ballotId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the ballot to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "8efcdcb8-441f-4343-b1f8-316f2d6b2050", "name": "Get all ballots", "request": { "name": "Get all ballots", "description": { "content": "Get all ballots with pagination, filtering, and search capabilities", "type": "text/plain" }, "url": { "path": [ "ballots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by voter type", "type": "text/plain" }, "key": "voterType", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (This can only be one of live,closed,upcoming)", "type": "text/plain" }, "key": "status", "value": "upcoming" }, { "disabled": false, "description": { "content": "Search term for ballot title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2fd4de2e-da4b-4d50-be24-fdff195fa14c", "name": "List of ballots with pagination metadata", "originalRequest": { "url": { "path": [ "ballots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by voter type", "type": "text/plain" }, "key": "voterType", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (This can only be one of live,closed,upcoming)", "type": "text/plain" }, "key": "status", "value": "upcoming" }, { "disabled": false, "description": { "content": "Search term for ballot title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"ipfsHash\": \"\",\n \"voterType\": \"\",\n \"voterGroups\": [\n {\n \"group\": \"drep\",\n \"powerSource\": \"StakeBased\",\n \"requirements\": {\n \"key_0\": false,\n \"key_1\": 7034,\n \"key_2\": false,\n \"key_3\": \"string\"\n }\n },\n {\n \"group\": \"drep\",\n \"powerSource\": \"CredentialBased\",\n \"requirements\": {\n \"key_0\": \"string\"\n }\n }\n ],\n \"voterDescription\": \"\",\n \"votePeriodStart\": \"\",\n \"votePeriodEnd\": \"\",\n \"voteFilters\": \"\",\n \"voteWeighted\": \"\",\n \"proposalPeriodStart\": \"\",\n \"proposalPeriodEnd\": \"\",\n \"resultTxHash\": \"\",\n \"status\": \"closed\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"ipfsHash\": \"\",\n \"voterType\": \"\",\n \"voterGroups\": [\n {\n \"group\": \"drep\",\n \"powerSource\": \"PledgeBased\",\n \"requirements\": {\n \"key_0\": 2442,\n \"key_1\": 2118.4199733676887\n }\n },\n {\n \"group\": \"stake\",\n \"powerSource\": \"PledgeBased\",\n \"requirements\": {\n \"key_0\": 8863,\n \"key_1\": \"string\"\n }\n }\n ],\n \"voterDescription\": \"\",\n \"votePeriodStart\": \"\",\n \"votePeriodEnd\": \"\",\n \"voteFilters\": \"\",\n \"voteWeighted\": \"\",\n \"proposalPeriodStart\": \"\",\n \"proposalPeriodEnd\": \"\",\n \"resultTxHash\": \"\",\n \"status\": \"closed\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pagination\": {\n \"total\": \"\",\n \"page\": \"\",\n \"limit\": \"\",\n \"totalPages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2654e53-e478-474c-a041-81927c3115ef", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "ballots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by voter type", "type": "text/plain" }, "key": "voterType", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (This can only be one of live,closed,upcoming)", "type": "text/plain" }, "key": "status", "value": "upcoming" }, { "disabled": false, "description": { "content": "Search term for ballot title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ecbbde6-25af-4818-9d30-c6a48380b124", "name": "Internal server error", "originalRequest": { "url": { "path": [ "ballots" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by voter type", "type": "text/plain" }, "key": "voterType", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (This can only be one of live,closed,upcoming)", "type": "text/plain" }, "key": "status", "value": "upcoming" }, { "disabled": false, "description": { "content": "Search term for ballot title or ID", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "proposals", "description": "", "item": [ { "name": "{proposalId}", "description": "", "item": [ { "name": "comments", "description": "", "item": [ { "id": "05b7ff33-a039-4909-afb3-109ee479daa8", "name": "Get comments for a proposal", "request": { "name": "Get comments for a proposal", "description": { "content": "Get all comments for a specific proposal sorted by creation date", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId", "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "proposalId", "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b8ff8f74-becc-42ac-9f18-8580af92e0b3", "name": "List of comments for the proposal", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"_id\": \"\",\n \"proposalId\": \"\",\n \"parentId\": \"\",\n \"userId\": \"\",\n \"content\": \"\",\n \"status\": \"withdrawnByAdmin\",\n \"withdrawalDetails\": {\n \"category\": \"Spam\",\n \"userId\": \"\",\n \"comment\": \"\",\n \"date\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"proposalId\": \"\",\n \"parentId\": \"\",\n \"userId\": \"\",\n \"content\": \"\",\n \"status\": \"live\",\n \"withdrawalDetails\": {\n \"category\": \"Policy violation\",\n \"userId\": \"\",\n \"comment\": \"\",\n \"date\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a4e4112-956b-4f20-ae83-396370b3be49", "name": "Resource not found", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aef34e35-7b8c-4fbc-830e-1e3d64c2035b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "results", "description": "", "item": [ { "name": "grouped", "description": "", "item": [ { "id": "4f8249ae-bb5b-4daa-a69e-cce56a69fe2e", "name": "Get voting results by voter group", "request": { "name": "Get voting results by voter group", "description": { "content": "Get voting results for a proposal broken down by voter group. Returns stored results when available, otherwise computes on-the-fly.", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId", "results", "grouped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "proposalId", "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "40fb5460-88ee-4168-86a6-f943f43d0d6c", "name": "Results per voter group", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "results", "grouped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"proposalId\": \"\",\n \"groups\": {\n \"key_0\": {\n \"results\": [\n {\n \"value\": \"\",\n \"label\": \"\",\n \"count\": \"\",\n \"votingPower\": \"\"\n },\n {\n \"value\": \"\",\n \"label\": \"\",\n \"count\": \"\",\n \"votingPower\": \"\"\n }\n ],\n \"totalVotes\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70ef8251-62e0-46a4-8983-98d894b1886f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "results", "grouped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44ae25ea-0128-4c63-8e3a-50fdb5e73f51", "name": "Internal server error", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "results", "grouped" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "72e5ccf2-9c66-4e20-ae6d-0dc880891de2", "name": "Get voting results for a proposal", "request": { "name": "Get voting results for a proposal", "description": { "content": "Get voting results for a specific proposal with vote counts and voting power", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "proposalId", "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5efa2184-7648-4e37-ab84-dfd61e61036c", "name": "The proposal object with voting results", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"ballotId\": \"\",\n \"ipfsHash\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"data\": {},\n \"voteType\": \"multi-choice\",\n \"minSelections\": \"\",\n \"maxSelections\": \"\",\n \"voteIncrement\": \"\",\n \"voterBudget\": \"\",\n \"requireAnswer\": false,\n \"voteOptions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n }\n ],\n \"commentCount\": \"\",\n \"voteCount\": \"\",\n \"votingPower\": \"\",\n \"result\": {},\n \"updatedAt\": \"\",\n \"createdAt\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"count\": \"\",\n \"votingPower\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"count\": \"\",\n \"votingPower\": \"\"\n }\n ],\n \"totalVotes\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "395b537b-14d5-4a75-8f58-5bbbbfe4778f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92af5a7e-53e0-4be6-a1f6-53292f6e47a8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "results" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "short", "description": "", "item": [ { "id": "ffb29c48-604a-4151-be38-bc61f97898b8", "name": "Get a shortened version of a proposal", "request": { "name": "Get a shortened version of a proposal", "description": { "content": "Get a shortened version of a proposal without detailed data", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId", "short" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "proposalId", "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1bea8daa-986f-4f46-97b8-c48e6b8c68e3", "name": "The proposal object without detailed data", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "short" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"ballotId\": \"\",\n \"ipfsHash\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"data\": {},\n \"voteType\": \"weighted\",\n \"minSelections\": \"\",\n \"maxSelections\": \"\",\n \"voteIncrement\": \"\",\n \"voterBudget\": \"\",\n \"requireAnswer\": false,\n \"voteOptions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n }\n ],\n \"commentCount\": \"\",\n \"voteCount\": \"\",\n \"votingPower\": \"\",\n \"result\": {},\n \"updatedAt\": \"\",\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6650ad34-a736-40d9-91ea-f01ebbd67c73", "name": "Resource not found", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "short" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68c86016-8b12-480a-b4ef-714aa7255a22", "name": "Internal server error", "originalRequest": { "url": { "path": [ "proposals", ":proposalId", "short" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "605e4d1e-6cc6-4a59-b59a-2efd42c461ca", "name": "Get a proposal by ID", "request": { "name": "Get a proposal by ID", "description": { "content": "Get a proposal by ID with voting statistics and user vote if authenticated", "type": "text/plain" }, "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "proposalId", "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "34a7223d-8b73-46dd-9c1b-ad78535f2b94", "name": "The proposal object with additional voting statistics", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"ballotId\": \"\",\n \"ipfsHash\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"data\": {},\n \"voteType\": \"ranked\",\n \"minSelections\": \"\",\n \"maxSelections\": \"\",\n \"voteIncrement\": \"\",\n \"voterBudget\": \"\",\n \"requireAnswer\": false,\n \"voteOptions\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"cost\": 1,\n \"description\": \"\",\n \"referenceUrl\": \"\",\n \"imageUrl\": \"\",\n \"metadata\": {}\n }\n ],\n \"commentCount\": \"\",\n \"voteCount\": \"\",\n \"votingPower\": \"\",\n \"result\": {},\n \"updatedAt\": \"\",\n \"createdAt\": \"\",\n \"voterVote\": [\n \"\",\n \"\"\n ],\n \"ballotStatus\": \"\",\n \"results\": {},\n \"totalVotes\": \"\",\n \"totalVoterCount\": \"\",\n \"totalVotingPower\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1abdf39b-b718-4bf6-aa4f-8b1570e8911c", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "615da9a1-265b-4689-aa50-d007c180f0e3", "name": "Resource not found", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2116ccf-d8e7-4850-bf91-6470201f05df", "name": "Internal server error", "originalRequest": { "url": { "path": [ "proposals", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the proposal to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "vote", "description": "", "item": [ { "name": "{proposalId}", "description": "", "item": [ { "id": "26240b47-1dfc-47da-baf3-eb234793d825", "name": "Submit or update a vote", "request": { "name": "Submit or update a vote", "description": { "content": "Submit or update a vote on a specific proposal", "type": "text/plain" }, "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "proposalId", "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cee235fe-ee0b-47ab-b126-5186709c5138", "name": "The saved vote object with indication if vote was changed", "originalRequest": { "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"userId\": \"\",\n \"ballotId\": \"\",\n \"proposalId\": \"\",\n \"vote\": [\n \"\",\n \"\"\n ],\n \"submittedVote\": [\n \"\",\n \"\"\n ],\n \"submittedAt\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"changes\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9d17094-6663-4d74-9ea6-02b7a6759765", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "016f32ad-0752-4569-88c2-7aeb32927bb7", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14649f1b-c6a5-4201-a7a3-7b204c0a1f4f", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d794903-b08f-4386-bb83-629cada2bce2", "name": "Resource not found", "originalRequest": { "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05e30945-61eb-449e-b866-35276f3f2575", "name": "Vote rejected because the ballot is outside its voting window.\n`code` is `VOTING_WINDOW_NOT_OPEN` before `votePeriodStart` or\n`VOTING_WINDOW_CLOSED` at/after `votePeriodEnd`.", "originalRequest": { "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"code\": \"VOTING_WINDOW_CLOSED\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e64a3956-6ef9-4258-95ba-7d0341aca58d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "vote", ":proposalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the proposal to vote on", "type": "text/plain" }, "type": "any", "value": "", "key": "proposalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vote\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "comments", "description": "", "item": [ { "name": "{commentId}", "description": "", "item": [ { "name": "replies", "description": "", "item": [ { "id": "c764d862-ef7c-4c4b-b0f0-122113a64f35", "name": "List replies to a comment", "request": { "name": "List replies to a comment", "description": { "content": "Paginated replies. Parent must exist and be live. Sorted by createdAt asc.", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "type": "any", "value": "", "key": "commentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "021b0ed9-9c22-4ae9-bc4b-56dc84b52a6e", "name": "Paginated replies with meta", "originalRequest": { "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"parentId\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"userLiked\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"drep\"\n },\n \"withdrawalDetails\": {}\n },\n {\n \"_id\": \"\",\n \"parentId\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"userLiked\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"user\"\n },\n \"withdrawalDetails\": {}\n }\n ],\n \"meta\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50e70ca7-aa71-4a88-8845-f6ba10c23b8a", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e12613cd-06eb-44c5-8e10-e10b500fa3f8", "name": "Resource not found", "originalRequest": { "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40578e22-a693-41dc-b427-0293fd48ab01", "name": "Internal server error", "originalRequest": { "url": { "path": [ "comments", ":commentId", "replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "like", "description": "", "item": [ { "id": "a404335c-9e6e-481a-88e1-71cf476649a3", "name": "Toggle like on a comment", "request": { "name": "Toggle like on a comment", "description": { "content": "Toggle like. 201 when like added, 200 when removed. Live comment only; before vote feedbackEndDate.", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "commentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9d09580c-a4a5-49e2-8a83-9f5901eb7375", "name": "Like removed", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\",\n \"liked\": \"\",\n \"likeCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c2717a2-c543-4c36-965f-2fc9d81b968b", "name": "Like added", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\",\n \"liked\": \"\",\n \"likeCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a92844a-80da-4db8-a7d8-e144137491a9", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af01e8d6-fa2a-44c6-a895-9ca5053c48e7", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25804480-970f-405e-bc32-0e0968a59c7c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ae1e659-667a-4718-88f1-4fb780bd44c5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "comments", ":commentId", "like" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "withdraw", "description": "", "item": [ { "id": "92b9a929-85a2-4715-a9b0-652d80aba6fc", "name": "Withdraw a comment (admin)", "request": { "name": "Withdraw a comment (admin)", "description": { "content": "Vote admin withdraws a live comment. Body category required. Until feedbackEndDate.", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "commentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Policy violation\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c57763fb-8fef-4c77-ac53-b1deabc3d105", "name": "Withdrawn comment", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Policy violation\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"proposalId\": \"\",\n \"parentId\": \"\",\n \"userId\": \"\",\n \"content\": \"\",\n \"status\": \"withdrawnByAdmin\",\n \"withdrawalDetails\": {\n \"category\": \"Inappropriate content\",\n \"userId\": \"\",\n \"comment\": \"\",\n \"date\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c338d2c-138b-4580-8fa9-00aa186d6498", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Policy violation\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1f3a4e4-2b97-49c0-8dd3-e1a099624181", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Policy violation\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a357593c-4998-4633-bac6-0281e3c90e42", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Policy violation\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e765cd3-8d5d-4507-9bd0-65380042313c", "name": "Resource not found", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Policy violation\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c31b4fd1-1ded-45af-a8be-77a87cd1df32", "name": "Internal server error", "originalRequest": { "url": { "path": [ "comments", ":commentId", "withdraw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"category\": \"Policy violation\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "670c23fe-6693-4efe-98bf-88ee15049f4c", "name": "Get a single comment", "request": { "name": "Get a single comment", "description": { "content": "Get comment by ID. Public sees live only; author sees own in any status; admin can filter by status.", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Status filter (admins only)", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "commentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d6524cbb-5215-4be4-9e25-f9e30928e664", "name": "Comment with author, replyCount, likeCount, userLiked", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Status filter (admins only)", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"parentId\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"userLiked\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"user\"\n },\n \"withdrawalDetails\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d5439a-9a92-4006-a979-b83f753ceb66", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Status filter (admins only)", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d9b6c5-4ee6-4eab-b2be-ea4e82319f1b", "name": "Resource not found", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Status filter (admins only)", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cef3303-0a0a-4111-9c61-0f6de41d5940", "name": "Internal server error", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Status filter (admins only)", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "81f6acb8-8088-484a-85ab-882fb8691261", "name": "Update comment content", "request": { "name": "Update comment content", "description": { "content": "Author only; within 15 minutes of creation.", "type": "text/plain" }, "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "commentId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "329b33b3-63e8-49e9-9e62-afc5f76e5cdd", "name": "Updated comment", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"proposalId\": \"\",\n \"parentId\": \"\",\n \"userId\": \"\",\n \"content\": \"\",\n \"status\": \"withdrawnByAdmin\",\n \"withdrawalDetails\": {\n \"category\": \"Inappropriate content\",\n \"userId\": \"\",\n \"comment\": \"\",\n \"date\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06234f13-6f52-4e94-9e73-a1b1975fa847", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2af0f39a-2464-4695-861a-99c5b2aae529", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27654b6e-34e0-45e5-b36f-efe746dec6bc", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "104d765b-7eb9-4889-8896-39aef3d52b38", "name": "Resource not found", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a14ea09-e2bc-4817-bba5-df3a574bd7ca", "name": "Internal server error", "originalRequest": { "url": { "path": [ "comments", ":commentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "commentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "c86e883e-d6e7-4e70-b190-f3a33ac29487", "name": "List top-level comments for a proposal", "request": { "name": "List top-level comments for a proposal", "description": { "content": "Paginated top-level comments for a proposal. Query parameter `proposal` (proposalId) is required.\nPublic users see only live comments. Admins can filter by status (live, withdrawn, withdrawnByAdmin).\nResponse includes author, replyCount, likeCount, userLiked (when authenticated).\n", "type": "text/plain" }, "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ID", "type": "text/plain" }, "key": "proposal", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (admins only; live, withdrawn, withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of date,replyCount,likeCount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type (comma-separated; proposer, admin, drep)", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c24a090-43aa-4ba7-9b5b-ceef2f6cfd30", "name": "Paginated comments with meta", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ID", "type": "text/plain" }, "key": "proposal", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (admins only; live, withdrawn, withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of date,replyCount,likeCount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type (comma-separated; proposer, admin, drep)", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"_id\": \"\",\n \"parentId\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"userLiked\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"drep\"\n },\n \"withdrawalDetails\": {}\n },\n {\n \"_id\": \"\",\n \"parentId\": \"\",\n \"content\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"replyCount\": \"\",\n \"likeCount\": \"\",\n \"userLiked\": \"\",\n \"author\": {\n \"_id\": \"\",\n \"name\": \"\",\n \"type\": \"user\"\n },\n \"withdrawalDetails\": {}\n }\n ],\n \"meta\": {\n \"page\": \"\",\n \"limit\": \"\",\n \"total\": \"\",\n \"totalPages\": \"\",\n \"hasNextPage\": \"\",\n \"hasPreviousPage\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b652d70-89e3-478c-8e26-9ce280c13d97", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ID", "type": "text/plain" }, "key": "proposal", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (admins only; live, withdrawn, withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of date,replyCount,likeCount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type (comma-separated; proposer, admin, drep)", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "608a973d-fc2a-422d-865d-b1b1757e7bae", "name": "Resource not found", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ID", "type": "text/plain" }, "key": "proposal", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (admins only; live, withdrawn, withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of date,replyCount,likeCount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type (comma-separated; proposer, admin, drep)", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff1b85f-3376-4265-9fc7-2af6953431fb", "name": "Internal server error", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Proposal ID", "type": "text/plain" }, "key": "proposal", "value": "" }, { "disabled": false, "description": { "content": "Filter by status (admins only; live, withdrawn, withdrawnByAdmin)", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of date,replyCount,likeCount)", "type": "text/plain" }, "key": "sort", "value": "date" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" }, { "disabled": false, "description": { "content": "Filter by author type (comma-separated; proposer, admin, drep)", "type": "text/plain" }, "key": "userType", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5571b523-3ceb-4fe2-ade7-0188f473198b", "name": "Create a comment", "request": { "name": "Create a comment", "description": { "content": "Create a comment on a live proposal. Auth required. Optional parentId for replies. Before vote feedbackEndDate.", "type": "text/plain" }, "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"\",\n \"content\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8f0a1fe4-880c-4ff5-876c-8dd88a079c01", "name": "Created comment", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"\",\n \"content\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"proposalId\": \"\",\n \"parentId\": \"\",\n \"userId\": \"\",\n \"content\": \"\",\n \"status\": \"withdrawnByAdmin\",\n \"withdrawalDetails\": {\n \"category\": \"Inappropriate content\",\n \"userId\": \"\",\n \"comment\": \"\",\n \"date\": \"\"\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fed9654-17d1-4d2f-af9c-66092daa36bd", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"\",\n \"content\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5674498c-cc4b-4179-99e4-0cfb7e9c31c5", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"\",\n \"content\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31063397-2ed5-4b74-89a8-40a68ee9b0aa", "name": "Resource not found", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"\",\n \"content\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b69c68da-e898-4cbf-a9d9-e72c2c00ba69", "name": "Internal server error", "originalRequest": { "url": { "path": [ "comments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"proposalId\": \"\",\n \"content\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "session", "description": "", "item": [ { "id": "538bdbb0-33d3-4b34-ae0b-b193ede5b1a9", "name": "Validate session", "request": { "name": "Validate session", "description": { "content": "Validate JWT token and return voter ID plus user profile (name, lastLogin), admin flag, native-script context, and active vote-package summary when available", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "984efa94-e605-4c78-8564-eafa2b4e8954", "name": "Voter ID, optional user profile, admin flag, native-script context, and pending vote packages", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userId\": \"\",\n \"isAdmin\": \"\",\n \"nativeScript\": {},\n \"pendingPackages\": [\n {\n \"id\": \"\",\n \"ballotId\": \"\",\n \"status\": \"awaiting-submission\",\n \"nonce\": \"\",\n \"signatureCount\": \"\",\n \"isMultisig\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"ballotId\": \"\",\n \"status\": \"awaiting-signatures\",\n \"nonce\": \"\",\n \"signatureCount\": \"\",\n \"isMultisig\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"name\": \"\",\n \"lastLogin\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cc30e2c-ea4c-41d8-9b3f-0e1b8a75b0f9", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f056c69-5534-4b5e-863d-d99900479a86", "name": "Request authentication nonce", "request": { "name": "Request authentication nonce", "description": { "content": "Request nonce for signing. Single endpoint for standard and multisig.\n- Standard: send signerAddress and signType; userId is the signer address.\n- Multisig: also send scriptAddress (CIP129 script address); userId in response is the script address.\nRate-limited (nonce requests per minute).\n", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0eeab276-7cb9-4fb7-8f8a-5b8a8aac55a1", "name": "Nonce to sign and voter identification data", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"dataHex\": \"\",\n \"userId\": \"\",\n \"userIdHex\": \"\",\n \"signerAddressHex\": \"\",\n \"calidusID\": \"\",\n \"scriptAddress\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e23e8a97-c2f5-40c4-9592-dfb36401ff89", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "496bfd8f-c861-4f57-8953-c498b021b5f0", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "635a5542-01f8-4003-b488-8aac200983d4", "name": "Verify signature and login", "request": { "name": "Verify signature and login", "description": { "content": "Verify signature and issue JWT. Single endpoint for standard and multisig.\n- Standard: send signerAddress, signType, signature.\n- Multisig: also send scriptAddress. Verifies signer is party to script.\nOn success, User lastLogin (and name for drep/stake/addr when fetched) is updated. Rate-limited.\n", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"signature\": {\n \"key_0\": \"string\",\n \"key_1\": 3616.010393020066\n },\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a17b6f3d-c28b-4bf2-82b7-deb295b0537b", "name": "JWT token and expiration information", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"signature\": {\n \"key_0\": \"string\",\n \"key_1\": 3616.010393020066\n },\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"token\": \"\",\n \"expiresIn\": \"\",\n \"userId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f88fffb-3b9b-4932-8272-bff2fd5da072", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"signature\": {\n \"key_0\": \"string\",\n \"key_1\": 3616.010393020066\n },\n \"scriptAddress\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b9b17fa-14a4-436d-b884-8d61cd0d2db1", "name": "Logout", "request": { "name": "Logout", "description": { "content": "Logout by clearing authentication cookie", "type": "text/plain" }, "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f88620d6-d865-4c8a-af0c-a962ddc1e5be", "name": "Success message confirming logout", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59df8a70-e998-43f8-9978-f7614667b121", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "session" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "dashboard", "description": "", "item": [ { "name": "ballots", "description": "", "item": [ { "id": "deecc13a-be7d-47d4-abe8-ac6836ab5229", "name": "Get ballots for voter", "request": { "name": "Get ballots for voter", "description": { "content": "Get all ballots the authenticated voter can vote on or has already voted on", "type": "text/plain" }, "url": { "path": [ "dashboard", "ballots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7f4a32af-0155-446c-81ce-ea6a84312aa0", "name": "List of ballots with voter-specific information (voting power)", "originalRequest": { "url": { "path": [ "dashboard", "ballots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"ipfsHash\": \"\",\n \"voterType\": \"\",\n \"voterGroups\": [\n {\n \"group\": \"pool\",\n \"powerSource\": \"StakeBased\",\n \"requirements\": {\n \"key_0\": \"string\"\n }\n },\n {\n \"group\": \"stake\",\n \"powerSource\": \"StakeBased\",\n \"requirements\": {\n \"key_0\": false,\n \"key_1\": 8988.382440018277\n }\n }\n ],\n \"voterDescription\": \"\",\n \"votePeriodStart\": \"\",\n \"votePeriodEnd\": \"\",\n \"voteFilters\": \"\",\n \"voteWeighted\": \"\",\n \"proposalPeriodStart\": \"\",\n \"proposalPeriodEnd\": \"\",\n \"resultTxHash\": \"\",\n \"status\": \"closed\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"votingPower\": \"\"\n },\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"ipfsHash\": \"\",\n \"voterType\": \"\",\n \"voterGroups\": [\n {\n \"group\": \"stake\",\n \"powerSource\": \"PledgeBased\",\n \"requirements\": {\n \"key_0\": false\n }\n },\n {\n \"group\": \"stake\",\n \"powerSource\": \"CredentialBased\",\n \"requirements\": {\n \"key_0\": 564.3106286022959\n }\n }\n ],\n \"voterDescription\": \"\",\n \"votePeriodStart\": \"\",\n \"votePeriodEnd\": \"\",\n \"voteFilters\": \"\",\n \"voteWeighted\": \"\",\n \"proposalPeriodStart\": \"\",\n \"proposalPeriodEnd\": \"\",\n \"resultTxHash\": \"\",\n \"status\": \"closed\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"votingPower\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "548f4d22-6ce0-4472-b614-9cf8af409b0c", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard", "ballots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "pending", "description": "", "item": [ { "id": "48433893-93f4-4299-adc3-4b781b74608e", "name": "Get pending votes", "request": { "name": "Get pending votes", "description": { "content": "Get all pending votes for the authenticated voter", "type": "text/plain" }, "url": { "path": [ "dashboard", "pending" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2bf9c7e0-7d7d-4885-8799-9504017def06", "name": "List of pending votes or message if no pending votes exist", "originalRequest": { "url": { "path": [ "dashboard", "pending" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a63a727-3f12-439a-be04-b9256be3435b", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard", "pending" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{ballotId}", "description": "", "item": [ { "name": "checkout", "description": "", "item": [ { "name": "multisig", "description": "", "item": [ { "name": "{transactionId}", "description": "", "item": [ { "id": "b6f8f5f2-67b3-466d-a990-5a062fb68d35", "name": "Get existing multisig transaction", "request": { "name": "Get existing multisig transaction", "description": { "content": "Request checkout for multisig with an existing transaction ID; returns the existing pending transaction data for that ballot and voter.", "type": "text/plain" }, "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" } }, { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ID of the existing pending transaction to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "718f4d97-e825-4935-aaf1-faa848305950", "name": "Existing transaction data for signing", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" }, { "disabled": false, "description": { "content": "(Required) ID of the existing pending transaction to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"userId\": \"\",\n \"ballotId\": \"\",\n \"merkleRoot\": \"\",\n \"votes\": {},\n \"dataHex\": \"\",\n \"userIdHex\": \"\",\n \"calidusID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31c0a97f-bd94-4518-951b-5b6a4b211354", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" }, { "disabled": false, "description": { "content": "(Required) ID of the existing pending transaction to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88e58664-571c-4e82-9402-34cb5cf8ee04", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" }, { "disabled": false, "description": { "content": "(Required) ID of the existing pending transaction to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6721a2c9-e542-4d08-998b-dbe457ab14a3", "name": "Resource not found", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" }, { "disabled": false, "description": { "content": "(Required) ID of the existing pending transaction to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "99b83e31-6ec6-46c1-b8db-b3056337c4c0", "name": "Request checkout for multisig (create or get transaction)", "request": { "name": "Request checkout for multisig (create or get transaction)", "description": { "content": "Request checkout for a ballot using multisig. Creates new transaction or returns existing one when transactionId is provided.", "type": "text/plain" }, "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c78a0f16-cf71-4c3a-9dde-ae52a22c81bd", "name": "Transaction data for signing", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"userId\": \"\",\n \"ballotId\": \"\",\n \"merkleRoot\": \"\",\n \"votes\": {},\n \"dataHex\": \"\",\n \"userIdHex\": \"\",\n \"calidusID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f66f8e8e-ab0b-45ce-9165-27faee713de7", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e7cc28d-ce82-468f-bab3-1f3b061503d4", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9ec26e-09d1-41b2-acb1-a4e532e9e4a3", "name": "Resource not found", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scriptAddress\": \"\",\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54913fbf-3890-4882-8f18-fff2529fb7cc", "name": "Submit multisig signature", "request": { "name": "Submit multisig signature", "description": { "content": "Submit a signature for a multisig transaction, finalizing votes if all required signatures are present", "type": "text/plain" }, "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bb4b259a-39f5-4623-ac6a-b74f57c99f57", "name": "Confirmation of submitted signature or finalized votes", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa2d66ee-d580-4453-bd06-708c4cb59901", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1525656e-d04c-4078-aa7c-578164cb8ca6", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fed12212-9f30-4bc0-836e-cb3ee3d27f8b", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cbfe097-e234-4a2b-bc5c-e0b7ea8ae1de", "name": "Resource not found", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout", "multisig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"scriptAddress\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "9db2eb68-3cb6-4bac-8716-e46d64781693", "name": "Request checkout for a ballot", "request": { "name": "Request checkout for a ballot", "description": { "content": "Request checkout for a ballot, creating transaction data for signing", "type": "text/plain" }, "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "315fba44-3fef-4780-9be6-5d81aaa88e1c", "name": "Transaction data for signing", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"userId\": \"\",\n \"ballotId\": \"\",\n \"merkleRoot\": \"\",\n \"votes\": {},\n \"dataHex\": \"\",\n \"userIdHex\": \"\",\n \"calidusID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd079f9-89e2-486d-a291-2a008675f3d4", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef194615-bdd9-41d5-96a2-da7f9f29ad35", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b55dba1d-bf35-42fd-a135-30070157c637", "name": "Resource not found", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot to checkout", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c8a6f15-dd2a-47ea-9c54-061e74e5241a", "name": "Submit signed transaction", "request": { "name": "Submit signed transaction", "description": { "content": "Submit a signed transaction to finalize votes for a ballot", "type": "text/plain" }, "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ballotId", "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": 8528\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "399d8157-4eaa-4a47-b8e6-c15f71636a7d", "name": "Confirmation of submitted votes with transaction ID", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": 8528\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\",\n \"transaction\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae6a165d-ceb4-425f-887a-1e1195321409", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": 8528\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb3f6ced-9855-47a2-81aa-b173fa77d1c3", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": 8528\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f594a70f-9e6f-4214-8921-60be6ef55d4f", "name": "Resource not found", "originalRequest": { "url": { "path": [ "dashboard", ":ballotId", "checkout" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the ballot", "type": "text/plain" }, "type": "any", "value": "", "key": "ballotId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"signerAddress\": \"\",\n \"signType\": \"\",\n \"data\": \"\",\n \"signature\": {\n \"key_0\": 8528\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "aeabadc9-f9c0-48b4-a6cc-dfa5f01a6c9f", "name": "Get dashboard information", "request": { "name": "Get dashboard information", "description": { "content": "Get authenticated voter stats including last login time and pending votes count", "type": "text/plain" }, "url": { "path": [ "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "97f1f82f-ae27-48ab-aba2-e679b4ad61a8", "name": "Voter information including voter ID, last login timestamp, and pending votes count", "originalRequest": { "url": { "path": [ "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userId\": \"\",\n \"lastLogin\": \"\",\n \"multiSig\": \"\",\n \"pendingVotesCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93157392-ecc6-4277-91f8-aaf6d88006c9", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "dashboard" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "transactions", "description": "", "item": [ { "name": "{transactionId}", "description": "", "item": [ { "id": "1a2839c3-f2d9-49f9-b7f9-712f8df2f9e1", "name": "Get a specific transaction", "request": { "name": "Get a specific transaction", "description": { "content": "Get a specific transaction by ID for the authenticated user", "type": "text/plain" }, "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) ID of the transaction to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "800deddd-c7fc-4cf2-b504-a16eea6d84e3", "name": "The requested transaction object", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the transaction to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"_id\": \"\",\n \"userId\": \"\",\n \"ballotId\": \"\",\n \"merkleRoot\": \"\",\n \"votes\": {\n \"key_0\": {\n \"proposalId\": \"\",\n \"vote\": [\n \"\",\n \"\"\n ]\n }\n },\n \"txHash\": \"\",\n \"status\": \"submitted\",\n \"signature\": {\n \"key_0\": 9433\n },\n \"multiSig\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": false,\n \"key_1\": 3030.325184412173\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d0ee4dc-022e-463b-abe7-e682934373b9", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the transaction to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d655e0fa-bc7c-4abb-8930-50b7afd540a7", "name": "Resource not found", "originalRequest": { "url": { "path": [ "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the transaction to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "ae348add-4771-437c-96ea-d9f39c5a2a4c", "name": "Get all transactions", "request": { "name": "Get all transactions", "description": { "content": "Get all transactions for the authenticated user", "type": "text/plain" }, "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "167df10b-806b-4e6b-8012-bc24b1643f7c", "name": "List of transactions for the user sorted by update time (descending)", "originalRequest": { "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"_id\": \"\",\n \"userId\": \"\",\n \"ballotId\": \"\",\n \"merkleRoot\": \"\",\n \"votes\": {\n \"key_0\": {\n \"proposalId\": \"\",\n \"vote\": [\n \"\",\n \"\"\n ]\n },\n \"key_1\": {\n \"proposalId\": \"\",\n \"vote\": [\n \"\",\n \"\"\n ]\n }\n },\n \"txHash\": \"\",\n \"status\": \"created\",\n \"signature\": {\n \"key_0\": 4259.501527064802\n },\n \"multiSig\": [\n {\n \"key_0\": 7790,\n \"key_1\": 4217.497251052678,\n \"key_2\": false,\n \"key_3\": 9376\n },\n {\n \"key_0\": false,\n \"key_1\": 598.5939196152268,\n \"key_2\": 8350.103109494896,\n \"key_3\": 4053\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"_id\": \"\",\n \"userId\": \"\",\n \"ballotId\": \"\",\n \"merkleRoot\": \"\",\n \"votes\": {\n \"key_0\": {\n \"proposalId\": \"\",\n \"vote\": [\n \"\",\n \"\"\n ]\n },\n \"key_1\": {\n \"proposalId\": \"\",\n \"vote\": [\n \"\",\n \"\"\n ]\n },\n \"key_2\": {\n \"proposalId\": \"\",\n \"vote\": [\n \"\",\n \"\"\n ]\n }\n },\n \"txHash\": \"\",\n \"status\": \"submitted\",\n \"signature\": {\n \"key_0\": 6413,\n \"key_1\": \"string\"\n },\n \"multiSig\": [\n {\n \"key_0\": \"string\",\n \"key_1\": 1320\n },\n {\n \"key_0\": 3744.4641278535464,\n \"key_1\": 5844\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "181aaf7d-5d11-47a3-819b-b4451630d7c6", "name": "Unauthorized - authentication required or invalid token", "originalRequest": { "url": { "path": [ "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "token", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "voters", "description": "", "item": [ { "name": "types", "description": "", "item": [ { "id": "ab10979d-3b9f-4860-a7dd-86f8da446183", "name": "Get voter type counts", "request": { "name": "Get voter type counts", "description": { "content": "Get counts of different voter types (stake, drep, pool)", "type": "text/plain" }, "url": { "path": [ "voters", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b1739e7c-2718-4386-a71e-b798cc0bcb90", "name": "Array of objects with voter type and count", "originalRequest": { "url": { "path": [ "voters", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"type\": \"drep\",\n \"count\": \"\"\n },\n {\n \"type\": \"stake\",\n \"count\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88c3625c-1ed4-48c7-af3b-13e7226b654c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "voters", "types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{userId}", "description": "", "item": [ { "id": "8d0be849-aaaf-463d-9003-ebbeab65baaa", "name": "Get voter details", "request": { "name": "Get voter details", "description": { "content": "Get detailed information about a specific voter including voting history", "type": "text/plain" }, "url": { "path": [ "voters", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userId", "disabled": false, "description": { "content": "(Required) The ID of the voter to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0bd85957-873a-4276-9312-955667434cc3", "name": "The voter object with voting history and statistics", "originalRequest": { "url": { "path": [ "voters", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the voter to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"voterType\": \"drep\",\n \"userId\": \"\",\n \"name\": \"\",\n \"votes\": [\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"votePeriodStart\": \"\",\n \"votePeriodEnd\": \"\",\n \"votingPower\": \"\",\n \"status\": \"\",\n \"proposals\": [\n {\n \"proposalId\": \"\",\n \"title\": \"\",\n \"voteType\": \"likert\",\n \"vote\": [\n \"\",\n \"\"\n ]\n },\n {\n \"proposalId\": \"\",\n \"title\": \"\",\n \"voteType\": \"budget\",\n \"vote\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"votePeriodStart\": \"\",\n \"votePeriodEnd\": \"\",\n \"votingPower\": \"\",\n \"status\": \"\",\n \"proposals\": [\n {\n \"proposalId\": \"\",\n \"title\": \"\",\n \"voteType\": \"ranked\",\n \"vote\": [\n \"\",\n \"\"\n ]\n },\n {\n \"proposalId\": \"\",\n \"title\": \"\",\n \"voteType\": \"scale\",\n \"vote\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"ballotsVoted\": \"\",\n \"proposalsVoted\": \"\",\n \"lastVoteDate\": \"\",\n \"lastLogin\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91c69c9f-3fad-46d4-83dc-36aa48a0d92d", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "voters", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the voter to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f32c2c25-d23c-4a1c-9644-27eaeb78d382", "name": "Resource not found", "originalRequest": { "url": { "path": [ "voters", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the voter to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffd53fde-6d96-48aa-80ea-f28679c04e5d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "voters", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The ID of the voter to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "c40c98e0-591c-4de8-afee-a1b7a54bcfb4", "name": "Get paginated list of voters", "request": { "name": "Get paginated list of voters", "description": { "content": "Get a paginated list of voters with filtering, sorting, and search capabilities", "type": "text/plain" }, "url": { "path": [ "voters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Case-insensitive substring match against either the bech32 / CIP-129\n`userId` OR the resolved display `name` (DRep metadata name or\nCardano Handle) from the User collection. Regex metacharacters are\nescaped. A single leading `$` is stripped before matching so a user\ntyping a handle as they see it rendered (`$adam`) still matches the\nbare stored name (`adam`); the match is substring-based so DRep\nnames that legitimately start with `$` are still findable either\nway.\n", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of userId,votes,lastLogin,lastVoteAt)", "type": "text/plain" }, "key": "sort", "value": "votes" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "96ab7c46-cb1f-4713-99bb-ce47410ebbc4", "name": "List of voters with pagination metadata", "originalRequest": { "url": { "path": [ "voters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Case-insensitive substring match against either the bech32 / CIP-129\n`userId` OR the resolved display `name` (DRep metadata name or\nCardano Handle) from the User collection. Regex metacharacters are\nescaped. A single leading `$` is stripped before matching so a user\ntyping a handle as they see it rendered (`$adam`) still matches the\nbare stored name (`adam`); the match is substring-based so DRep\nnames that legitimately start with `$` are still findable either\nway.\n", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of userId,votes,lastLogin,lastVoteAt)", "type": "text/plain" }, "key": "sort", "value": "votes" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "144e0c40-bbc4-4c41-bf84-83942f069c11", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "voters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Case-insensitive substring match against either the bech32 / CIP-129\n`userId` OR the resolved display `name` (DRep metadata name or\nCardano Handle) from the User collection. Regex metacharacters are\nescaped. A single leading `$` is stripped before matching so a user\ntyping a handle as they see it rendered (`$adam`) still matches the\nbare stored name (`adam`); the match is substring-based so DRep\nnames that legitimately start with `$` are still findable either\nway.\n", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of userId,votes,lastLogin,lastVoteAt)", "type": "text/plain" }, "key": "sort", "value": "votes" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfa3f2c8-3024-420b-93ef-4ae314cda244", "name": "Internal server error", "originalRequest": { "url": { "path": [ "voters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page number for pagination", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of items per page (max 100)", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Case-insensitive substring match against either the bech32 / CIP-129\n`userId` OR the resolved display `name` (DRep metadata name or\nCardano Handle) from the User collection. Regex metacharacters are\nescaped. A single leading `$` is stripped before matching so a user\ntyping a handle as they see it rendered (`$adam`) still matches the\nbare stored name (`adam`); the match is substring-based so DRep\nnames that legitimately start with `$` are still findable either\nway.\n", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Sort field (This can only be one of userId,votes,lastLogin,lastVoteAt)", "type": "text/plain" }, "key": "sort", "value": "votes" }, { "disabled": false, "description": { "content": "Sort direction (This can only be one of asc,desc)", "type": "text/plain" }, "key": "direction", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "faqs", "description": "", "item": [ { "id": "5bf40445-de86-4fb7-89ac-d2114aec56ab", "name": "Get all live FAQs", "request": { "name": "Get all live FAQs", "description": { "content": "Get all live FAQs with search and filtering capabilities. Only FAQs with is_live set to true are returned.", "type": "text/plain" }, "url": { "path": [ "faqs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term for FAQ title or content", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated, e.g., 'voter,proposer')", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by featured status (true or false) (This can only be one of true,false)", "type": "text/plain" }, "key": "featured", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3a69e73a-0105-4518-a9f8-33a1ca568f95", "name": "List of live FAQs matching the search and filter criteria", "originalRequest": { "url": { "path": [ "faqs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term for FAQ title or content", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated, e.g., 'voter,proposer')", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by featured status (true or false) (This can only be one of true,false)", "type": "text/plain" }, "key": "featured", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"content\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"content\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e96505b-3f97-4c7f-a884-1af7ad33ec1c", "name": "Bad request - invalid parameters or data", "originalRequest": { "url": { "path": [ "faqs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term for FAQ title or content", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated, e.g., 'voter,proposer')", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by featured status (true or false) (This can only be one of true,false)", "type": "text/plain" }, "key": "featured", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ad4a617-b6cc-4a1f-a2df-e6eaedb2768d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "faqs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search term for FAQ title or content", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by tags (comma-separated, e.g., 'voter,proposer')", "type": "text/plain" }, "key": "tags", "value": "" }, { "disabled": false, "description": { "content": "Filter by featured status (true or false) (This can only be one of true,false)", "type": "text/plain" }, "key": "featured", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://app.ekklesia.vote" } ], "info": { "_postman_id": "404b1128-10b7-442e-93e7-00a28970b491", "name": "Ekklesia Voting Backend API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The Ekklesia Voting Backend API. v0 is the archival + live-read surface: ballot, proposal, vote, voter, transaction, and dashboard resources are read-only (writes return HTTP 410 with a v1 pointer); session, comments, and FAQs remain live and back both versions. See openapi.v1.yaml for the Hydra-backed live surface and the Voting API overview page for cross-cutting behavior (dual-id resolution, query hygiene, authentication).\n\n\nContact Support:\n Name: Adam Dean, Mad Orkestra", "type": "text/plain" } } }