Phoenix Survey

Multi-device questionnaires

Answer

Answers are possible options to Questions that are asked within a Survey.

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
QuestionIdSystem.Int32Answer id within utilizing question[required]
TextSystem.StringDisplay text of answer
ValueSystem.StringValue corresponding to answer
ColorSystem.StringColor code if applicable
RankSystem.Int32Display sort order[required]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
WriteInSystem.BooleanTells the Survey UI to make available an optional text answer

Operations

CreateAnswer
Creates a new Answer for a SurveySoapRestC#
GetAnswer
Gets a particular Answer for a SurveySoapRestC#
ListAnswers
Returns the answers for a SurveySoapRestC#
UpdateAnswer
Updates Answer within a SurveySoapRestC#

DeleteResponse

Properties

Name Type Description

Operations

DeleteAnswer
Deletes a particular Answer within a SurveySoapRestC#
DeleteLayoutElement
Deletes a particular Switch within a SurveySoapRestC#
DeleteMedia
Deletes a particular Media within a SurveySoapRestC#
DeleteRecipient
Delete a RecipientSoapRestC#
DeleteResponse
Delete a ResponseSoapRestC#
DeleteScreen
Deletes a particular Screen within a SurveySoapRestC#
DeleteSubmission
Delete a SubmissionSoapRestC#
DeleteSurvey
Deletes a survey by its IdSoapRestC#
DeleteSurveySwitch
Deletes a particular Switch within a SurveySoapRestC#
DeleteSurveyUrl
Deletes a particular Url within a SurveySoapRestC#

LayoutElement

The various objects within a screen layout.

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SurveyIdSystem.Int32Unavailable
LayoutElementTypeIdLayoutElementTypeEnumUnavailable
ScreenIdSystem.Int32Unavailable[required]
RankSystem.Int32 The rank for the Layout Elements[queryable][sortable][required]
ElementIdSystem.Int32Unavailable
ContentsSystem.StringUnavailable
LoadKeySystem.StringElement key used to check load state by Survey completion UI
CreateDateSystem.DateTimeUnavailable
ModifyDateSystem.DateTimeUnavailable
ScreenScreenNavigation property to Screen [expandable]
SurveySurveyNavigation property to Survey [expandable]

Operations

CreateLayoutElement
Creates a new switch for a SurveySoapRestC#
GetLayoutElement
Gets a particular Switch for a SurveySoapRestC#
ListLayoutElement
Returns the switches for a SurveySoapRestC#
UpdateLayoutElement
Updates switches within a SurveySoapRestC#

Media

File information of media used in survey container, screens and questions

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SurveyIdSystem.Int32Foreign key into survey table[required]
QuestionIdSystem.Int32Text key of question within survey
CaptionSystem.StringFunctional name of file, if any (e.g. logo)
FilenameSystem.StringLocal filename or full URL of file
RetinaFilenameSystem.StringLocal filename or full URL of high resolution file
UrlSystem.StringURL media item links to
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
MediaTypeIdMediaTypeEnumUnavailable
ScreenIdSystem.Int32Unavailable
ReferenceSystem.StringUnavailable
QuestionQuestionNavigation property to Question [expandable]
ScreenScreenNavigation property to Screen [expandable]

Operations

CreateMedia
Creates a new Media for a SurveySoapRestC#
GetMedia
Gets a particular Media for a SurveySoapRestC#
ListMedia
Returns the media for a SurveySoapRestC#
UpdateMedia
Updates Media within a SurveySoapRestC#

Project

