Availability
Adobe Connect 9.1.
Description
This API is used to create seminar sessions.
Parameters
Parameter Name |
Type |
Required |
Description |
|---|---|---|---|
parent-acl-id |
BIGINT |
Yes |
ID of the seminar for which a session is created. |
sco-id |
BIGINT |
Yes |
ID of the seminar session. Prior to using this API, create the seminar session ID using sco-update API. Call acl-field-update API after seminar-session-sco-update call to associate the load with the seminar session ID. |
name |
String |
Yes |
Seminar session name. |
source-sco-id |
BIGINT |
No |
ID of seminar for which session needs to be created. This is same as the parent-acl-id. |
date-begin |
Date |
Yes |
Session’s start date. A sample indicating the format is 2013-08-22T12:58:10.000-07:00. If the time of a seminar session overlaps with another seminar session, it results in an error in the response indicating a conflict. |
date-end |
Date |
Yes |
Session’s end date. A sample indicating the format is 2013-08-22T12:58:10.000-07:00. If the time of a seminar session overlaps with another seminar session, it results in an error in the response indicating a conflict. |
field-id=seminar-expected-load,value |
String |
No |
If this value is provided then the seminar load is set to this value. Otherwise the seminar is set as a normal meeting (<600 participants). |
Response values
Element |
Attribute |
Type |
Description |
|---|---|---|---|
sco |
NA |
NA |
Information about the new session sco. |
Sample request
Below is a seminar session creation flow using a combination of sco-update and seminar-session-sco-update.
A sample call of sco-update API to get the sco-id is http://connect-domain-url/api/xml?action=sco-update&account-id=7&folder-id=11101&type=seminarsession&name=b1
note: The folder-id is seminar-id.
The sco-id, returned by the above API call, is passed as sco-id parameter to seminar-session-sco-update API to schedule a session. A sample call to achieve this is http://connect-domain-url/api/xml?action=seminar-session-sco-update&sco-id=11226&source-sco-id=11101&parent-acl-id=11101&name=fooooo1&date-begin=2013-08-22T15:58:10.000-07:00&date-end=2013-08-22T16:58:10.000-07:00&source-sco-id=11101Lastly, use acl-field-update API call to set the seminar-expected-load value. A sample request is http://connect-domain-url/api/xml?action=acl-field-update&acl-id=%3Cseminar-session-sco-id%3E&field-id=311&value=expected-load-in-integer
http://connect-domain-url/api/xml?action=sco-update&account-id=7&folder-id=11101&type=seminarsession&name=b1
http://connect-domain-url/api/xml?action=seminar-session-sco-update&sco-id=11226&source-sco-id=11101&parent-acl-id=11101&name=fooooo1&date-begin=2013-08-22T15:58:10.000-07:00&date-end=2013-08-22T16:58:10.000-07:00&source-sco-id=11101
acl-id is seminar session id or sco-id, created using sco-update API.
Sample response
Sample response of seminar-session-sco-update to create a session and of acl-field-update to set the seminar-expected-load value are the same and is as below.<results> <status code="ok"/> </results>
<results> <status code="ok"/> </results>
If the time of a seminar session overlaps with another seminar session, it results in an error in the response indicating a conflict.
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online