Availability
Adobe Connect 9.
Description
This action lists all the users associated with an event. For each user, the action shows lead qualification status, registration question responses like, name and email ID, and meeting interactions like, poll responses and file download activity.
Request URL
http://server_name/api/xml?action=report-event-participants-complete-information&sco-id=integer
Parameters
Parameter Name |
Type |
Required |
Description |
---|---|---|---|
sco-id |
BIGINT |
Yes |
Sco id associated with an event. |
Filters
Results cannot be filtered or sorted.
Response structure
<results> <status code=allowedValue/> <poll_questions> <question id=integer description=string/> ... more question elements... </poll_questions> <registration_questions> <question id=integer description=string/> ... more question elements... </registration_questions> <user_list> <user principal_id=integer permission_id=allowedValue name=string login=string registration_time=datetime attendance_status=allowedValue first_in_time=datetime last_end_time=datetime duration=time isLead=string registration_question_<id>=string poll_question_<id>=string > <qa> <question<n> description=string> <answer<n> description=string/> ...more answer<n> elements... </question<n>> ... more question<n> elements... </qa> <files_downloaded> <file<n> name=string/> ...more file<n> elements... </files_downloaded> </user> ... more user elements... </user_list> </results>
Response values
Element |
Attribute |
Type |
Description |
---|---|---|---|
user_list |
- |
- |
The parent tag of the user list |
user |
- |
- |
A particular user associated with the event |
user |
principal_id |
BIGINT |
Principal ID of the user. |
user |
permission_id |
String |
The permission rights of the user with this event. |
user |
login |
String |
The login ID of the user. |
user |
registration_time |
datetime |
The registration time of the user. |
user |
attendance_status |
Integer |
Whether the user has attended the event or not. |
user |
first_in_time |
datetime |
The last logout time from the event. This attribute is defined only if event is associated with a live content. |
user |
last_end_time |
datetime |
The last logout time from the event. This attribute is defined only if event is associated with a live content. |
user |
duration |
time |
Total duration for which event is attended by the user. This attribute is defined only if event is associated with a live content. |
user |
isLead |
Boolean |
Whether user is qualified lead or not depending upon Qualified Lead criteria set. |
user |
registration_question_{id} |
String |
Answer to a registration question id. Detail of question id is defined using xpath \results\registration_questions\question@id |
user |
poll_question_{id} |
String |
Answer to a poll question id. Detail of question id is defined using xpath \results\poll_questions\question@id |
files_downloaded |
- |
- |
list of file elements for each file downloaded in the event. |
file<n> |
name |
- |
A specific file downloaded in a event. |
qa |
- |
- |
Contains list of question elements for each question asked in the Q & A pod. |
question<n> |
- |
- |
A specific question asked by a user. |
question<n> |
description |
String |
Question text |
answer<n> |
- |
- |
Answer for the question asked. |
answer<n> |
description |
String |
Answer text |
registration_questions |
- |
- |
List of registration questions associated with the event. |
registration_questions\question |
- |
- |
A specific registration question. |
registration_questions\question |
id |
Integer |
Registration question id. |
registration_questions\question |
description |
String |
Registration question text. |
poll_questions |
- |
- |
List of poll questions associated with this event. |
poll_questions\question |
- |
- |
A specific poll question. |
registration_questions\question |
id |
BIGINT |
Poll question ID. |
registration_questions\question |
description |
String |
Poll question text. |
Sample request
http://example.com/api/xml?action=report-event-participants-complete-information&sco-id=14968
Sample response
<results> <status code="ok"/> <poll_questions> <question id="14017" description="Poll question 1?"/> <question id="14018" description="Poll question 2?"/> </poll_questions> <registration_questions> <question id="13725" description="Registration question 1?"/> <question id="13727" description="Registration question 2?"/> </registration_questions> <user_list> <user principal_id="13796" permission_id="View" name="User 1" login="user1@example.com" registration_time="05/30/2012 2:50 PM" attendance_status="Attended" first_in_time="05/30/2012 3:15 PM" last_end_time="05/30/2012 3:40 PM" duration="0:24:30" isLead="Yes" registration_question_13725=" " registration_question_13727="yes" poll_question_14017="user 1 poll 1 answer" poll_question_14018="user 1 poll 2 answer" > <qa> <question1 description="QnA user 1 question 1"/> <question2 description="QnA user 1 question 2"> <answer1 description="QnA user 2 question 2 answer"/> </question2> </qa> <files_downloaded> <file1 name="SampleFile.txt"/> </files_downloaded> </user> <user principal_id="13728" permission_id="View" name="User 2" login="user2@example.com" registration_time="05/30/2012 2:28 PM" attendance_status="Attended" first_in_time="05/30/2012 3:26 PM" last_end_time="05/30/2012 3:33 PM" duration="0:6:34" isLead="No" registration_question_13725="user 2 registration question 1 answer" registration_question_13727="no" poll_question_14017=" user 2 poll 1 answer" poll_question_14018="user 2 poll 2 answer" > <qa> <question1 description="QnA user 2 question 1"/> <question2 description="QnA user 2 question 2"/> </qa> <files_downloaded/> </user> </user_list> </results>