Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
To add registration questions to an Event using API, use asset-interaction-response-update Web Service API.
Availability
Adobe Connect 9.5.4
Description
Add registration questions to en Event using this API.
Request URL
http://server_name/api/xml?action=asset-interaction-response-update &interaction-type=string &asset-type=string &is-required=boolean &sco-id=integer &csvResponse=string &csvChoicesEnabled=boolean &description=string &response-display-seq=integer&response-description=string &response-display-seq=integer&response-description=string &response-display-seq=integer&response-description=string &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
sco-id |
Integer |
Yes |
Sco ID of an event |
|
asset-type |
String |
Yes |
Type of asset data (currently only accepts type output) |
|
interaction-type |
String |
Yes |
Type of a question:
|
|
is-required |
Boolean |
Yes |
Indicates whether answering a question is mandatory or not. True means required otherwise the question can be skipped. |
|
description |
String |
Yes |
Description of a question. |
|
csvChoicesEnabled |
Boolean |
No |
The parameter applies only in the case of multiple choice questions. True means answers are in comma separated format. |
|
csvResponse |
String |
No |
The parameter applies when csvChoicesEnabled is true and contains the list of answers in comma separated format. |
|
response-display-seq=string&response-description=string |
String |
No |
This parameter applies only in the case of multiple-choice question. It is used to list all the answers applicable to a question. response-display-seq indicates sequence of answer in the list of answers. response-description contains answer of a question It is recommended to use a CSV to create question. |
|
session |
|
No |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response or return structure
<results>
<status code="ok"/>
<asset-interaction interaction-type="choice" is-required="true" asset-id="12573" display-seq="1" interaction-id="13101">
<description>California</description>
<name>Interaction_obckfghghh</name>
</asset-interaction>
</results>
Sample requests and sample responses
The following API call creates a multiple choice question with answers.
http://www.example.com/api/xml?action=asset-interaction-response-update&csvChoicesEnabled=false&response-display-seq=2&response-description=USA&asset-type=output&response-display-seq=1&response-description=North California&csvResponse=&response-description=North California&interaction-type=choice&response-display-seq=3&response-description=California&response=%20&response-counter=1&is-required=true&description=Where is San Diego&sco-id=12542&response-display-seq=1
The sample response of the multiple choice question creationAPI call is
<results>
<status code="ok"/>
<asset-interaction interaction-type="choice" is-required="true" asset-id="15227" display-seq="3" interaction-id="20545">
<description>South California</description>
<name>Interaction_evv3gda8fy</name>
</asset-interaction>
</results>
The following API call creates a question with answers in the comma separated format.
http://www.example.com/api/xml?action=asset-interaction-response-update&interaction-type=choice&csvChoicesEnabled=true&asset-type=output&is-required=true&description=Where%20is%20San%20Francisco?&csvResponse=California,%20USA,%20North%20California&sco-id=12542&response=%20&response-description=
The sample response of the preceding API call is
<results>
<status code="ok"/>
<asset-interaction interaction-type="choice" is-required="true" asset-id="15227" display-seq="3" interaction-id="20544">
<description>South California</description>
<name>Interaction_uxw2asgdz6</name>
</asset-interaction>
</results>
The following API call creates a question that needs a short answer.
http://example.com/api/xml?action=asset-interaction-response-update&sco-id=15201&interaction-type=fill-in&asset-type=output&description=Describe Adobe in 5 words?&input-data-type=text-interaction&is-required=true
The sample response of the short answer creation API call is
<results>
<results>
<status code="ok"/>
<asset-interaction interaction-type="fill-in" input-data-type="text-interaction" is-required="true" interaction-id="20546" asset-id="15227" display-seq="3">
<description>Describe Adobe in 5 words?</description>
<name>Interaction_x32nvabcuk</name>
</asset-interaction>
</results>
The following API call creates a question that needs a Yes or No answer.
http://example.com/api/xml?action=asset-interaction-response-update&sco-id=15201&asset-type=output&interaction-type=true-false&description=Does the sun rise in the west?&is-required=true
A sample response of the Boolean question creation API call is
<results>
<status code="ok"/>
<asset-interaction interaction-type="true-false" is-required="true" interaction-id="20548" asset-id="15227" display-seq="4">
<description>Does the sun rise in the west?</description>
<name>Interaction_d8fzowweh8</name>
</asset-interaction>
</results>
Response or return values
Element |
Attribute |
Type |
Description |
results |
|
Container |
All the results that are returned by the call. |
status |
|
Empty, with attributes |
The status of the response. |
|
code |
Allowed value |
A code indicating the response status (see status). |
asset-interaction |
|
Container |
Contains information about the interaction. Multiple interactions can be part of the SCO. |
|
interaction-id |
Integer |
The ID of the interaction. |
|
asset-id |
Integer |
The ID of the asset associated with the event. The asset-id changes when you add or update a new content version. |
|
display-seq |
Integer |
The sequence number of the interactions assigned to the SCO. |
|
input-data-type |
String |
Data type for the interaction. |
|
interaction-type |
String |
Type of the method used for interaction, choice for multiple choice question, tracking-id for campaign tracking, and so on. |
|
is-required |
Boolean |
Flag indicating whether the interaction is required or not. The value True indicates that the interaction is required. |
|
source-interaction-id |
Integer |
The source of an interaction. |
|
description |
String |
The description of the question. |
|
name |
String |
The name of the question. |
