Loading ...

REST API: Submit Survey Votes | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Polls and Surveys » REST API: Submit Survey Votes
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Submit Survey Votes

0 
 /5
0 (0votes)

Submit Survey Votes

POST /api/surveys/{SurveyID}/votes

Submit votes for a specified survey.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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.
Votes JSON Used in the request body This is JSON that represents a vote 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.
QuestionID Used in the request body The unique identifier for the question.
ChoiceID Used in the request body The unique identifier for the selected choice.
CheckBoxChoiceCSV Used in the request body A list of selected choices for checkbox questions.
TextBoxChoiceText Used in the request body The text input provided for text box questions.
Optional              Parameters How to use Description
LogView &logView=true - Used in the request URL  Logs the API call as an action in User Activity when set to true

Example Request

POST https://mycommunifire.com/api/surveys/145/votes?token=XvrTzg

Request JSON sample for adding votes


[
     {
      "QuestionID": 168,
      "ChoiceID": 353
    },
    {
      "QuestionID": 170,
      "CheckBoxChoiceCsv": "355,356"
    },
    {
      "QuestionID": 169,
      "TextBoxChoiceText": "Mobile App"
    }
]

Response JSON sample where votes are returned as ResponseData


{
   
    "IsError": false,
    "ResponseMessage": "Successfully submitted the survey."
}

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

 

Wiki Index

Pages

Intranet Software