Get survey version response

meta objectrequired

httpStatusHttp status code (string)required

HTTP status code.

requestIdrequestId (string)required

The unique identifier of the associated request.

noticeAn informational string about the request. (string)

Additional information about this response.

result objectrequired

QuestionCountstring

Number of questions in the survey

SurveyOptions objectrequired

AnonymizeResponseAnonymizeResponse (string)

Scrub all respondent identifying information such as IP or location data.

Possible values: [No, Yes]

Default value: No

AutofocusAutofocus (boolean)

If true, provide autofocus for questions.

AutoadvanceAutoadvance (boolean)

Enables autoadvance on questions

AutoadvancePagesAutoadvancePages (boolean)

Enables autoadvance on pages. This requires Autoadvance to be anbled as well

AvailableLanguages object

The languages the survey supports.

property name* string[]

Array [

string

]

BackButtonBackButton (boolean)required

If true, display the back button

Default value: false

BallotBoxStuffingPreventionBallotBoxStuffingPrevention (boolean)required

If true, prevent respondents from taking the survey multiple times.

Default value: false

BallotBoxStuffingPreventionBehaviorBallotBoxStuffingPreventionBehavior (string)nullable

Ballot box stuffing prevention behavior.

Possible values: [default, DefaultMessage, DisplayMessage, Redirect, Continue]

Default value: default

BallotBoxStuffingPreventionMessageBallotBoxStuffingPreventionMessage (string)nullable

ID of the library message shown to prevent ballot box stuffing. See BallotBoxStuffingPrevention and BallotBoxStuffingPreventionMessageLibrary.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

BallotBoxStuffingPreventionMessageLibraryBallotBoxStuffingPreventionMessageLibrary (string)

Library ID associated with the Message ID in BallotBoxStuffingPreventionMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

BallotBoxStuffingPreventionURLBallotBoxStuffingPreventionURL (string)

Ballot Box stuffing prevention URL.

CollectGeoLocationCollectGeoLocation (string)

Collect respondents Geo Location. Default false.

Possible values: [true, false]

Default value: true

CustomStylesobject

Custom CSS to load when survey taking. See also ExternalCSS.

CustomLanguages object

The custom languages the survey supports.

property name* object

DisplayNamestringrequired

Name of the custom language

ErrorMessagesstringrequired

Base language for the custom language

EmailThankYouEmailThankYou (string)

Send an email thank you message after survey completion

Possible values: [true, false]

Default value: false

EOSMessageEnd of Survey Message (string)nullable

ID of the message to be displayed at the end of the survey

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

EOSRedirectURLEOSRedirectURL (string)

The URL to redirect respondents to at the end of the survey used when SurveyTermination is set to Redirect.

ExternalCSSExternalCSS (string)

CSS URL to load when survey taking. See also CustomStyles.

headerMidheaderMid (string)nullable

ID of the library message to display in the header. Do not use in conjunction with Header.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

HeaderHeader (string)required

Header to display on each page such as a logo. Do not use in conjunction with headerMid.

footerMidfooterMid (string)nullable

ID of the library message to display in the footer. Do not use in conjunction with Footer.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

FooterFooter (string)required

Footer to display on each page such as a logo. Do not use in conjunction with footerMid.

InactiveSurveyInactiveSurvey (string)nullable

Whether or not to use a custom validation message. See InactiveMessage and InactiveMessageLibrary.

Possible values: [DefaultMessage, DisplayMessage]

InactiveMessageInactiveMessage (string)nullable

ID of the library message to use when InactiveSurvey is set to DisplayMessage. See InactiveSurvey and InactiveMessageLibrary.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

InactiveMessageLibraryInactiveMessageLibrary (string)

Library ID associated with the Message ID in InactiveMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

NoIndexNoIndex (string)required

Prevent search engines from indexing the survey.

Possible values: [Yes, No]

Default value: Yes

nextButtonMidnextButtonMid (string)nullable

ID of the library message to display in the "next" button. Do not use in conjunction with NextButton.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

NextButtonNextButton (string)required

The text to use as the "next" Button. Note that BackButton should be enabled for this property to be used. See nextButtonMid and BackButton.

Default value: ←

PageTransitionPageTransition (string)

Transition between page navigation.

Possible values: [None, Slide, Fade, Flip, Barrel]

Default value: None

PartialDataPartialData (string)required

Specify how long a respondent can leave a survey unfinished before that survey automatically closes. A value of No specifies to delete partial completion data. See also PartialDataCloseAfter.

Possible values: [No, +1 hour, +4 hour, +1 day, +2 days, +3 days, +1 week, +2 weeks, +1 month, +3 months, +6 months, +1 year]

Default value: +1 week

PartialDataCloseAfterPartialDataCloseAfter (string)

When the partial data deadline starts, either by LastActivity or SurveyStart. See PartialData.

