Phoenix Survey

The primary identifier for this object[queryable][sortable]

SurveyId

Unavailable

LayoutElementTypeId

LayoutElementTypeEnum

Unavailable

ScreenId

Unavailable[required]

Rank

The rank for the Layout Elements[queryable][sortable][required]

ElementId

Unavailable

Contents

Unavailable

LoadKey

Element key used to check load state by Survey completion UI

CreateDate

Unavailable

ModifyDate

Unavailable

Screen

Navigation property to Screen [expandable]

Survey

Survey

Navigation property to Survey [expandable]

Operations

CreateLayoutElement: Creates a new switch for a SurveySoap Rest C#
GetLayoutElement: Gets a particular Switch for a SurveySoap Rest C#
ListLayoutElement: Returns the switches for a SurveySoap Rest C#
UpdateLayoutElement: Updates switches within a SurveySoap Rest C#

Media

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

Properties

Name

Type

Description

The primary identifier for this object[queryable][sortable]

SurveyId

Foreign key into survey table[required]

QuestionId

Text key of question within survey

Caption

Functional name of file, if any (e.g. logo)

Filename

Local filename or full URL of file

RetinaFilename

Local filename or full URL of high resolution file

Url

URL media item links to

CreateDate

UTC date of when this entity was created[queryable][readonly][sortable]

ModifyDate

UTC date of when this entity was last modified[queryable][sortable]

MediaTypeId

MediaTypeEnum

Unavailable

ScreenId

Unavailable

Reference

Unavailable

Question

Question

Navigation property to Question [expandable]

Screen

Navigation property to Screen [expandable]

Operations

CreateMedia: Creates a new Media for a SurveySoap Rest C#
GetMedia: Gets a particular Media for a SurveySoap Rest C#
ListMedia: Returns the media for a SurveySoap Rest C#
UpdateMedia: Updates Media within a SurveySoap Rest C#

Project

Projects determine which Surveys are accessible by which consumers.

Properties

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

Operations

ActivateModule: Description not availableSoap Rest C#
DeactivateModule: Description not availableSoap Rest C#
GetModuleSettings: Description not availableSoap Rest C#
UpdateModuleSettings: Description not availableSoap Rest C#

Question

Survey questions, displayed on screens

Properties

Name

Type

Description

The primary identifier for this object[queryable][sortable]

ScreenId

Id of screen within survey[required]

QuestionTypeId

QuestionTypeEnum

Functional name of question type

Text

Text of question, the question itself

DataDescriptor

Special data descriptor string giving data context to the question (e.g. geo:US,provinces,State,Count)

Max

Maximum value or string length permitted

Min

Minimum value

DefaultAnswer

Default answer to question if any

CreateDate

UTC date of when this entity was created[queryable][readonly][sortable]

ModifyDate

UTC date of when this entity was last modified[queryable][sortable]

Name

See QuestionName

SurveyId

Foreign key into survey table[required]

Rank

Display sort order on screen[required]

Instructions

Should user instructions be displayed[required]

ButtonText

Text of button or control labels

ScoreWeighting

Weighting to be applied to question when scoring survey

Timestamp

System.Byte

Timestamp

Answers

Navigation property to Answer [expandable]

Screen

Navigation property to Screen [expandable]

Survey

Survey

Navigation property to Survey [expandable]

Operations

CreateQuestion: Creates a new Question object required to authenticate end usersSoap Rest C#
ListQuestion: Returns a paged list of Questions optionally filtered and sortedSoap Rest C#

QuestionType

Question types used in surveys, table employed by the editor

Properties

Name

Type

Description

QuestionTypeEnum

The primary identifier for this object[queryable][sortable]

Name

Functional name of type as used in surveys

Reference

Reference[required]

CreateDate

UTC date of when this entity was created[queryable][readonly][sortable]

ModifyDate

UTC date of when this entity was last modified[queryable][sortable]

DisplayName

Human readable full name of type

HasAnswers

Bit toggle, does the question have defined answers[required]

ColoredAnswers

Bit toggle, do answers get colored in the UI[required]

ShowShortText

Bit toggle, is there a short form of the text to display in the editor[required]

SortableAnswers

Bit toggle, can the answers be sorted in the editor[required]

ShowMax

Bit toggle, does the type have a maximum value[required]

ShowMin

Bit toggle, does the type have a minimum value[required]

HasInstructions

Bit toggle, are there user instructions for the question[required]

CanScore

Bit toggle, can questions of this type be included in a survey score[required]

QuestionTypeFamilyId

Nullable

QuestionType groups

HasContentTypes

Does this Question have content types

MinMaxSuffix

The label to display after the number of choices required - eg "choice(s)"

LeftLabel

Text to display on the left side of the control.

RightLabel

Text to display on the right side of the control.

Shuffle

Can this questions' answers be randomised?

Operations

