CreateBlockRequest

anyOf

• Reference Block
• Standard Block
• Trash Block
• Conjoint Block

BlockElementsundefined[]

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

CreateBlockRequest

{
  "BlockElements": [
    null
  ],
  "Type": "Standard",
  "SubType": "Reference",
  "ID": "string",
  "Description": "string",
  "LibraryID": "string",
  "ReferencedBlockID": "string",
  "Options": {
    "BlockLocking": "true",
    "BlockPassword": "string",
    "BlockVisiblity": "Collapsed",
    "RandomizeQuestions": "false",
    "LoopingOptions": {
      "QID": "string",
      "Randomization": "None",
      "Static": {}
    },
    "Randomization": {
      "Advanced": {
        "QuestionsPerPage": "string",
        "FixedOrder": [
          "string",
          "{~Randomized~}"
        ],
        "RandomizeAll": [
          "string",
          "{~Randomized~}"
        ],
        "RandomSubSet": [
          "string",
          "{~Randomized~}"
        ],
        "TotalRandSubset": "string",
        "Undisplayed": [
          "string",
          "{~Randomized~}"
        ]
      },
      "EvenPresentation": true
    },
    "NextButton": "string",
    "PreviousButton": "string",
    "nextButtonLibraryID": "string",
    "nextButtonMID": "string",
    "previousButtonLibraryID": "string"
  }
}