Loading ...

REST API: Create Poll | Communifire Documentation

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

REST API: Create Poll

0 
 /5
0 (0votes)

Create Poll

POST /api/polls

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

Method Details

HTTP Method
POST
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.
Poll JSON Used in the request Body This is JSON that represents a poll object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
Question Used in the request Body This refers to the question of the poll.
Choice Used in the request Body This refers to the poll choice name.
AssociatedInputControl  Used in the request Body

This refers to the poll's choice input type.

0 = Radio Button
1 = Checkbox
2 = Textbox
3 = TextArea

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

Request JSON sample for creating a new poll

{
    "Question": "What is your fav color",
     "PollChoices" : [{
        "Choice": "Red",
        "AssociatedInputControlType": 0
      },
      {
        "Choice": "Green",
        "AssociatedInputControlType": 0
      }]
}

Response JSON sample where poll JSON object is returned as ResponseData


{
  "IsError": false,
  "ResponseMessage": "The content is published.",
  "ResponseData": {
    "PollID": 107,
    "Question": "What is your fav color",
    "IsLatest": false,
    "IsSurvey": false,
    "CreatedBy": 376,
    "Votes": 0,
    "DateCreated": "2019-05-22T10:23:54.6126182Z",
    "SpaceID": 0,
    "MediaServerID": 48,
    "AllowSurveyRetake": false,
    "PollChoices": [
   {
    "ChoiceID": 0,
    "PollID": 0,
    "QuestionID": 0,
    "Points": 0,
    "UserID": 0,
    "Choice": "Red",
    "Votes": 0,
    "AssociatedInputControlType": 0,
    "PollQuestionInputControlType": 0,
    "SortOrder": 0,
    "TenantID": 0
   },
   {
    "ChoiceID": 0,
    "PollID": 0,
    "QuestionID": 0,
    "Points": 0,
    "UserID": 0,
    "Choice": "Green",
    "Votes": 0,
    "AssociatedInputControlType": 0,
    "PollQuestionInputControlType": 0,
    "SortOrder": 0,
    "TenantID": 0
   }
  ],
 "TenantID": 1
 }
}


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

Wiki Index

Pages

Intranet Software