Loading ...

REST API: Get Poll | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Polls and Surveys » REST API: Get Poll
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Poll

0 
 /5
0 (0votes)

Get Poll

GET  /api/polls/{pollid}

Allow user to get a specific poll. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
PollID Used in the request URL (see below) Unique ID for a Poll.

Example URL: https://your-community.com/api/polls/{pollid}

Response JSON sample where poll JSON object is returned as ResponseData

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
     "ChoiceID": 16,
     "Choice": "Green",
     "Votes": 0,
     "Percentage": 0,
     "ChoiceSortOrder": 1,
     "QuestionText": "What is your favorite color?"
   },
   {
     "ChoiceID": 17,
     "Choice": "Red",
     "Votes": 1,
     "Percentage": 100,
     "ChoiceSortOrder": 2,
     "QuestionText": "What is your favorite color?"
   },
   {
     "ChoiceID": 18,
     "Choice": "Blue",
     "Votes": 0,
     "Percentage": 0,
     "ChoiceSortOrder": 3,
     "QuestionText": "What is your favorite color?"
    }
 ],
}

Please Note The content type that you pass in the header of your request should be 'application/json'.

Wiki Index

Pages

Intranet Software