Possible values: [``, LastActivity, SurveyStart]

PasswordPassword (string)

The password to take the survey. See PasswordProtection.

PasswordProtectionPasswordProtection (string)nullable

Require a password to take the survey. See Password.

Possible values: [No, Yes]

Default value: No

previousButtonMidpreviousButtonMid (string)nullable

ID of the library message to display in the "previous" button. Do not use in conjunction with PreviousButton.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

PreviousButtonPreviousButton (string)required

The text to use as the "previous" Button. Note that BackButton should be enabled for this property to be used. See previousButtonMid and BackButton.

Default value: ←

ProgressBarDisplayProgressBarDisplay (string)required

Shows participants a progress bar.

Possible values: [None, Text, NoText, VerboseText]

Default value: None

QuestionsPerPageQuestionsPerPage (string)

Number of questions to display per page.

Possible values: Value must match regular expression ^[\d]+$

RecaptchaV3RecaptchaV3 (string)

Apply bot detection on the survey taking experience.

Possible values: [true, false]

RefererCheckRefererCheck (string)

Whether or not to restrict the URL respondents must come from to access the survey. See RefererURL.

Possible values: [No, Yes]

Default value: No

RefererURLRefererURL (string)

The URL respondents must come from to access the survey. See RefererCheck.

ResponseSummaryResponseSummary (string)

Shows the response summary at the end of the survey used when SurveyTermination is set to ResponseSummary.

Possible values: [Yes, No]

Default value: No

SaveAndContinueSaveAndContinue (boolean)required

If true, allow respondents to save and continue later.

Default value: true

SecureResponseFilesSecureResponseFiles (string)required

If true, uploaded files by respondents can only be viewed by the survey owner.

Possible values: [true, false]

Default value: true

Skin objectrequired

The skin definition.

oneOf

string
object

string

SurveyExpirationSurveyExpiration (string)nullablerequired

Sets the survey to be available during a specified time period. See SurveyStartDate and SurveyExpirationDate.

Possible values: [on, DateRange, None]

Default value: null

SurveyExpirationDatestring<date-time>nullable

When respondents can no longer take the survey.

SurveyMetaDescriptionSurveyMetaDescription (string)

Meta description for the survey, used by search engines and so forth.

Possible values: <= 100 characters

SurveyLanguageSurveyLanguage (string)

The default language of the survey.

Possible values: [AR, ASM, AZ-AZ, BEL, BG, BN, BS, CA, CEB, CH, CS, CY, DA, DE, EL, EN_GB, EN-US, EN, EO, ES-ES, ES, ET, FA, FI, FR-CA, FR, GU, HE, HE-ZA, HI, HIL, HR, HU, HYE, ID, ISL, IT, JA, KAN, KAT, KAZ, KM, KO, LT, LV, MAL, MAR, MK, MN, MS, MY, NL, NO, ORI, PA-IN, PL, PT-BR, PT, RO, RU, SIN, SK, SL, SQI, SR-ME, SR, SV, SW, TA, TEL, TGL, TH, TR, UK, UR, VI, ZH-S, ZH-T]

SurveyNameSurveyName (string)

Name of the survey

Possible values: <= 100 characters

SurveyProtectionSurveyProtection (string)required

Survey is either publicly available or restricted by invitation only

Possible values: [PublicSurvey, ByInvitation, PasswordProtected]

Default value: PublicSurvey

SurveyStartDatestring<date-time>nullable

When respondents can start taking the survey

SurveyTerminationSurveyTermination (string)nullablerequired

End of survey action such as showing respondents a response summary. See EOSMessageLibrary, EOSMessage, ResponseSummary, and EOSRedirectURL.

Possible values: [DefaultMessage, DisplayMessage, DisplayResult, ResponseSummary, Redirect]

Default value: DefaultMessage

SurveyTitleSurveyTitle (string)

Title of the survey, displayed to users on the browser window/tab.

Possible values: <= 100 characters

ThankYouEmailMessageThankYouEmailMessage (string)nullable

ID of the library message to use for the thank you email. See EmailThankYou and ThankYouEmailMessage.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

ThankYouEmailMessageLibraryThankYouEmailMessageLibrary (string)

Library ID associated with the Message ID in ThankYouEmailMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

ValidateMessageValidateMessage (string)

Whether or not to use a custom validation message. See ValidationMessage and ValidationMessageLibrary.

Possible values: [true, false]

Default value: false

ValidationMessageValidationMessage (string)nullablerequired

ID of the library message to use for the custom validation message. See ValidateMessage and ValidationMessageLibrary.

Possible values: Value must match regular expression ^(MS_[a-zA-Z0-9]{11,15})?$

Example: MS_abcdefg12345

ValidationMessageLibraryValidationMessageLibrary (string)

Library ID associated with the Message ID in ValidationMessage.

