Get flow 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

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

• AuthenticatorFlowElement
• BlockStandardFlowElement
• BlockRandomizerFlowElement
• BranchFlowElement
• EmbeddedDataFlowElement
• EndSurveyFlowElement
• GroupFlowElement
• ReferenceSurveyFlowElement
• TableOfContentsFlowElement
• WebServiceFlowElement

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

• QuestionExpression
• EmbeddedDataExpression
• DeviceTypeExpression
• QuotaExpression
• GeoIPExpression
• EvaluatorMetadataExpression
• PanelDataExpression
• LoopAndMergeExpression
• RelationshipExpression
• SubjectMetadataExpression
• OrgHierarchyUnitsExpression
• OrgHierarchyMetadataExpression

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]

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

Get flow response

{
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  },
  "result": {
    "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
    }
  }
}