Poll Pro Main Page
API docs by Redocly

Poll Pro REST API (1.0.0)

Download OpenAPI specification:Download

PJ Neethling: admin@pollpro.co.za URL: https://www.pollpro.co.za License: GPL-3.0 License

Poll Pro API provides an API to create polls and vote on polls.

Poll Pro Api API Documentation

This is the official rest api documentation for the PollPro Api

Health check

Check the current server health status.

Responses

Polls

Create Poll

Create a Poll that votes will have votes

Request Body schema: application/json
name
required
string

Poll name

description
string

Poll description

required
Array of objects

List of items

startDate
required
string

Poll start date and time

endDate
string

Poll end date and time

Responses

Request samples

Content type
application/json
{
  • "name": "Best VS Plugins",
  • "description": "Best Visual Studio plugin to use for a developer",
  • "items": [
    ],
  • "startDate": "2023-07-20 12:00:00.000",
  • "endDate": "2023-07-25 16:00:00.000"
}

Response samples

Content type
application/json
{
  • "id": "e05e22bf-bbf9-4d3d-b6e8-cb18d9de5519",
  • "name": "Best VS Plugins",
  • "description": "Best Visual Studio plugin to use for a developer",
  • "items": [
    ],
  • "startDate": "2023-07-20 12:00:00.000",
  • "endDate": "2023-07-25 16:00:00.000"
}

Get Poll

Get the details of a Poll

Responses

Response samples

Content type
application/json
{
  • "id": "e05e22bf-bbf9-4d3d-b6e8-cb18d9de5519",
  • "name": "Best VS Plugins",
  • "description": "Best Visual Studio plugin to use for a developer",
  • "items": [
    ],
  • "startDate": "2023-07-20 12:00:00.000",
  • "endDate": "2023-07-25 16:00:00.000"
}

Votes

Create Poll Vote

Create a vote for a spesific poll

Request Body schema: application/json
itemId
required
string

The guid id of the poll item.

Responses

Request samples

Content type
application/json
{
  • "itemId": "e05e22bf-bbf9-4d3d-b6e8-cb18d9de5519"
}