Loading ...

REST API: Get Survey | Communifire Documentation

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

REST API: Get Survey

0 
 /5
0 (0votes)

Get Survey

GET  /api/surveys/{SurveyID}

 Get a specific survey. 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.
SurveyID Used in the request URL (see below) Unique ID for a survey.
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

GET https:/mycommunifire.com/api/surveys/145?LogView=true&token=XjeRs

Response JSON sample where survey JSON object is returned as ResponseData

{
   "IsError": false,
    "ResponseMessage": "",
    "ResponseData": {
        "PollID": 145,
        "Question": "Favorite Desserts",
        "SurveyTitle": "Favorite Desserts",
        "UserName": "Alexis",
        "IsLatest": false,
        "IsSurvey": true,
        "DateClose": "2024-07-03T14:55:52.427",
        "CreatedBy": 950,
        "Votes": 3,
        "DateCreated": "2024-07-03T14:55:52.427",
        "SpaceID": 418,
        "SpaceName": "",
        "MediaServerID": 64,
        "SurveyImageFileName": "e6f00907-1f46-4670-bacd-71792781c90c.png",
        "AllowSurveyRetake": true,
        "PollUrl": "https://mycommunifire.com/spaces/418/fun-space/surveys/145/favorite-desserts",
        "UserProfileURL": "https://mycommunifire.com/people/Alexis",
        "UserDisplayName": "Alexis Fox",
        "UserAvatarFullUrl": "https://mycommunifire.com/Assets/Uploaded-Photos/5e957294-635a-444d-9b07-0185d53ebc6c.jpg",
        "DateTimeSpan": "yesterday",
        "SurveyImageUrl": "https://mycommunifire.com/Assets/Uploaded-CMS-Files/e6f00907-1f46-4670-bacd-71792781c90c.png",
        "CurrentUserChoiceID": 0,
        "PollQuestions": [
            {
                "QuestionID": 168,
                "QuestionText": "What is your favorite type of dessert?",
                "PollID": 145,
                "SortOrder": 1,
                "InputControlType": 1,
                "InputControlTypeInt": 1,
                "Choices": [
                    {
                        "ChoiceID": 351,
                        "PollID": 145,
                        "QuestionID": 168,
                        "Points": 20,
                        "UserID": 0,
                        "Choice": "Ice Cream",
                        "Votes": 0,
                        "PollQuestionInputControlType": 0,
                        "SortOrder": 1,
                        "ChoiceImageFileName": "",
                        "TenantID": 0
                    },
                    {
                        "ChoiceID": 352,
                        "PollID": 145,
                        "QuestionID": 168,
                        "Points": 20,
                        "UserID": 0,
                        "Choice": "Cake",
                        "Votes": 0,
                        "PollQuestionInputControlType": 0,
                        "SortOrder": 2,
                        "ChoiceImageFileName": "",
                        "TenantID": 0
                    },
                    {
                        "ChoiceID": 353,
                        "PollID": 145,
                        "QuestionID": 168,
                        "Points": 50,
                        "UserID": 0,
                        "Choice": "Fruits",
                        "Votes": 1,
                        "PollQuestionInputControlType": 0,
                        "SortOrder": 3,
                        "ChoiceImageFileName": "",
                        "TenantID": 0
                    }
                ],
                "TenantID": 0
            },
            {
                "QuestionID": 169,
                "QuestionText": "Please specify your favorite ice cream flavor ",
                "PollID": 145,
                "SortOrder": 2,
                "InputControlType": 2,
                "InputControlTypeInt": 2,
                "TenantID": 0
            },
            {
                "QuestionID": 170,
                "QuestionText": "Which toppings do you like on your desserts? ",
                "PollID": 145,
                "SortOrder": 3,
                "InputControlType": 1,
                "InputControlTypeInt": 1,
                "Choices": [
                    {
                        "ChoiceID": 354,
                        "PollID": 145,
                        "QuestionID": 170,
                        "Points": 10,
                        "UserID": 0,
                        "Choice": "Whipped Cream",
                        "Votes": 0,
                        "PollQuestionInputControlType": 0,
                        "SortOrder": 1,
                        "ChoiceImageFileName": "",
                        "TenantID": 0
                    },
                    {
                        "ChoiceID": 355,
                        "PollID": 145,
                        "QuestionID": 170,
                        "Points": 20,
                        "UserID": 0,
                        "Choice": "Nuts",
                        "Votes": 0,
                        "PollQuestionInputControlType": 0,
                        "SortOrder": 2,
                        "ChoiceImageFileName": "",
                        "TenantID": 0
                    },
                    {
                        "ChoiceID": 356,
                        "PollID": 145,
                        "QuestionID": 170,
                        "Points": 10,
                        "UserID": 0,
                        "Choice": "Chocolate Sauce",
                        "Votes": 0,
                        "PollQuestionInputControlType": 0,
                        "SortOrder": 3,
                        "ChoiceImageFileName": "",
                        "TenantID": 0
                    },
                    {
                        "ChoiceID": 357,
                        "PollID": 145,
                        "QuestionID": 170,
                        "Points": 20,
                        "UserID": 0,
                        "Choice": "Other",
                        "Votes": 0,
                        "AssociatedInputControlType": 2,
                        "PollQuestionInputControlType": 0,
                        "SortOrder": 4,
                        "ChoiceImageFileName": "",
                        "TenantID": 0
                    }
                ],
                "TenantID": 0
            }
        ],
        "EntityID": 0,
        "SurveyTestMode": false,
        "HasUserVotedForSurvey": true,
        "IsAnonymous": false,
        "TenantID": 1
    }
 ],
}

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

Wiki Index

Pages

Intranet Software