Name
Last updated on
May 15, 2021
Availability
Breeze 5
Description
Provides information about each event the current user has attended or is scheduled to attend. The user can be either a host or a participant in the event. The events returned are those in the user’s my-events folder.
To obtain information about all events on your Adobe Connect Server or in your Adobe Connect hosted account, call sco-shortcuts to get the sco-id of the events folder. Then, call sco-contents with the sco-id to list all events.
Request URL
http://server_name/api/xml ?action=report-my-events &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
filter-definition |
Filter definition |
N |
A filter to reduce the volume of the response. |
|
sort-definition |
Sort definition |
N |
A sort to return results in a certain sequence. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
You can filter or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <my-events> <event sco-id=integer type="event" icon="event" permission-id=allowedValue> <name>string</name> <domain-name>string</domain-name> <url-path>string</url-path> <date-begin>datetime</date-begin> <date-end>datetime</date-end> <expired>boolean</expired> <duration>datetime/duration> </event> ... </my-events> </results>
Response values
Element |
Attribute |
Type |
Description |
|---|---|---|---|
| results | Container |
All results the action returns. |
|
| status | Empty, with attributes |
The status of the response. |
|
| code | Allowed value |
A code indicating the response status (see status). |
|
| my-events | Container |
The entire list of events the user is or has been registered for. |
|
| event | Container |
Information about one event. |
|
| sco-id | BIGINT |
The unique ID of the event. |
|
| type | Allowed value |
The type of the object. For an event, always event. |
|
| icon | Allowed value |
An icon identifying the object. For an event, always event. |
|
| permission-id | Allowed value |
The permission the user has for the event (see permission-id for values). |
|
| name | String |
The name of the event. |
|
| domain-name | String |
The domain name of the Adobe Connect server, which comes after http:// (or https://) and before the unique event name in the event URL. |
|
| url-path | String |
The unique event name, which comes after the domain name in the event URL. |
|
| date-begin | Date |
The date the event begins, in ISO 8601 format. |
|
| date-end | Date |
The date the event ends, in ISO 8601 format. |
|
| expired | Boolean |
A value indicating whether the event has ended. If the event is currently underway, the value is false. |
|
| duration | Time |
The amount of time the event is scheduled to last. Uses the time portion of an ISO 8601 date format. |
Sample request
https://example.com/api/xml?action=report-my-events
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <my-events> <event sco-id="2006334107" type="event" icon="event" permission-id="host"> <name>Meet the Famous Author</name> <domain-name>example.com</domain-name> <url-path>/author/</url-path> <date-begin>2006-05-12T18:00:00.000-07:00</date-begin> <date-end>2006-05-12T20:00:00.000-07:00</date-end> <expired>true</expired> <duration>02:00:00.000</duration> </event> </my-events> </results>