Possible values: Value must match regular expression ^(UR|GR)_[a-zA-Z0-9]{11,15}$

Example: UR_SomeUserId001

property name*any

SurveyIDSurvey Id (string)required

The unique identifier for this survey.

Possible values: Value must match regular expression ^SV_[a-zA-Z0-9]{11,15}$

SurveyNamestringrequired

SurveyStatusSurvey status (string)required

The distribution status of the survey, or a flag indicating that it's a library block

Possible values: [Inactive, Active, Pending, LibBlock, Deactive, Temporary]

LastModifiedstring<date-time>required

BrandIDstringrequired

OwnerIDUser Id (string)required

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

DivisionIDDivision Id (string)

The unique identifier for the Division ID.

Possible values: Value must match regular expression ^DV_[a-zA-Z0-9]{11,15}$

LastAccessedstring<date-time>required

The date the survey was last accessed

CreatorIDUser Id (string)required

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

LastActivatedstring<date-time>required

Questions objectrequired

Survey questions.

property name* Question definition

anyOf

ChoiceOrderstring[]required

The order the choices are to be displayed in.

Possible values: Value must match regular expression ^[\d]+$

Example: ["1","2"]

Choices objectrequired

Selections for a question

property name* object

Displaystring

property name*any

Configuration objectrequired

Configurations for how the question should be displayed

QuestionDescriptionOptionstring

An optional user-provided field for question descriptions.

Possible values: [UseText, SpecifyLabel]

TextPositionstring

Text position.

Possible values: [inline]

ChoiceColumnWidthinteger

Value of column width.

Possible values: [25]

RepeatHeadersstring

Repeating of headers.

Possible values: [none]

WhiteSpacestring

If white space is allowed.

Possible values: [ON, OFF]

LabelPositionstring

Position of label.

Possible values: [BELOW, SIDE]

NumColumnsinteger

Number of columns.

MobileFirstboolean

If questions should be formatted for use on a mobile device.

property name*any

Configurations for how the question should be displayed

DataExportTagDataExportTag (string)

The tag to identify the question in exported data.

Language objectrequired

Question translations

oneOf

string[]
object

Array [

string

]

NextAnswerIdinteger

NextChoiceIdinteger

QuestionDescriptionstringrequired

Label to identify the question

QuestionIDQuestion Id (string)

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

QuestionTextQuestionText (string)required

Text for the question.

Possible values: <= 1000 characters

QuestionTypestringrequired

Defines the structure and purpose of the question and determines how the question is presented to respondents.

Supported enum values
`MC` Multiple Choice

Possible values: [MC]

Randomization object

Randomize choices within a question.

oneOf

string
object

string

RecodeValues object

Numeric mapping of question choices.

property name*string

Selectorstringrequired

Defines the format used for collecting responses within the QuestionType and determines how respondents interact with the question to provide their answers.

Supported enum values
`DL` Dropdown List
`GRB` Graphic
`MACOL` Multi Answer Columns
`MAHR` Multi Answer Horizontal Row
`MAVR` Multi Answer Vertical Row
`MSB` Multi Select Box
`NPS` Net Promoter Score
`SACOL` Single Answer Column
`SAHR` Single Answer Horizontal Row
`SAVR` Single Answer Vertical Row
`SB` Select Box (single answer)
`TB` Text Block
`TXOT` With Text and Others
`PTB` Plain Text Box

Possible values: [DL, GRB, MACOL, MAHR, MAVR, MSB, NPS, SACOL, SAHR, SAVR, SB, TB, TXOT, PTB]

SubSelectorstringrequired

Refines the Selector by providing additional options or variations for response collection. It allows for more specific customization of how answers are gathered within the chosen question type and Selector.

Supported enum values
`GR` With Graphic
`TX` With Text
`TXOT` With Text and Others
`WOTXB` Without Text Box
`WTXB` With Text

Possible values: [GR, TX, TXOT, WOTXB, WTXB]

Validation objectrequired

Force respondents to answer a question or request that they consider answering the question before leaving the page

Settings objectrequired

CustomValidation object

Additional validation to direct respondents to answer questions in a certain way.

Logic objectrequired

Send respondents down different paths in the survey. See Qualtics Documentation for more information on Branch Logic

Typestringrequired

Type of branch logic.

Possible values: [BooleanExpression]

property name* object

oneOf

ChoiceLocator objectrequired

Locator.

anyOf

Classic locator, begins with two alpha characters followed by a | and any combination of alpha and | characaters
Current url locator regex pattern, matching entire string
Current url locator regex pattern, matching the entire string, allow no white space, this should mirror the above* regex but allow no white space

LogicTypestringrequired

The logic type of a question expression.

Possible values: [Question]

Operatorstringrequired

Operator.

