API to Get Survey Details 1

Owned by Enterprise IT
May 10, 2024

This new web services API has been added to get the survey details. It provides all details of the survey such as CSAT ID, survey questions, ratings, group name, feedback type, comments, and answers.  

Service NameHTTP Method
GetSurveyDetails

POST

Sample Request

Json Format
{ 

    "ServiceName": "GetSurveyDetails", 

    "objCommonParameters": { 

        "_ProxyDetails": { 

            "SAASOrgID": "0", 

            "LoginUID": 0, 

            "RequestType": "mobile", 

            "MobileVersion": "5.10.3", 

            "Password": "abc", 

            "AuthType": "FORM", 

            "ProxyID": 0, 

            "OrgID": "1", 

            "TokenID": "", 

            "ReturnType": "JSON", 

            "UserName": "abc.efg@xyz.com" 

        }, 

        "UserID": 197, 

        "CSAT_ID": 21 

    } 

}                     

Request Parameters 

Parameter Name 

Type 

Description 

Mandatory 

SAAS Org ID 

String 

Name of the user.  

True 

Login UID 

String 

Specifies the Login user ID. 

True 

Request Type 

String 

Specifies the device from which the request was made.  

True 

Mobile Version 

Integer 

Specifies the version of the mobile used. 

True 

Password 

String 

Specifies the password of the user. 

True 

Auth Type 

String 

Specifies the authentication type used.  

True 

Org ID 

String 

Specifies the organization ID. 

True 

UserName 

String 

Specifies the username of the user. 

True 

UserID 

String 

Specifies the user ID of the user. 

True 

Sample Response

