Validation

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

Validation
{
  "Settings": {
    "CustomValidation": {
      "Logic": {
        "Type": "BooleanExpression"
      },
      "Message": {
        "description": "string",
        "libraryID": "string",
        "messageID": "string",
        "subMessageID": "VE_FORCE_RESPONSE"
      }
    },
    "ForceResponse": "string",
    "ForceResponseType": "string",
    "Type": "string"
  }
}