Possible values: [Selected, NotSelected, EqualTo, NotEqualTo, Empty, NotEmpty, Displayed, NotDisplayed, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, Contains, DoesNotContain, MatchesRegex, IsNot, Uploaded, NotUploaded, PDF, Document, ClickedIn, NotClickedIn, Extensions, Graphic, Spreadsheet]

QuestionIDQuestion Id (string)required

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

QuestionIsInLoopstringrequired

If yes, question is in loop.

Possible values: [yes, no]

Typestringrequired

The type of question expression.

Possible values: [Expression]

Message objectrequired

Message to display when respondents don't fulfill the validation

descriptionstring

A user-provided description of the custom validation.

libraryID objectrequired

anyOf

User Id
Group Id

User Id (string)

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

messageIDMessage Id (string)required

The unique identifier for the message.

Possible values: Value must match regular expression ^MS_[a-zA-Z0-9]{11,15}$

subMessageIDstringrequired

The unique identifier for the subMessageID.

Possible values: [VE_FORCE_RESPONSE, VE_FORCE_RESPONSE_PLURAL, VE_FORCE_RESPONSE_MORE, VE_FORCE_RESPONSE_OTHER, VE_MIN_CHOICES, VE_MAX_CHOICES, VE_MAX_CHOICES_PGR, VE_MIN_CHOICES_MATRIX, VE_MAX_CHOICES_MATRIX, VE_MIN_CHOICES_HLText, VE_MAX_CHOICES_HLText, VE_INCORRECT_TOTAL, VE_TOO_MANY_CHARACTERS, VE_TOO_MANY_CHARACTERS_PLURAL, VE_TOO_FEW_CHARACTERS, VE_TOO_FEW_CHARACTERS_PLURAL, VE_NOT_CONSECUTIVE, VE_NOT_CONSECUTIVE_RANGE, VE_VALIDATION_FAILED, VE_VALIDUSSTATE, VE_VALIDCAPHONE, VE_VALIDUKPHONE, VE_VALIDUKZIP, VE_VALIDAUPHONE, VE_VALIDNLPHONE, VE_VALIDNZPHONE, VE_VALIDAUZIP, VE_VALIDNZZIP, VE_VALIDNLZIP, VE_VALIDUSZIP, VE_VALIDCAZIP, VE_VALIDDATE, VE_VALIDALTDATE, VE_VALIDINTLDATE, VE_VALIDNUMBER, VE_VALIDTEXTONLY, VE_VALIDUSSTATE_PLURAL, VE_VALIDEMAIL_PLURAL, VE_VALIDUSPHONE_PLURAL, VE_VALIDUSZIP_PLURAL, VE_VALIDDATE_PLURAL, VE_VALIDNUMBER_PLURAL, VE_VALIDTEXTONLY_PLURAL, VE_VALIDEXTENSIONS, VE_VALIDPDF, VE_VALIDDOCUMENT, VE_VALIDEMAIL, VE_VALIDSPREADSHEET, VE_VALIDGRAPHIC, VE_VALIDUPLOAD, VE_VALIDSCREENCAPTURE, VE_TEXT_ENTRY_HAS_VALUE_BUT_NOT_CHECKED, VE_TEXT_ENTRY_HAS_VALUE_BUT_NOT_RANKED, VE_SELECT_LEAST_MOST_PREFERRED, VE_SELECT_LEAST_MOST_LEVEL, VE_SELECT_MOST_VALUE_UPGRADE, VE_SELECT_VALUABLE_LEVEL, VE_IMPORTANCE_TOTAL, VE_MIN_GROUP_CHOICES, VE_MAX_GROUP_CHOICES, VE_VALIDNUMBER_MIN, VE_VALIDNUMBER_MAX, VE_VALIDMIN_PLURAL, VE_VALIDMAX_PLURAL, VE_VALIDNUMBER_NUM_DECIMALS, VE_FORCE_OTHER_RESPONSE, VE_HEADER_VALIDATION_MESSAGE, VE_CUSTOM_VALIDATION_NO_MESSAGE, VE_CUSTOM_VALIDATION_NOT_APPLIED, VE_QUESTION, VE_ERROR, VE_INCORRECT_CAPTCHA_RESPONSE, VE_MULTIPLE_CHOICES]

property name*any

Message to display when respondents don't fulfill the validation

property name*any

Additional validation to direct respondents to answer questions in a certain way.

ForceResponsestring

The forced response.

ForceResponseTypestring

The type of forced response.

Typestring

Settings type.

property name*any

Force respondents to answer a question or request that they consider answering the question before leaving the page

Blocks objectrequired

Survey blocks.

property name* BlockDefinition

anyOf

Reference Block
Standard Block
Trash Block
Conjoint Block

BlockElementsarray[]nullable

Typestringrequired

Possible values: [Standard]

SubTypestringrequired

Possible values: [Reference]

IDBlock Id (string)required

The ID of the survey's default block.

