BlockElements

All of the elements contained by the block

Array [

oneOf

• Question block element
• Page break element

Typestringrequired

Possible values: [Question]

QuestionIDQuestion Id (string)required

The unique identifier for the question.

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

SkipLogic object[]

Defines how flow skips to a question, the end of block or end of survey based on logic

Array [

SkipLogicIDstring

The ID of the logic.

Possible values: Value must match regular expression [0-9]{1,3}

ChoiceIDstring

The ID of the choice.

Possible values: Value must match regular expression [0-9]{1,3}

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

Conditionstringrequired

All the possible skip logic conditions

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

Descriptionstring

a user-provided description field.

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

QuestionIDQuestion Id (string)required

The unique identifier for the question.

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

SkipToDescriptionstring

The text description of the skip condition

SkipToDestination object

Where to send respondents when the condition is satisfied

oneOf

• string
• Survey Id

string

Possible values: [ENDOFBLOCK, ENDOFSURVEY]

property name*any

]

]

BlockElements

[
  {
    "Type": "Question",
    "QuestionID": "string",
    "SkipLogic": [
      {
        "SkipLogicID": "string",
        "ChoiceID": "string",
        "Condition": "Selected",
        "Description": "string",
        "QuestionID": "string",
        "SkipToDescription": "string",
        "SkipToDestination": "ENDOFBLOCK"
      }
    ]
  },
  {
    "Type": "Page Break"
  }
]