Loading ...

REST API: Get Polls | Communifire Documentation

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

REST API: Get Polls

0 
 /5
0 (0votes)

Get Polls

GET  /api/polls/list

Get a list of polls. 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.
Optional Parameters How to use Description
SpaceID Used in the request URL (see below) Unique ID for space.
SpaceIDCSV Used in the request URL. Comma-separated list of space IDs to get polls for.
StartPage &startpage=x - Used in the request URL (see below) Specifies the starting page of list to be returned.
PageLength &pagelength=x - Used in the request URL (see below)
 Specifies the number of results to be returned per page.

Example URL to GET: https://your-community.com/api/polls/list?spaceID=14

Response JSON sample where poll JSON object is returned as ResponseData


 {
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "PollID": 102,
      "Question": "What is your favorite color? ",
      "SurveyTitle": "",
      "UserName": "admin",
      "IsLatest": false,
      "IsSurvey": false,
      "DateClose": "2018-05-25T21:14:25.343",
      "CreatedBy": 376,
      "Votes": 1,
      "DateCreated": "2018-05-25T21:14:25.343",
      "SpaceID": 0,
      "MediaServerID": 28,
      "SurveyImageFileName": "",
      "AllowSurveyRetake": false,
      "PollUrl": "https://your-community.com/poll/102/what-is-your-favorite-color",
      "UserProfileURL": "https://your-community.com/people/admin",
      "UserDisplayName": "Alexis Fox",
      "UserAvatarFullUrl": "https://your-community.com/Assets/Uploaded-Photos/376/f9c8486c-f3f3-41f9-9f46-044093247dc9.jpg",
      "DateTimeSpan": "5/25/2018",
      "PollChoices": [
        {
          "ChoiceID": 203,
          "PollID": 102,
          "QuestionID": 0,
          "Points": 0,
          "UserID": 0,
          "Choice": "Blue",
          "Votes": 1,
          "PollQuestionInputControlType": 0,
          "SortOrder": 1,
          "TenantID": 0
        },
        {
          "ChoiceID": 204,
          "PollID": 102,
          "QuestionID": 0,
          "Points": 0,
          "UserID": 0,
          "Choice": "Red",
          "Votes": 0,
          "PollQuestionInputControlType": 0,
          "SortOrder": 2,
          "TenantID": 0
        }
      ],
      "TenantID": 0
    }
  ]
}


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

Wiki Index

Pages

Intranet Software