Possible values: Value must match regular expression ^BL_[a-zA-Z0-9]{11,15}$

Descriptionstringnullablerequired

LibraryID objectrequired

anyOf

User Id
Group Id

User Id (string)

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

ReferencedBlockIDReferencedBlockID (string)required

The unique identifier for the Reference Block.

Possible values: Value must match regular expression ^LB_[a-zA-Z0-9]{11,15}$

Options object

BlockLockingstring

Prevents modification of the block and its contents

Possible values: [true, false]

BlockPasswordstring

Authorization to modify the block

BlockVisiblitystring

Possible values: [Collapsed, Expanded]

RandomizeQuestionsstring

Possible values: [false, RandomWithXPerPage, RandomWithOnlyX, Advanced]

Loopingstring

Loop & Merge type

Possible values: [None, Static, Question]

LoopingOptions object

Options and configuration for Loop & Merge. Includes input fields and randomization

ChoiceGroupLocator object

Locator.

anyOf

Classic locator, begins with two alpha characters followed by a | and any combination of alpha and | characaters
Current url locator regex pattern, matching entire string
Current url locator regex pattern, matching the entire string, allow no white space, this should mirror the above* regex but allow no white space

Locator object

Locator.

anyOf

Classic locator, begins with two alpha characters followed by a | and any combination of alpha and | characaters
Current url locator regex pattern, matching entire string
Current url locator regex pattern, matching the entire string, allow no white space, this should mirror the above* regex but allow no white space

QIDQuestion Id (string)

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

Randomizationstring

Type of randomization to apply to the loop ordering

Possible values: [None, Subset, All]

Static object

The (static) fields in the Loop & Merge

property name*object

property name*any

Options and configuration for Loop & Merge. Includes input fields and randomization

Randomization

The configuration for the type of Randomization to apply. Many options based on 3 types of Randomization in RandomizeQuestions

Advanced object

contains related configuartions for Randomization options

QuestionsPerPageQuestionsPerPage (string)required

Number of questions to display per page.

Possible values: Value must match regular expression ^[\d]+$

FixedOrder object[]

Questions to display in a fixed order

Array [

oneOf

Question Id
string

Question Id (string)

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

]

RandomizeAll object[]

Questions to display in a randomized order

Array [

oneOf

Question Id
string

Question Id (string)

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

]

RandomSubSet object[]

Subset of questions to display in a randomized order

Array [

oneOf

Question Id
string

Question Id (string)

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

]

TotalRandSubsetstring

How many of the RandomSubSet questions to show in aggregate for a given respondent

Possible values: Value must match regular expression [\d]{1,3}

Undisplayed object[]

Array [

oneOf

Question Id
string

Question Id (string)

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

]

property name*any

contains related configuartions for Randomization options

EvenPresentationboolean

Whether or not to balance the number of times each Randomization.Advanced.RandomSubSet question is displayed across all respondents

property name*any

The configuration for the type of Randomization to apply. Many options based on 3 types of Randomization in RandomizeQuestions

NextButtonstring

The text on the next button at preview and runtime, or if nextButtonMID is set, the name of the message referred to there

PreviousButtonstring

The text on the previous button at preview and runtime, or if previousButtonMID is set, the name of the message referred to there

nextButtonLibraryID object

anyOf

User Id
Group Id

User Id (string)

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

nextButtonMIDMessage Id (string)

The unique identifier for the message.

Possible values: Value must match regular expression ^MS_[a-zA-Z0-9]{11,15}$

previousButtonLibraryIDMessage Id (string)

The unique identifier for the message.

Possible values: Value must match regular expression ^MS_[a-zA-Z0-9]{11,15}$

property name*any

ResponseSets objectrequired

Survey response sets.

property name*string

SurveyFlow objectrequired

FlowIDFlow Id (string)required

Unique identifier. Should be of form FL_1

Possible values: Value must match regular expression ^FL_[1-9][0-9]*$

TypeFlow type (string)required

Type of flow element. One of Authenticator, Block, BlockRandomizer, Branch, Conjoint, EmbeddedData, EndSurvey, Group, QuotaCheck, ReferenceSurvey, Root, Standard, SupplementalData, TableOfContents, WebService

Possible values: [Authenticator, Block, BlockRandomizer, Branch, Conjoint, EmbeddedData, EndSurvey, Group, QuotaCheck, ReferenceSurvey, Root, Standard, SupplementalData, TableOfContents, WebService]

Flow object[]required

Definition of the inner flow elements (maximum of 5000)