Json Format
{ 

    "Errors": "", 

    "Message": null, 

    "Output": "", 

    "TokenID": "62C06A8BC37F2365357F6EC9DE638392714F429C6A95972F3081E1A3DBA4D56FEE4B4199B438718D6C3EAC8A83ED31CF3280C3D356D1B25E2037DAEA124BD72B3B4DEA858717908A2B290B57B6B4B389E41286C643608326BE7993A053B23F2EE8F55FF20272D1A051D06CAD7180803D41336BB123BE0AC31EA3E1C47462A0040125C1E2A2B76AA2AD487CF6B530D7DC", 

    "OrgID": 0, 

    "OutputObject": { 

        "SurveyDetails": { 

            "Questions": [ 

                { 

                    "FdQ_Id": 14, 

                    "CSAT_ID": "21", 

                    "Org_Id": 1, 

                    "Fd_Question": "BRU Question 1", 

                    "Active": true, 

                    "sort_Order": 0, 

                    "Rating": null, 

                    "GroupName": "DEMO", 

                    "FeedbackTypeName": "Star Rating", 

                    "IsMandatory": false, 

                    "CommentsNeeded": "NA", 

                    "Comments": null, 

                    "AnswerTypeText": "U+2605", 

                    "CSAT_FBDetails_ID": null, 

                    "AnswerID": null, 

                    "GrpSortOrder": 0.00 

                }, 

                { 

                    "FdQ_Id": 15, 

                    "CSAT_ID": "21", 

                    "Org_Id": 1, 

                    "Fd_Question": "Question1", 

                    "Active": true, 

                    "sort_Order": 0, 

                    "Rating": null, 

                    "GroupName": "DEMO", 

                    "FeedbackTypeName": "Star Rating", 

                    "IsMandatory": false, 

                    "CommentsNeeded": "NA", 

                    "Comments": null, 

                    "AnswerTypeText": "U+2605", 

                    "CSAT_FBDetails_ID": null, 

                    "AnswerID": null, 

                    "GrpSortOrder": 0.00 

                } 

            ], 

            "Answers": [ 

                { 

                    "AnswerID": 66, 

                    "CSAT_ID": 21, 

                    "Rating": 1, 

                    "Column_Name": null, 

                    "Column_Color": "#ff0000", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 14, 

                    "IsPoorRated": true, 

                    "AnswerText": "Not Satisfactory", 

                    "ColorClass": "label-primary14", 

                    "FeedbackSubTypeID": 1 

                }, 

                { 

                    "AnswerID": 67, 

                    "CSAT_ID": 21, 

                    "Rating": 2, 

                    "Column_Name": null, 

                    "Column_Color": "#ffcc00", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 14, 

                    "IsPoorRated": false, 

                    "AnswerText": "Average", 

                    "ColorClass": "label-danger14", 

                    "FeedbackSubTypeID": 2 

                }, 

                { 

                    "AnswerID": 68, 

                    "CSAT_ID": 21, 

                    "Rating": 3, 

                    "Column_Name": null, 

                    "Column_Color": "#ccff66", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 14, 

                    "IsPoorRated": false, 

                    "AnswerText": "Good", 

                    "ColorClass": "label-info14", 

                    "FeedbackSubTypeID": 3 

                }, 

                { 

                    "AnswerID": 69, 

                    "CSAT_ID": 21, 

                    "Rating": 4, 

                    "Column_Name": null, 

                    "Column_Color": "#99ff66", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 14, 

                    "IsPoorRated": false, 

                    "AnswerText": "Very Good", 

                    "ColorClass": "label-good14", 

                    "FeedbackSubTypeID": 4 

                }, 

                { 

                    "AnswerID": 70, 

                    "CSAT_ID": 21, 

                    "Rating": 5, 

                    "Column_Name": null, 

                    "Column_Color": "#00cc33", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 14, 

                    "IsPoorRated": false, 

                    "AnswerText": "Excellent", 

                    "ColorClass": "label-success14", 

                    "FeedbackSubTypeID": 5 

                }, 

                { 

                    "AnswerID": 71, 

                    "CSAT_ID": 21, 

                    "Rating": 1, 

                    "Column_Name": null, 

                    "Column_Color": "#ff0000", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 15, 

                    "IsPoorRated": true, 

                    "AnswerText": "Not Satisfactory", 

                    "ColorClass": "label-primary15", 

                    "FeedbackSubTypeID": 1 

                }, 

                { 

                    "AnswerID": 72, 

                    "CSAT_ID": 21, 

                    "Rating": 2, 

                    "Column_Name": null, 

                    "Column_Color": "#ffcc00", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 15, 

                    "IsPoorRated": false, 

                    "AnswerText": "Average", 

                    "ColorClass": "label-danger15", 

                    "FeedbackSubTypeID": 2 

                }, 

                { 

                    "AnswerID": 73, 

                    "CSAT_ID": 21, 

                    "Rating": 3, 

                    "Column_Name": null, 

                    "Column_Color": "#ccff66", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 15, 

                    "IsPoorRated": false, 

                    "AnswerText": "Good", 

                    "ColorClass": "label-info15", 

                    "FeedbackSubTypeID": 3 

                }, 

                { 

                    "AnswerID": 74, 

                    "CSAT_ID": 21, 

                    "Rating": 4, 

                    "Column_Name": null, 

                    "Column_Color": "#99ff66", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 15, 

                    "IsPoorRated": false, 

                    "AnswerText": "Very Good", 

                    "ColorClass": "label-good15", 

                    "FeedbackSubTypeID": 4 

                }, 

                { 

                    "AnswerID": 75, 

                    "CSAT_ID": 21, 

                    "Rating": 5, 

                    "Column_Name": null, 

                    "Column_Color": "#00cc33", 

                    "Active": true, 

                    "Comments_Req_Below": null, 

                    "FdQ_Id": 15, 

                    "IsPoorRated": false, 

                    "AnswerText": "Excellent", 

                    "ColorClass": "label-success15", 

                    "FeedbackSubTypeID": 5 

                } 

            ] 

        } 

    }, 

    "OutputID": 0, 

    "Input": null, 

    "Token_Expire_InSecs": 0 

}

Status and Error Codes

For more information, see Status and Error Messages.