Multi-device questionnaires
Answers are possible options to Questions that are asked within a Survey.
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
QuestionId | System.Int32 | Answer id within utilizing question[required] |
Text | System.String | Display text of answer |
Value | System.String | Value corresponding to answer |
Color | System.String | Color code if applicable |
Rank | System.Int32 | Display sort order[required] |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
WriteIn | System.Boolean | Tells the Survey UI to make available an optional text answer |
Name | Type | Description |
---|
The various objects within a screen layout.
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SurveyId | System.Int32 | Unavailable |
LayoutElementTypeId | LayoutElementTypeEnum | Unavailable |
ScreenId | System.Int32 | Unavailable[required] |
Rank | System.Int32 | The rank for the Layout Elements[queryable][sortable][required] |
ElementId | System.Int32 | Unavailable |
Contents | System.String | Unavailable |
LoadKey | System.String | Element key used to check load state by Survey completion UI |
CreateDate | System.DateTime | Unavailable |
ModifyDate | System.DateTime | Unavailable |
Screen | Screen | Navigation property to Screen [expandable] |
Survey | Survey | Navigation property to Survey [expandable] |
File information of media used in survey container, screens and questions
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SurveyId | System.Int32 | Foreign key into survey table[required] |
QuestionId | System.Int32 | Text key of question within survey |
Caption | System.String | Functional name of file, if any (e.g. logo) |
Filename | System.String | Local filename or full URL of file |
RetinaFilename | System.String | Local filename or full URL of high resolution file |
Url | System.String | URL media item links to |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
MediaTypeId | MediaTypeEnum | Unavailable |
ScreenId | System.Int32 | Unavailable |
Reference | System.String | Unavailable |
Question | Question | Navigation property to Question [expandable] |
Screen | Screen | Navigation property to Screen [expandable] |
Projects determine which Surveys are accessible by which consumers.
Name | Type | Description |
---|---|---|
PhoenixIdentity_ProjectId | System.Int32 | refers to the master ProjectId in the PhoenixIdentity database[queryable][sortable][required] |
CreateDate | System.DateTime | UTC date of when this Object was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this Object was modified[queryable][sortable] |
Timestamp | System.Byte | Timestamp |
Survey questions, displayed on screens
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
ScreenId | System.Int32 | Id of screen within survey[required] |
QuestionTypeId | QuestionTypeEnum | Functional name of question type |
Text | System.String | Text of question, the question itself |
DataDescriptor | System.String | Special data descriptor string giving data context to the question (e.g. geo:US,provinces,State,Count) |
Max | System.Int32 | Maximum value or string length permitted |
Min | System.Int32 | Minimum value |
DefaultAnswer | System.String | Default answer to question if any |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
Name | System.String | See QuestionName |
SurveyId | System.Int32 | Foreign key into survey table[required] |
Rank | System.Int32 | Display sort order on screen[required] |
Instructions | System.Int32 | Should user instructions be displayed[required] |
ButtonText | System.String | Text of button or control labels |
ScoreWeighting | System.Int32 | Weighting to be applied to question when scoring survey |
Timestamp | System.Byte | Timestamp |
Answers | ICollection | Navigation property to Answer [expandable] |
Screen | Screen | Navigation property to Screen [expandable] |
Survey | Survey | Navigation property to Survey [expandable] |
Question types used in surveys, table employed by the editor
Name | Type | Description |
---|---|---|
Id | QuestionTypeEnum | The primary identifier for this object[queryable][sortable] |
Name | System.String | Functional name of type as used in surveys |
Reference | System.String | Reference[required] |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
DisplayName | System.String | Human readable full name of type |
HasAnswers | System.Int32 | Bit toggle, does the question have defined answers[required] |
ColoredAnswers | System.Int32 | Bit toggle, do answers get colored in the UI[required] |
ShowShortText | System.Int32 | Bit toggle, is there a short form of the text to display in the editor[required] |
SortableAnswers | System.Int32 | Bit toggle, can the answers be sorted in the editor[required] |
ShowMax | System.Boolean | Bit toggle, does the type have a maximum value[required] |
ShowMin | System.Boolean | Bit toggle, does the type have a minimum value[required] |
HasInstructions | System.Int32 | Bit toggle, are there user instructions for the question[required] |
CanScore | System.Int32 | Bit toggle, can questions of this type be included in a survey score[required] |
QuestionTypeFamilyId | Nullable | QuestionType groups |
HasContentTypes | System.Boolean | Does this Question have content types |
MinMaxSuffix | System.String | The label to display after the number of choices required - eg "choice(s)" |
LeftLabel | System.String | Text to display on the left side of the control. |
RightLabel | System.String | Text to display on the right side of the control. |
Shuffle | System.Boolean | Can this questions' answers be randomised? |
Named recipients to whom a survey link has been sent, for tracking
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SurveyId | System.Int32 | Foreign key into survey table[required] |
FirstName | System.String | First name of recipient |
LastName | System.String | Last name of recipient |
SentDate | System.DateTime | Date/time the survey link was sent |
SubmissionId | System.Int32 | Foreign key into submission table, tying recipient to their survey response |
Uuid | System.String | Unique uuid used in survey link to associate submission to survey and recipient |
ShortLink | System.String | If a tgrs.pk link is generated, store it here |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
System.String | Email of recipient | |
MetaDataParameters | List<KeyValuePair<string, string>> | extra properties of a recipient |
NotificationAddresses | System.String | Unavailable |
IsSingleUse | System.Boolean | The user can only submit the survey once |
OpenedDate | System.DateTime | Unavailable |
SubmissionDate | System.DateTime | Unavailable |
PhoenixMessaging_RecipientId | System.Int32 | If PhoenixMessaging was used to distribute the survey, this is the RecipientId [queryable] |
Survey | Survey | Navigation property to Survey [expandable] |
Submission | Submission | Navigation property to Submission [expandable] |
Survey responses to each question, bundled into a Submission.
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SubmissionId | System.Int32 | [required] |
Responded | System.Boolean | Bit toggle, responded to and not skipped |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
ScreenId | System.Int32 | Id of screen within survey |
ScreenKey | System.Int32 | Index into screen collection |
QuestionId | System.Int32 | Text key of question within survey |
QuestionKey | System.Int32 | Index into question collection |
TimeTaken | System.Int32 | Time taken to respond in seconds, should be at the screen level but only have responses (i.e. question level) |
Value | System.String | Value from answer chosen or user supplied |
Text | System.String | Text from answer chosen or user supplied |
Score | System.Double | Calculated score of survey |
Latitude | System.Double | Latitude of response if captured |
Longitude | System.Double | Longitude of response if captured |
SetScreenId | System.Int32 | Unavailable |
OriginalQuestionId | System.Int32 | Unavailable |
Question | Question | Navigation property to Question [expandable] |
Components of survey response for multidimensional responses
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
ResponseId | System.Int32 | Foreign key into response table[required] |
Value | System.String | Value from answer table, used for foreign key into answers table[required] |
Rank | System.Int32 | Sort rank of answers in response |
SurveyId | System.Int32 | Foreign key into surveys table[required] |
SubmissionId | System.Int32 | Foreign key into submissions table[required] |
QuestionId | System.Int32 | Text key of question within survey |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
Timestamp | System.Byte | Timestamp |
Question | Question | Navigation property to Question [expandable] |
Response | Response | Navigation property to Response [expandable] |
Display screens into which surveys are broken
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SurveyId | System.Int32 | Foreign key into survey table[required] |
Progress | System.Int32 | Numeric progress through the survey |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
ScreenId | System.Int32 | Index within survey |
ScreenName | System.String | Name used throughout reporting only |
Title | System.String | Screen title to be displayed before questions |
Text | System.String | Text paragraph to display before questions |
Required | System.Boolean | Does the screen require completion to progress the survey |
DrawFromSet | System.Int32 | Number of screens to draw from the Set |
SetId | System.Int32 | the Set to draw the Screens from |
Survey | Survey | Navigation property to Survey [expandable] |
Each is a survey submission from a participant
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SurveyId | System.Int32 | Foreign key into survey table |
SubmitDate | System.DateTime | Date/time submission received |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
Url | System.String | Full URL of survey being submitted |
UserAgent | System.String | User agent string from header of submission |
TimeTaken | System.Int32 | Total duration in seconds |
IPAddress | System.String | IPv4 address from header of submission |
Latitude | System.Double | Derived latitude from IP address |
Longitude | System.Double | Derived longitudefrom IP address |
Score | System.Double | Calculated score for submission from each scoreable question answered |
RecipientId | System.Int32 | Foreign key into recipients table if completed via a recipient link |
SurveyStatusTypeId | Nullable | Unavailable |
Recipient | Recipient | Navigation property to Recipient [expandable] |
Responses | ICollection | Navigation property to Response [expandable] |
ResponseElements | ICollection | Navigation property to ResponseElement [expandable] |
Survey | Survey | Navigation property to Survey [expandable] |
UrlParams | ICollection | Navigation property to UrlParam [expandable] |
Surveys are the main entity in the schema which determines the content and presentation of the each survey.
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
ProjectId | System.Int32 | Unavailable[required] |
InitialScreenId | System.Int32 | Unavailable |
Title | System.String | Name of the survey, not sure why it's called title |
RecipientCount | System.Int32 | Bit toggle, allow named recipients to be targeted and tracked |
ReportIndividuals | System.Int32 | Unavailable[required] |
Score | System.Int32 | Unavailable[required] |
UIColorsPrimary | System.String | Hex code of color used as primary theme color |
UIColorsSecondary | System.String | Hex code of color used as secondary theme color |
UIColorsBackground | System.String | Hex code of color used as background color |
ImageDir | System.String | Directory for all relative media paths |
ProgressLabel | System.String | Text mask to use for display of user progress through survey |
Uuid | System.String | UUID used in survey URL to identify survey |
LaunchScreenShow | System.Boolean | bit toggle, show a launch screen before survey experience |
LaunchScreenTextDesktop | System.String | Text to display to desktop users on launch screen |
LaunchScreenTextMobile | System.String | Text to display to mobile users on launch screen |
LaunchScreenTextColor | System.String | Hex code of color of text on launch screen |
LaunchScreenButtonText | System.String | Text on button to start survey |
LaunchScreenBgFilename | System.String | Filename of background image for launch screen |
FinalScreenTextSuccess | System.String | Text to display on final screen if survey submission succeeds |
FinalScreenTextError | System.String | Text to display on final screen if survey submission fails |
FinalScreenTextColor | System.String | Hex code of color of text on final screen |
FinalScreenBgFilename | System.String | Filename of background image for final screen |
EditUuid | System.String | UUID used in admin UI URL to identify survey |
DisplayUrlParam | System.String | URL querystring parameter containing display name of respondent, if any |
ReportStatusFilter | System.String | Status messages to exclude from report, e.g. "testing" |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
NameUrlField | System.String | Unavailable |
IsActive | System.Boolean | Unavailable[required] |
StatusTypeId | StatusTypeEnum | Unavailable |
HasNamedRecipients | System.Boolean | has named recipients |
ClosedText | System.String | Text to display when the Survey is closed. |
BadLinkText | System.String | Text to display when a recipient link has already been used or is invalid. |
ReportIndividualNames | System.Boolean | Unavailable |
CustomFont | System.String | Unavailable |
CustomCss | System.String | Unavailable |
NotificationAddresses | System.String | Unavailable |
MessageId | System.Int32 | Unavailable |
MetaDataParameters | List<KeyValuePair<string, string>> | |
Media | ICollection | Navigation property to Media [expandable] |
Project | Project | Navigation property to Project [expandable] |
Screen | Screen | Navigation property to Screen [expandable] |
SurveyUrls | ICollection | Navigation property to SurveyUrl [expandable] |
Name | Type | Description |
---|---|---|
MaxTime | System.Double | Unavailable |
AvgTime | System.Double | Unavailable |
NumResponses | System.Int32 | Unavailable |
AggValue | System.Double | Unavailable |
AggText | System.String | Unavailable |
Name | Type | Description |
---|---|---|
MaxTime | System.Double | Unavailable |
AvgTime | System.Double | Unavailable |
NumSurveys | System.Int32 | Unavailable |
Latest | System.DateTime | Unavailable |
AvgScore | System.Double | Unavailable |
MinScore | System.Double | Unavailable |
MaxScore | System.Double | Unavailable |
TotalRecipients | System.Int32 | Unavailable |
TotalRespondents | System.Int32 | Unavailable |
SurveySwitches are name/value pairs for survey settings
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SurveyId | System.Int32 | Foreign key into survey table[required] |
Switch | System.String | Name of property switch[required] |
Setting | System.Boolean | Bit toggle, current setting for the survey property[required] |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
Timestamp | System.Byte | Timestamp |
Survey | Survey | Navigation property to Survey [expandable] |
SurveyUrls are inexplicably normalized URLs as applied to survey experience, logo link, post survey destination, etc
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SurveyId | System.Int32 | Foreign key into survey table[required] |
UrlType | System.String | Name of URL function[required] |
Url | System.String | Full URL[required] |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
Timestamp | System.Byte | Timestamp |
UrlParams are parsed querystring parameters and values for survey submissions
Name | Type | Description |
---|---|---|
Id | System.Int32 | The primary identifier for this object[queryable][sortable] |
SubmissionId | System.Int32 | Foreign key into submissions table[required] |
ParamKey | System.String | Querystring parameter[required] |
ParamValue | System.String | Querystring value[required] |
CreateDate | System.DateTime | UTC date of when this entity was created[queryable][readonly][sortable] |
ModifyDate | System.DateTime | UTC date of when this entity was last modified[queryable][sortable] |
Timestamp | System.Byte | Timestamp |