Array [

anyOf

Typestringrequired

Possible values: [Authenticator]

FlowIDFlow Id (string)

Unique identifier. Should be of form FL_1

Possible values: Value must match regular expression ^FL_[1-9][0-9]*$

PanelData objectrequired

LibraryIDUser Id (string)

The unique identifier for a specific user.

Possible values: Value must match regular expression ^UR_[a-zA-Z0-9]{11,15}$

PanelIDPanel Id (string)

The unique identifier for the Panel.

Possible values: Value must match regular expression ^CG_[a-zA-Z0-9]{11,15}$

Typestring

Type of SSO option.

Possible values: [Expression]

LogicTypestring

Logic type.

Possible values: [Panel]

property name*any

FieldData objectrequired

Send respondents down different paths in the survey. See Qualtics Documentation for more information on Branch Logic

Typestringrequired

Type of branch logic.

Possible values: [BooleanExpression]

property name* object

oneOf

ChoiceLocator objectrequired

Locator.

anyOf

Classic locator, begins with two alpha characters followed by a | and any combination of alpha and | characaters
Current url locator regex pattern, matching entire string
Current url locator regex pattern, matching the entire string, allow no white space, this should mirror the above* regex but allow no white space

LogicTypestringrequired

The logic type of a question expression.

Possible values: [Question]

Operatorstringrequired

Operator.

QuestionIDQuestion Id (string)required

The unique identifier for the question.

Possible values: Value must match regular expression ^QID[a-zA-Z0-9]+$

QuestionIsInLoopstringrequired

If yes, question is in loop.

Possible values: [yes, no]

Typestringrequired

The type of question expression.

Possible values: [Expression]

FilterDataFieldsbooleanrequired

If true, filter data fields.

SSOOptions objectrequired

SSO options.

CaptureRespondentInfostring

Capture respondent info.

Possible values: [Yes, No]

casstring[]

Central Authentication Service.

ldap object

Lightweight Directory Access Protocol

Hostnamestring

Hostname.

Possible values: <= 100 characters

Portstring

Port.

Possible values: <= 100 characters

EmailFieldstring

Email field.

Possible values: <= 100 characters

ExternalDataReferenceFieldstring

External data reference field.

Possible values: <= 100 characters

Filterstring

Filter.

Possible values: <= 100 characters

FirstNameFieldstring

Field for first name.

Possible values: <= 100 characters

LastNameFieldstring

Field for last name.

Possible values: <= 100 characters

property name*any

Lightweight Directory Access Protocol

respondentMap object[]

Respondent map.

Possible values: <= 100

Array [

keystring

A unique identifier for a value.

valuestring

An attribute associated with key.

property name*any

Object.

]

token object

Token.

EncryptionMethodstring

Encryption method for the token.

Possible values: [3DES, AES128, BLOWFISH]

Keystring

Token key.

Leewayinteger

Leeway.

MacMethodstring

MacMethod.

Possible values: [md5, MD5, sha1, sha256, sha512]

BlockCipherstring

Block Cipher.

Possible values: [CBC, ECB]

property name*any

Token.

Typestringrequired

SSO option type.

Possible values: [Token, CAS, LDAP, LTI, Shibboleth, UseBrandSettings, GoogleOpenID, Facebook]

UsePanelstring

Use Panel.

Possible values: [Yes, No]

UsePersonstring

Use person.

Possible values: [Yes, No]

UseSSOstring

Use SSO.

Possible values: [Yes, No]

property name*any

SSO options.

Options objectrequired

SSO options.

maxAttemptsinteger

Maximum number of attempts allowed.

authenticationError object

Authenticator message.

SystemMessage object

System message.

Sectionstring

Section of system message.

Possible values: [ErrorCodes]

Messagestring

System message.

Possible values: Value must match regular expression ^EAUTH\d+$

property name*any

System message.

property name*any

Authenticator message.

failedAuthenticationError object

Authenticator message.

SystemMessage object

System message.

Sectionstring

Section of system message.

Possible values: [ErrorCodes]

Messagestring

System message.

Possible values: Value must match regular expression ^EAUTH\d+$

property name*any

System message.

property name*any

Authenticator message.

questionText object

Authenticator message.

SystemMessage object

System message.

Sectionstring

Section of system message.

Possible values: [ErrorCodes]

Messagestring

System message.

Possible values: Value must match regular expression ^EAUTH\d+$

property name*any

System message.

property name*any

Authenticator message.

allowRetakeboolean

If true, allow retake.

loadExistingSessionboolean

If true, load existing session.

property name*any

SSO options.

Flow

]

Properties objectrequired

Provides information to describe the flow structure such as Count, which is the total number of flow elements.

Countinteger

The total number of flow element.

property name*any

Provides information to describe the flow structure such as Count, which is the total number of flow elements.

property name*any

Scoring objectrequired

ScoringCategories object[]required

Scoring categories.

Array [

Descriptionstringrequired

A user-provided description of the survey scoring.

IDScoring Id (string)required

The unique identifier for the scoring.

Possible values: Value must match regular expression ^SC_[a-zA-Z0-9]{11,15}$

Namestringrequired

The names of the scoring categories.

property name*any

Scoring categories.

]

