Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
API to get a list of the possible answers of a question in a quiz.
Availability
Adobe Connect 9.4
Description
This API returns a list of all of the possible answers for a question in a quiz, including the response selection item and its description. You can also filter the responses to focus on a particular response.
Request URL
https://example.com/api/xml?action=report-asset-response-info&sco-id={sco-id}&asset-type=output&interaction-id={question-id}
Parameters
|
|
Type |
Required |
Description |
|
sco-id |
BIGINT |
Yes |
SCO ID of a training. |
|
asset-type |
String |
Yes |
Type of the asset data to return. It accepts the type ‘output’. |
|
interaction-id |
BIGINT |
Yes |
Filters by a specific question ID (Interaction ID). An interaction is a combination of one question and all of the possible answers. |
Filters
You can filter or sort the response on any element or attribute it contains.
|
Name |
Type |
Required |
Description |
|
filter-definition |
Value |
No |
A filter to filter specific items from a response and reduce the volume of the response. |
Response structure
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-asset-responses>
<response interaction-id="{question-id}" display-seq="{sequence order of response}">
<response>{response order}</response>
<description>{response text}</description>
</response>
</report-asset-responses>
</results>
Response values
This API returns the event message with the run time fields resolved and substituted with actual values.
|
Element |
Attribute |
Type |
Description |
|
results |
|
|
All results that the action returns. |
|
status |
|
|
The status of a response. |
|
|
code |
|
A code indicating the response status. |
|
report-asset-responses |
|
|
Information about all of the individual response values. |
|
response |
|
|
Information about one particular response. |
|
|
interaction-id |
BIGINT |
The ID of a particular question in the quiz. |
|
|
display-seq |
|
The sequence number of a particular question in the quiz. |
|
response |
|
|
The response of a question. Typically, for multiple-choice questions, the response is simply the order of options, for example ‘A’ and for true-false questions, the response is the text True or False. |
|
description |
|
|
The actual text of a response. Typically, for multiple-choice questions, the response is the text the user chooses and for true-false questions, the response is the text True or False. |
Sample request
https://example.com/api/xml?action=report-asset-response-info&sco-id=24702&asset-type=output&interaction-id=20705
Sample response
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
<report-asset-responses>
<response interaction-id="20705" display-seq="1">
<response>A</response>
<description>War of 1812</description>
</response>
<response interaction-id="20705" display-seq="2">
<response>B</response>
<description>Civil War</description>
</response>
<response interaction-id="20705" display-seq="3">
<response>C</response>
<description>The Great War</description>
</response>
<response interaction-id="20705" display-seq="4">
<response>D</response>
<description>Korean War</description>
</response>
</report-asset-responses></results>
