Passing Show Survey responses

Passing Show Survey responses

Several API calls (Create User, Update User, etc) allow the passing of Show Survey responses. These should be combined into a single delimited parameter value. The format for this value is:

 $[QuestionKey-AnswerKey{TextEntryAnswer}]$

QuestionKey and AnswerKey are valid keys for an existing Show Survey associated with a Show for which the user has access. TextEntryAnswer can be any text value to be associated with the specified AnswerKey. Multiple Show Survey response values can be passed at the same time by concatenating multiple delimited field values.

Example:

 $[145-2312]$$[146-2319{Blue}]$

 

The keys passed must be valid for a Show Survey associated with a Show the user has access to. Invalid keys will be ignored.

An alternate format for Show Survey data may be used when key values are not known. This format is:

 $[XExternalID-AnswerDescription{TextEntryAnswer}]$

 

The ExternalID corresponds to the External ID value configured for a Show Survey Question and AnswerDescription corresponds to the description of a valid answer for that question. The X character differentiates this format from the standard format and is required when using the alternate format. Multi-Select responses are not supported in this format.

 

Multi-Select Responses

When a Show Survey is configured to allow multiple responses, the AnswerKey portion of the delimited value can be a caret (^) delimited list of ShowSurveyAnswerKey values, with a trailing caret.

 

ShowSurveyQuestionKey and ShowSurveyAnswerKey values can be obtained from Notified.

Example passing multiple Show Survey responses with a multi-select response including a text value to be associated with an answer:

$[145-2312]$$[146-2319^2320^2322{Blue}^]$