ScoringCategoryGroups object[]required

Array [

CategoriesScoring Id (string)[]required

The scoring categories.

Possible values: Value must match regular expression ^SC_[a-zA-Z0-9]{11,15}$

IDScoring Group Id (string)required

The unique identifier for the scoring group.

Possible values: Value must match regular expression ^SCG_[a-zA-Z0-9]{11,15}$

Namestringrequired

The names of the scoring category groups.

property name*any

]

ScoringSummaryCategoryScoring Id (string)required

The unique identifier for the scoring.

Possible values: Value must match regular expression ^SC_[a-zA-Z0-9]{11,15}$

ScoringSummaryAfterQuestions objectrequired

If scoring summary is after questions.

oneOf

boolean
integer
string

boolean

ScoringSummaryAfterSurvey objectrequired

If scoring summary is after survey.

oneOf

boolean
integer
string

boolean

DefaultScoringCategoryScoring Id (string)required

The unique identifier for the scoring.

Possible values: Value must match regular expression ^SC_[a-zA-Z0-9]{11,15}$

AutoScoringCategorystringrequired

The automated scoring category.

property name*any

ProjectInfo objectrequired

SurveyIDSurvey Id (string)required

The unique identifier for this survey.

Possible values: Value must match regular expression ^SV_[a-zA-Z0-9]{11,15}$

ProjectCategoryProjectCategory (string)required

Project category of the survey

Possible values: [CORE, CX, EX, BX, PX]

ProjectTypestringnullablerequired

Possible values: >= 5 characters and <= 50 characters, Value must match regular expression ^[a-zA-Z]+$

SchemaVersionstringrequired

Possible values: [1.1.0]

CompositionTypestringnullablerequired

ContentBundle object

BundleShortNamestringrequired

Possible values: <= 100 characters

RegistryShastringrequired

Possible values: <= 100 characters

RegistryVersionstringrequired

Possible values: <= 100 characters

SurveyInputVariablesobject[]required

property name*any

BrandBaseURLstring<uri>required

property name*any