Projects determine which Surveys are accessible by which consumers.

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 refers to the master ProjectId in the PhoenixIdentity database[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime  UTC date of when this Object was modified[queryable][sortable]
TimestampSystem.ByteTimestamp

Operations

ActivateModule
Description not availableSoapRestC#
DeactivateModule
Description not availableSoapRestC#
GetModuleSettings
Description not availableSoapRestC#
UpdateModuleSettings
Description not availableSoapRestC#

Question

Survey questions, displayed on screens

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
ScreenIdSystem.Int32Id of screen within survey[required]
QuestionTypeIdQuestionTypeEnumFunctional name of question type
TextSystem.StringText of question, the question itself
DataDescriptorSystem.StringSpecial data descriptor string giving data context to the question (e.g. geo:US,provinces,State,Count)
MaxSystem.Int32Maximum value or string length permitted
MinSystem.Int32Minimum value
DefaultAnswerSystem.StringDefault answer to question if any
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
NameSystem.StringSee QuestionName
SurveyIdSystem.Int32Foreign key into survey table[required]
RankSystem.Int32Display sort order on screen[required]
InstructionsSystem.Int32Should user instructions be displayed[required]
ButtonTextSystem.StringText of button or control labels
ScoreWeightingSystem.Int32Weighting to be applied to question when scoring survey
TimestampSystem.ByteTimestamp
AnswersICollection[]Navigation property to Answer [expandable]
ScreenScreenNavigation property to Screen [expandable]
SurveySurveyNavigation property to Survey [expandable]

Operations

CreateQuestion
Creates a new Question object required to authenticate end usersSoapRestC#
ListQuestion
Returns a paged list of Questions optionally filtered and sortedSoapRestC#

QuestionType

Question types used in surveys, table employed by the editor

Properties

Name Type Description
IdQuestionTypeEnum The primary identifier for this object[queryable][sortable]
NameSystem.StringFunctional name of type as used in surveys
ReferenceSystem.StringReference[required]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
DisplayNameSystem.StringHuman readable full name of type
HasAnswersSystem.Int32Bit toggle, does the question have defined answers[required]
ColoredAnswersSystem.Int32Bit toggle, do answers get colored in the UI[required]
ShowShortTextSystem.Int32Bit toggle, is there a short form of the text to display in the editor[required]
SortableAnswersSystem.Int32Bit toggle, can the answers be sorted in the editor[required]
ShowMaxSystem.BooleanBit toggle, does the type have a maximum value[required]
ShowMinSystem.BooleanBit toggle, does the type have a minimum value[required]
HasInstructionsSystem.Int32Bit toggle, are there user instructions for the question[required]
CanScoreSystem.Int32Bit toggle, can questions of this type be included in a survey score[required]
QuestionTypeFamilyIdNullableQuestionType groups
HasContentTypesSystem.BooleanDoes this Question have content types
MinMaxSuffixSystem.StringThe label to display after the number of choices required - eg "choice(s)"
LeftLabelSystem.StringText to display on the left side of the control.
RightLabelSystem.StringText to display on the right side of the control.
ShuffleSystem.BooleanCan this questions' answers be randomised?

Operations

ListQuestionTypes
Retrieve the possible QuestionTypes in the platformSoapRestC#

Recipient

Named recipients to whom a survey link has been sent, for tracking

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SurveyIdSystem.Int32Foreign key into survey table[required]
FirstNameSystem.StringFirst name of recipient
LastNameSystem.StringLast name of recipient
SentDateSystem.DateTimeDate/time the survey link was sent
SubmissionIdSystem.Int32Foreign key into submission table, tying recipient to their survey response
UuidSystem.StringUnique uuid used in survey link to associate submission to survey and recipient
ShortLinkSystem.StringIf a tgrs.pk link is generated, store it here
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
EmailSystem.StringEmail of recipient
MetaDataParametersList<KeyValuePair<string, string>> extra properties of a recipient
NotificationAddressesSystem.StringUnavailable
IsSingleUseSystem.BooleanThe user can only submit the survey once
OpenedDateSystem.DateTimeUnavailable
SubmissionDateSystem.DateTimeUnavailable
PhoenixMessaging_RecipientIdSystem.Int32If PhoenixMessaging was used to distribute the survey, this is the RecipientId [queryable]
SurveySurveyNavigation property to Survey [expandable]
SubmissionSubmissionNavigation property to Submission [expandable]

Operations

CreateRecipient
Create a new recipient for a SurveySoapRestC#
GetRecipient
Retrieve a particular recipient by IdSoapRestC#
ListRecipients
Returns the recipients for a SurveySoapRestC#
UpdateRecipient
Update an existing recipient for a SurveySoapRestC#

Response

Survey responses to each question, bundled into a Submission.

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SubmissionIdSystem.Int32[required]
RespondedSystem.BooleanBit toggle, responded to and not skipped
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
ScreenIdSystem.Int32Id of screen within survey
ScreenKeySystem.Int32Index into screen collection
QuestionIdSystem.Int32Text key of question within survey
QuestionKeySystem.Int32Index into question collection
TimeTakenSystem.Int32Time taken to respond in seconds, should be at the screen level but only have responses (i.e. question level)
ValueSystem.StringValue from answer chosen or user supplied 
TextSystem.StringText from answer chosen or user supplied
ScoreSystem.DoubleCalculated score of survey
LatitudeSystem.DoubleLatitude of response if captured
LongitudeSystem.DoubleLongitude of response if captured
SetScreenIdSystem.Int32Unavailable
OriginalQuestionIdSystem.Int32Unavailable
QuestionQuestionNavigation property to Question [expandable]

Operations

CreateResponse
Creates a Response for a Survey SubmissionSoapRestC#
GetResponse
Gets a particular Response for a Survey SubmissionSoapRestC#
ListResponses
Returns a paged list of Responses optionally filtered and sortedSoapRestC#
UpdateResponse
Updates a collection of ResponseSoapRestC#

ResponseElement

Components of survey response for multidimensional responses

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
ResponseIdSystem.Int32Foreign key into response table[required]
ValueSystem.StringValue from answer table, used for foreign key into answers table[required]
RankSystem.Int32Sort rank of answers in response
SurveyIdSystem.Int32Foreign key into surveys table[required]
SubmissionIdSystem.Int32Foreign key into submissions table[required]
QuestionIdSystem.Int32Text key of question within survey
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
TimestampSystem.ByteTimestamp
QuestionQuestionNavigation property to Question [expandable]
ResponseResponseNavigation property to Response [expandable]

Screen

Display screens into which surveys are broken

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SurveyIdSystem.Int32Foreign key into survey table[required]
ProgressSystem.Int32Numeric progress through the survey
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
ScreenIdSystem.Int32Index within survey
ScreenNameSystem.StringName used throughout reporting only
TitleSystem.StringScreen title to be displayed before questions
TextSystem.StringText paragraph to display before questions
RequiredSystem.BooleanDoes the screen require completion to progress the survey
DrawFromSetSystem.Int32Number of screens to draw from the Set
SetIdSystem.Int32the Set to draw the Screens from
SurveySurveyNavigation property to Survey [expandable]

Operations

CreateScreen
Create a new screen for a SurveySoapRestC#
GetScreen
Gets a particular Screen for a SurveySoapRestC#
ListScreens
Returns the screens for a SurveySoapRestC#
UpdateScreen
Update an existing screen for a SurveySoapRestC#

Submission

Each is a survey submission from a participant

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SurveyIdSystem.Int32Foreign key into survey table
SubmitDateSystem.DateTimeDate/time submission received
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
UrlSystem.StringFull URL of survey being submitted
UserAgentSystem.StringUser agent string from header of submission
TimeTakenSystem.Int32Total duration in seconds
IPAddressSystem.StringIPv4 address from header of submission
LatitudeSystem.DoubleDerived latitude from IP address
LongitudeSystem.DoubleDerived longitudefrom IP address
ScoreSystem.DoubleCalculated score for submission from each scoreable question answered
RecipientIdSystem.Int32Foreign key into recipients table if completed via a recipient link
SurveyStatusTypeIdNullableUnavailable
RecipientRecipientNavigation property to Recipient [expandable]
ResponsesICollection[]Navigation property to Response [expandable]
ResponseElementsICollection[]Navigation property to ResponseElement [expandable]
SurveySurveyNavigation property to Survey [expandable]
UrlParamsICollection[]Navigation property to UrlParam [expandable]

Operations

CreateSubmission
Creates a new Submission object required to authenticate end usersSoapRestC#
GetSubmission
Creates a new Submission object required to authenticate end usersSoapRestC#
ListSubmission
Returns a paged list of Submissions optionally filtered and sortedSoapRestC#
UpdateSubmission
Updates a collection of SubmissionsSoapRestC#

Survey

Surveys are the main entity in the schema which determines the content and presentation of the each survey.

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
ProjectIdSystem.Int32Unavailable[required]
InitialScreenIdSystem.Int32Unavailable
TitleSystem.StringName of the survey, not sure why it's called title
RecipientCountSystem.Int32Bit toggle, allow named recipients to be targeted and tracked
ReportIndividualsSystem.Int32Unavailable[required]
ScoreSystem.Int32Unavailable[required]
UIColorsPrimarySystem.StringHex code of color used as primary theme color
UIColorsSecondarySystem.StringHex code of color used as secondary theme color
UIColorsBackgroundSystem.StringHex code of color used as background color
ImageDirSystem.StringDirectory for all relative media paths
ProgressLabelSystem.StringText mask to use for display of user progress through survey
UuidSystem.StringUUID used in survey URL to identify survey
LaunchScreenShowSystem.Booleanbit toggle, show a launch screen before survey experience
LaunchScreenTextDesktopSystem.StringText to display to desktop users on launch screen
LaunchScreenTextMobileSystem.StringText to display to mobile users on launch screen
LaunchScreenTextColorSystem.StringHex code of color of text on launch screen
LaunchScreenButtonTextSystem.StringText on button to start survey
LaunchScreenBgFilenameSystem.StringFilename of background image for launch screen
FinalScreenTextSuccessSystem.StringText to display on final screen if survey submission succeeds
FinalScreenTextErrorSystem.StringText to display on final screen if survey submission fails
FinalScreenTextColorSystem.StringHex code of color of text on final screen
FinalScreenBgFilenameSystem.StringFilename of background image for final screen
EditUuidSystem.StringUUID used in admin UI URL to identify survey
DisplayUrlParamSystem.StringURL querystring parameter containing display name of respondent, if any
ReportStatusFilterSystem.StringStatus messages to exclude from report, e.g. "testing"
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
NameUrlFieldSystem.StringUnavailable
IsActiveSystem.BooleanUnavailable[required]
StatusTypeIdStatusTypeEnumUnavailable
HasNamedRecipientsSystem.Booleanhas named recipients
ClosedTextSystem.StringText to display when the Survey is closed.
BadLinkTextSystem.StringText to display when a recipient link has already been used or is invalid.
ReportIndividualNamesSystem.BooleanUnavailable
CustomFontSystem.StringUnavailable
CustomCssSystem.StringUnavailable
NotificationAddressesSystem.StringUnavailable
MessageIdSystem.Int32Unavailable
MetaDataParametersList<KeyValuePair<string, string>>
MediaICollection[]Navigation property to Media [expandable]
ProjectProjectNavigation property to Project [expandable]
ScreenScreenNavigation property to Screen [expandable]
SurveyUrlsICollection[]Navigation property to SurveyUrl [expandable]

Operations

CreateSurvey
Creates a new Survey object required to authenticate end usersSoapRestC#
GetSurvey
Returns a single SurveySoapRestC#
ListSurvey
Returns a paged list of Surveys optionally filtered and sortedSoapRestC#
LoadSurvey
Returns a Survey loadSoapRestC#
UpdateSurvey
Updates a collection of SurveysSoapRestC#

SurveyQuestionSummary

Properties

Name Type Description
MaxTimeSystem.DoubleUnavailable
AvgTimeSystem.DoubleUnavailable
NumResponsesSystem.Int32Unavailable
AggValueSystem.DoubleUnavailable
AggTextSystem.StringUnavailable

Operations

GetQuestionSummary
Returns a Question summarySoapRestC#

SurveySummary

Properties

Name Type Description
MaxTimeSystem.DoubleUnavailable
AvgTimeSystem.DoubleUnavailable
NumSurveysSystem.Int32Unavailable
LatestSystem.DateTimeUnavailable
AvgScoreSystem.DoubleUnavailable
MinScoreSystem.DoubleUnavailable
MaxScoreSystem.DoubleUnavailable
TotalRecipientsSystem.Int32Unavailable
TotalRespondentsSystem.Int32Unavailable

Operations

GetSurveySummary
Returns a Survey summarySoapRestC#

SurveySwitch

SurveySwitches are name/value pairs for survey settings

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SurveyIdSystem.Int32Foreign key into survey table[required]
SwitchSystem.StringName of property switch[required]
SettingSystem.BooleanBit toggle, current setting for the survey property[required]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
TimestampSystem.ByteTimestamp
SurveySurveyNavigation property to Survey [expandable]

Operations

CreateSurveySwitch
Creates a new switch for a SurveySoapRestC#
GetSurveySwitch
Gets a particular Switch for a SurveySoapRestC#
ListSurveySwitch
Returns the switches for a SurveySoapRestC#
UpdateSurveySwitch
Updates switches within a SurveySoapRestC#

SurveyUrl

SurveyUrls are inexplicably normalized URLs as applied to survey experience, logo link, post survey destination, etc

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SurveyIdSystem.Int32Foreign key into survey table[required]
UrlTypeSystem.StringName of URL function[required]
UrlSystem.StringFull URL[required]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
TimestampSystem.ByteTimestamp

Operations

CreateSurveyUrl
Creates a new urls for a SurveySoapRestC#
GetSurveyUrl
Gets a particular urls for a SurveySoapRestC#
ListSurveyUrl
Returns the urls for a SurveySoapRestC#
UpdateSurveyUrl
Updates urls within a SurveySoapRestC#

UrlParam

UrlParams are parsed querystring parameters and values for survey submissions

Properties

Name Type Description
IdSystem.Int32 The primary identifier for this object[queryable][sortable]
SubmissionIdSystem.Int32Foreign key into submissions table[required]
ParamKeySystem.StringQuerystring parameter[required]
ParamValueSystem.StringQuerystring value[required]
CreateDateSystem.DateTime UTC date of when this entity was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this entity was last modified[queryable][sortable]
TimestampSystem.ByteTimestamp