ListQuestionTypes: Retrieve the possible QuestionTypes in the platformSoap Rest C#

Recipient

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

Properties

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]
Email	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]

Operations

CreateRecipient: Create a new recipient for a SurveySoap Rest C#
GetRecipient: Retrieve a particular recipient by IdSoap Rest C#
ListRecipients: Returns the recipients for a SurveySoap Rest C#
UpdateRecipient: Update an existing recipient for a SurveySoap Rest C#

Response

Survey responses to each question, bundled into a Submission.

Properties

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]

Operations

CreateResponse: Creates a Response for a Survey SubmissionSoap Rest C#
GetResponse: Gets a particular Response for a Survey SubmissionSoap Rest C#
ListResponses: Returns a paged list of Responses optionally filtered and sortedSoap Rest C#
UpdateResponse: Updates a collection of ResponseSoap Rest C#

ResponseElement

Components of survey response for multidimensional responses

Properties

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]

Screen

Display screens into which surveys are broken

Properties

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]

Operations

CreateScreen: Create a new screen for a SurveySoap Rest C#
GetScreen: Gets a particular Screen for a SurveySoap Rest C#
ListScreens: Returns the screens for a SurveySoap Rest C#
UpdateScreen: Update an existing screen for a SurveySoap Rest C#

Submission

Each is a survey submission from a participant

Properties

Name

Type

Description

The primary identifier for this object[queryable][sortable]

SurveyId

Foreign key into survey table

SubmitDate

Date/time submission received

CreateDate

UTC date of when this entity was created[queryable][readonly][sortable]

ModifyDate

UTC date of when this entity was last modified[queryable][sortable]

Url

Full URL of survey being submitted

UserAgent

User agent string from header of submission

TimeTaken

Total duration in seconds

IPAddress

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

Foreign key into recipients table if completed via a recipient link

SurveyStatusTypeId

Nullable

Unavailable

Recipient

Recipient

Navigation property to Recipient [expandable]

Responses

Navigation property to Response [expandable]

ResponseElements

Navigation property to ResponseElement [expandable]

Survey

Survey

Navigation property to Survey [expandable]

UrlParams

Navigation property to UrlParam [expandable]

Operations

CreateSubmission: Creates a new Submission object required to authenticate end usersSoap Rest C#
GetSubmission: Creates a new Submission object required to authenticate end usersSoap Rest C#
ListSubmission: Returns a paged list of Submissions optionally filtered and sortedSoap Rest C#
UpdateSubmission: Updates a collection of SubmissionsSoap Rest C#

Survey

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

Properties

Name

Type

Description

The primary identifier for this object[queryable][sortable]

ProjectId

Unavailable[required]

InitialScreenId

Unavailable

Title

Name of the survey, not sure why it's called title

RecipientCount

Bit toggle, allow named recipients to be targeted and tracked

ReportIndividuals

Unavailable[required]

Score

Unavailable[required]

UIColorsPrimary

Hex code of color used as primary theme color

UIColorsSecondary

Hex code of color used as secondary theme color

UIColorsBackground

Hex code of color used as background color

ImageDir

Directory for all relative media paths

ProgressLabel

Text mask to use for display of user progress through survey

Uuid

UUID used in survey URL to identify survey

LaunchScreenShow

bit toggle, show a launch screen before survey experience

LaunchScreenTextDesktop

Text to display to desktop users on launch screen

LaunchScreenTextMobile

Text to display to mobile users on launch screen

LaunchScreenTextColor

Hex code of color of text on launch screen

LaunchScreenButtonText

Text on button to start survey

LaunchScreenBgFilename

Filename of background image for launch screen

FinalScreenTextSuccess

Text to display on final screen if survey submission succeeds

FinalScreenTextError

Text to display on final screen if survey submission fails

FinalScreenTextColor

Hex code of color of text on final screen

FinalScreenBgFilename

Filename of background image for final screen

EditUuid

UUID used in admin UI URL to identify survey

DisplayUrlParam

URL querystring parameter containing display name of respondent, if any

ReportStatusFilter

Status messages to exclude from report, e.g. "testing"

CreateDate

UTC date of when this entity was created[queryable][readonly][sortable]

ModifyDate

UTC date of when this entity was last modified[queryable][sortable]

NameUrlField

Unavailable

IsActive

Unavailable[required]

StatusTypeId

StatusTypeEnum

Unavailable

HasNamedRecipients

has named recipients

ClosedText

Text to display when the Survey is closed.

BadLinkText

Text to display when a recipient link has already been used or is invalid.

ReportIndividualNames

Unavailable

CustomFont

Unavailable

CustomCss

Unavailable

NotificationAddresses

Unavailable

MessageId

Unavailable

MetaDataParameters

List<KeyValuePair<string, string>>

Media

Navigation property to Media [expandable]

Project

Project

Navigation property to Project [expandable]

Screen

Navigation property to Screen [expandable]

SurveyUrls