Get survey version response
{
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  },
  "result": {
    "QuestionCount": "string",
    "SurveyOptions": {
      "AnonymizeResponse": "No",
      "Autofocus": true,
      "Autoadvance": true,
      "AutoadvancePages": true,
      "AvailableLanguages": {},
      "BackButton": false,
      "BallotBoxStuffingPrevention": false,
      "BallotBoxStuffingPreventionBehavior": "default",
      "BallotBoxStuffingPreventionMessage": "MS_abcdefg12345",
      "BallotBoxStuffingPreventionMessageLibrary": "UR_SomeUserId001",
      "BallotBoxStuffingPreventionURL": "string",
      "CollectGeoLocation": "true",
      "CustomStyles": {},
      "CustomLanguages": {},
      "EmailThankYou": "false",
      "EOSMessage": "MS_abcdefg12345",
      "EOSRedirectURL": "string",
      "ExternalCSS": "string",
      "headerMid": "MS_abcdefg12345",
      "Header": "string",
      "footerMid": "MS_abcdefg12345",
      "Footer": "string",
      "InactiveSurvey": "DefaultMessage",
      "InactiveMessage": "MS_abcdefg12345",
      "InactiveMessageLibrary": "UR_SomeUserId001",
      "NoIndex": "Yes",
      "nextButtonMid": "MS_abcdefg12345",
      "NextButton": " ← ",
      "PageTransition": "None",
      "PartialData": "+1 week",
      "PartialDataCloseAfter": "",
      "Password": "string",
      "PasswordProtection": "No",
      "previousButtonMid": "MS_abcdefg12345",
      "PreviousButton": " ← ",
      "ProgressBarDisplay": "None",
      "QuestionsPerPage": "string",
      "RecaptchaV3": "true",
      "RefererCheck": "No",
      "RefererURL": "string",
      "ResponseSummary": "No",
      "SaveAndContinue": true,
      "SecureResponseFiles": "true",
      "Skin": "string",
      "SurveyExpiration": "on",
      "SurveyExpirationDate": "2024-07-29T15:51:28.071Z",
      "SurveyMetaDescription": "string",
      "SurveyLanguage": "AR",
      "SurveyName": "string",
      "SurveyProtection": "PublicSurvey",
      "SurveyStartDate": "2024-07-29T15:51:28.071Z",
      "SurveyTermination": "DefaultMessage",
      "SurveyTitle": "string",
      "ThankYouEmailMessage": "MS_abcdefg12345",
      "ThankYouEmailMessageLibrary": "UR_SomeUserId001",
      "ValidateMessage": "false",
      "ValidationMessage": "MS_abcdefg12345",
      "ValidationMessageLibrary": "UR_SomeUserId001"
    },
    "SurveyID": "string",
    "SurveyName": "string",
    "SurveyStatus": "Inactive",
    "LastModified": "2024-07-29T15:51:28.071Z",
    "BrandID": "string",
    "OwnerID": "string",
    "DivisionID": "string",
    "LastAccessed": "2024-07-29T15:51:28.071Z",
    "CreatorID": "string",
    "LastActivated": "2024-07-29T15:51:28.071Z",
    "Questions": {},
    "Blocks": {},
    "ResponseSets": {},
    "SurveyFlow": {
      "FlowID": "string",
      "Type": "Authenticator",
      "Flow": [
        {
          "Type": "Authenticator",
          "FlowID": "string",
          "PanelData": {
            "LibraryID": "string",
            "PanelID": "string",
            "Type": "Expression",
            "LogicType": "Panel"
          },
          "FieldData": {
            "Type": "BooleanExpression"
          },
          "FilterDataFields": true,
          "SSOOptions": {
            "CaptureRespondentInfo": "Yes",
            "cas": [
              "string"
            ],
            "ldap": {
              "Hostname": "string",
              "Port": "string",
              "EmailField": "string",
              "ExternalDataReferenceField": "string",
              "Filter": "string",
              "FirstNameField": "string",
              "LastNameField": "string"
            },
            "respondentMap": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "token": {
              "EncryptionMethod": "3DES",
              "Key": "string",
              "Leeway": 0,
              "MacMethod": "md5",
              "BlockCipher": "CBC"
            },
            "Type": "Token",
            "UsePanel": "Yes",
            "UsePerson": "Yes",
            "UseSSO": "Yes"
          },
          "Options": {
            "maxAttempts": 0,
            "authenticationError": {
              "SystemMessage": {
                "Section": "ErrorCodes",
                "Message": "string"
              }
            },
            "failedAuthenticationError": {
              "SystemMessage": {
                "Section": "ErrorCodes",
                "Message": "string"
              }
            },
            "questionText": {
              "SystemMessage": {
                "Section": "ErrorCodes",
                "Message": "string"
              }
            },
            "allowRetake": true,
            "loadExistingSession": true
          }
        },
        {
          "ID": "string",
          "Type": "Block",
          "FlowID": "string"
        },
        {
          "Type": "BlockRandomizer",
          "FlowID": "string",
          "SubSet": 0,
          "EvenPresentation": true
        },
        {
          "Type": "Branch",
          "FlowID": "string",
          "Description": "string",
          "BranchLogic": {
            "Type": "BooleanExpression"
          }
        },
        {
          "Type": "EmbeddedData",
          "FlowID": "string",
          "EmbeddedData": [
            {
              "Description": "string",
              "Type": "Recipient",
              "Field": "string",
              "VariableType": "Nominal",
              "DataVisibility": {
                "Private": true,
                "Hidden": true
              },
              "AnalyzeText": true,
              "Value": "string"
            }
          ]
        },
        {
          "Type": "EndSurvey",
          "FlowID": "string"
        },
        {
          "Type": "Group",
          "FlowID": "string",
          "Description": "string"
        },
        {
          "Type": "ReferenceSurvey",
          "ID": "string",
          "FlowID": "string",
          "Description": "string",
          "LibraryID": "string"
        },
        {
          "Type": "TableOfContents",
          "FlowID": "string",
          "Description": "string",
          "Options": {
            "ShowSidebar": "Yes",
            "TocConclusion": "Yes"
          }
        },
        {
          "Type": "WebService",
          "FlowID": "string",
          "URL": "string",
          "Method": "GET",
          "RequestParams": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "EditBodyParams": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "Body": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "ContentType": "application/x-www-form-urlencoded",
          "Headers": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "ResponseMap": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "FireAndForget": true,
          "StringifyValues": true
        }
      ],
      "Properties": {
        "Count": 0
      }
    },
    "Scoring": {
      "ScoringCategories": [
        {
          "Description": "string",
          "ID": "string",
          "Name": "string"
        }
      ],
      "ScoringCategoryGroups": [
        {
          "Categories": [
            "string"
          ],
          "ID": "string",
          "Name": "string"
        }
      ],
      "ScoringSummaryCategory": "string",
      "ScoringSummaryAfterQuestions": true,
      "ScoringSummaryAfterSurvey": true,
      "DefaultScoringCategory": "string",
      "AutoScoringCategory": "string"
    },
    "ProjectInfo": {
      "SurveyID": "string",
      "ProjectCategory": "CORE",
      "ProjectType": "string",
      "SchemaVersion": "1.1.0",
      "CompositionType": "string",
      "ContentBundle": {
        "BundleShortName": "string",
        "RegistrySha": "string",
        "RegistryVersion": "string",
        "SurveyInputVariables": [
          {}
        ]
      }
    },
    "BrandBaseURL": "string"
  }
}