API / Survey

Entity Description:

Survey is a Q&A control that allows for Surveys such as 5 star ratings, mood type, yes or no, and multiple choice selections. The results for the Survey are found on the bottom of the metrics report section.

 

Properties

Name Description Type Additional
Information
ID Int32
GUID String
OwnerID Int32
Name String
Description String
ShowResults Boolean
ConfirmationText String
ConfirmationUrl String
CreationDate DateTime
ExpirationDate DateTime
Shared Boolean

 

Entity Statement

Creating a Survey
Request
POST /ssv3/odata/Surveys
Content-Type     
application/json
Request body
{
“ID”:”0″,”GUID”:”0″,”OwnerID”:”0″,”Name”:”New Survey”,”Description”:
“Example Description”,”ShowResults”:true,”ConfirmationText”:”Example Text”,”ConfirmationUrl”:”Example URL”,
“CreationDate”:”2014-11-19T17:48:26.155Z”,”ExpirationDate”:”2012-12-19T17:48:26.155Z”,”Shared”:false
}
Response body
{
“ID”:1,”GUID”:”0”,”OwnerID”:0,”Name”:”New Survey”,”Description”:”Example Description”,”ShowResults”:true,”ConfirmationText”:
“Example Text”,”ConfirmationUrl”:”Example URL”,
“CreationDate”:”2014-11-29T12:00:26.155Z”,”ExpirationDate”:”2012-12-29T12:00:26.155Z”,”Shared”:false
}
Deleting a Survey
  Request
  DELETE /ssv3/odata/Surveys(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Survey
  Request
  GET /ssv3/odata/Surveys(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”GUID”:”0”,”OwnerID”:0,”Name”:”New Survey”,”Description”:”Example Description”,”ShowResults”:true,”ConfirmationText”:”Example Text”,
“ConfirmationUrl”:”Example URL”,
“CreationDate”:”2014-11-29T12:00:26.155Z”,”ExpirationDate”:”2012-12-29T12:00:26.155Z”,”Shared”:false
}
Updating a List
  Request
  PUT /ssv3/odata/Surveys(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”GUID”:”0″,”OwnerID”:”0″,”Name”:”New Survey”,
“Description”:”Example Description”,”ShowResults”:true,
“ConfirmationText”:”Example Text”,”ConfirmationUrl”:
“Example URL”,”CreationDate”:”2014-11-19T17:48:26.155Z”,
“ExpirationDate”:”2012-12-19T17:48:26.155Z”,”Shared”:false
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Surveys
  Request
  GET /ssv3/odata/Surveys
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”GUID”:”0”,”OwnerID”:0,”Name”:”New Survey”,”Description”:”Example Description”,”ShowResults”:true,”ConfirmationText”:”Example Text”,
“ConfirmationUrl”:”Example URL”,”CreationDate”:”2014-11-19T17:48:26.155Z”,”ExpirationDate”:”2012-12-19T17:48:26.155Z”,”Shared”:false
},{
“ID”:1,”GUID”:”0”,”OwnerID”:0,”Name”:”New Survey”,”Description”:”Example Description”,”ShowResults”:true,”ConfirmationText”:”Example Text”,
“ConfirmationUrl”:”Example URL”,”CreationDate”:”2014-11-29T12:00:26.155Z”,”ExpirationDate”:”2012-12-29T12:00:26.155Z”,”Shared”:false
}]