API / SurveyQuestion

Entity Description:

SurveyQuestion is a preformatted entity that can be inserted into an email message to solicit a response to a question from a recipient (e.g. Yes or No, Like or Dislike, Select 1-2 or 3, etc…). Results will be found on the bottom of the metrics reports page. Multiple survey answers will appear on the same metrics page.

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
SurveyID
Int32
GUID
String
Type
Int32
QuestionText
String
DisplayOrder
Int32
ResponseCharacterLimit
Int32
SimpleQuestionType
Int32
CreationDate
DateTime

Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a SurveyQuestion

Request

POST /api/odata/SurveyQuestions

Content-Type 

application/json

Request body

{
"ID":"0","SurveyID":"0","GUID":"0","Type":"0","QuestionText":"Example Question","DisplayOrder":"0","ResponseCharacterLimit":"0",
"SimpleQuestionType":"0","CreationDate":"2014-11-19T12:00:00.000Z"
}

Response body

{
"ID":1,"SurveyID":0,"GUID":"0","Type":0,"QuestionText":"Example Question","DisplayOrder":0,"ResponseCharacterLimit":0,
"SimpleQuestionType":0,"CreationDate":"2014-11-20T12:00:00.000Z"
}
Deleting a SurveyQuestion
 Request
 DELETE /api/odata/SurveyQuestions(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a SurveyQuestion
 Request
 GET /api/odata/SurveyQuestions(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"SurveyID":0,"GUID":"0","Type":0,"QuestionText":"Example Question","DisplayOrder":0,"ResponseCharacterLimit":0,
"SimpleQuestionType":0,"CreationDate":"2014-11-20T12:00:00.000Z"
}
Updating a SurveyQuestion
 Request
 PUT /api/odata/SurveyQuestions(1)
 Content-Type 
 application/json
 Request body
 {
"ID":"0","SurveyID":"0","GUID":"0","Type":"0","QuestionText":"Example Question","DisplayOrder":"0","ResponseCharacterLimit":"0",
"SimpleQuestionType":"0","CreationDate":"2014-11-19T12:00:00.000Z"
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all SurveyQuestions
 Request
 GET /api/odata/SurveyQuestions
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"SurveyID":0,"GUID":"0","Type":0,"QuestionText":"Example Question","DisplayOrder":0,"ResponseCharacterLimit":0,
"SimpleQuestionType":0,"CreationDate":"2014-11-19T12:00:00.000Z"
},{
"ID":1,"SurveyID":0,"GUID":"0","Type":0,"QuestionText":"Example Question","DisplayOrder":0,"ResponseCharacterLimit":0,
"SimpleQuestionType":0,"CreationDate":"2014-11-20T12:00:00.000Z"
}]