Download OpenAPI specification:Download
Welcome to the HumHub polls module API reference.
The number of page of the result set.
The numbers of items to return per page.
Success
{"total": 76,"page": 1,"pages": 8,"links": {"self": "{endpoint_path}?page=1&per-page=10","next": "{endpoint_path}?page=2&per-page=10","last": "{endpoint_path}?page=8&per-page=10"},"results": [{"id": 4,"contentcontainer_id": 2,"question": "Poll question from API?","description": "Poll description from API","allow_multiple": 1,"created_at": "2021-07-20 09:43:12","created_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"updated_at": "2021-07-20 09:43:12","updated_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"is_random": 1,"closed": 1,"anonymous": 0,"show_result_after_close": 0,"answers": [{"id": 1,"poll_id": 4,"answer": "First answer text","created_at": "2021-07-20 10:43:12","created_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"updated_at": "2021-07-20 10:43:12","updated_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"}}],"content": {"metadata": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","object_model": "humhub\\modules\\post\\models\\Post","object_id": 12,"visibility": 1,"archived": true,"pinned": false,"locked_comments": false,"created_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"created_at": "2022-04-13 05:15:43","url": "http://localhost/p/humhub/master/content/perma?id=109","contentcontainer_id": 5,"stream_channel": "default"},"comments": {"total": 55,"latestComments": [{"id": 14,"message": "Calvin Klein – Between love and madness lies obsession.","createdBy": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"createdAt": "2018-08-09 14:22:03"}]},"likes": {"total": 35},"files": {"id": 14,"guid": "bded6dc7-e6f4-417e-a638-b653525529ca","mime_type": "text/plain","size": 14353,"file_name": "image.jpg","url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"},"topics": [{"id": 135,"name": "News"}]}}]}
ID of content container
Not found
The id of content container
{"code": 200,"message": "Records successfully deleted!"}
Poll information
New answers
Forbidden
Validation failed
Internal server error
{"Poll": {"question": "New question from API?","description": "New description from API?","allow_multiple": 0,"is_random": 1,"anonymous": 0,"show_result_after_close": 0},"newAnswers": ["First answer","Second answer","Third answer"],"content": {"metadata": {"visibility": 1,"archived": true,"pinned": false,"locked_comments": false},"topics": [{"name": "News"}]}}
{"id": 4,"contentcontainer_id": 2,"question": "Poll question from API?","description": "Poll description from API","allow_multiple": 1,"created_at": "2021-07-20 09:43:12","created_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"updated_at": "2021-07-20 09:43:12","updated_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"is_random": 1,"closed": 1,"anonymous": 0,"show_result_after_close": 0,"answers": [{"id": 1,"poll_id": 4,"answer": "First answer text","created_at": "2021-07-20 10:43:12","created_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"updated_at": "2021-07-20 10:43:12","updated_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"}}],"content": {"metadata": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","object_model": "humhub\\modules\\post\\models\\Post","object_id": 12,"visibility": 1,"archived": true,"pinned": false,"locked_comments": false,"created_by": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"created_at": "2022-04-13 05:15:43","url": "http://localhost/p/humhub/master/content/perma?id=109","contentcontainer_id": 5,"stream_channel": "default"},"comments": {"total": 55,"latestComments": [{"id": 14,"message": "Calvin Klein – Between love and madness lies obsession.","createdBy": {"id": 14,"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80","display_name": "John Doe","url": "http://localhost/p/humhub/master/u/j.doe/"},"createdAt": "2018-08-09 14:22:03"}]},"likes": {"total": 35},"files": {"id": 14,"guid": "bded6dc7-e6f4-417e-a638-b653525529ca","mime_type": "text/plain","size": 14353,"file_name": "image.jpg","url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"},"topics": [{"id": 135,"name": "News"}]}}
The id of the poll
Updating answers
{"Poll": {"question": "New question from API?","description": "New description from API?","allow_multiple": 0,"is_random": 1,"anonymous": 0,"show_result_after_close": 0},"answers": [{"1": "Updated first answer"},{"2": "Updated second answer"},{"3": "Updated third answer"}],"newAnswers": ["Fourth answer","Fifth answer"],"content": {"metadata": {"visibility": 1,"archived": true,"pinned": false,"locked_comments": false},"topics": [{"name": "News"}]}}
Bad request
{"code": 200,"message": "Successfully deleted!"}
{"code": 200,"message": "Poll has been successfully closed."}
{"code": 200,"message": "Poll has been successfully reopened."}
Selected answers
{"answers": [1,4]}
{"code": 200,"message": "You have voted."}
{"code": 200,"message": "You have reset your vote."}
[[11,13,24]]