Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
Update a field-id for the specified acl-id passed via Web Services API. Change, guided hints settings, check unexpected gaps in recordings, and tune the webcam video quality.
Availability
Original API available since Breeze 5.
Updated in Adobe Connect 9.4 to add auto_show_guided_hint and auto-correct-time-stamp flags.
Updated in Adobe Connect 9.5 release to add meeting-video-auto-correction field.
Description
[Introduced in Macromedia Breeze 5] Updates the passed in field-id for the specified acl-id.
[Introduced in Adobe Connect 9.4] Using the API, a user can enable or disable the Guided Hints at meeting startup by setting the auto_show_guided_hint flag as True or False. It is an account wide setting.
[Introduced in Adobe Connect 9.4] Using this API, you can check the recordings for unexpected gaps in the FLV files. If the flag is set as True, Adobe Connect checks the recordings. Both, the new and the existing recordings uploaded to the Content Library are checked.
[Introduced in Adobe Connect 9.5] Using meeting-video-auto-correction field, the meeting add-in automatically tunes the quality of the camera video. For automatic tuning Adobe Connect considers the available bandwidth. This setting is applicable to an account.
Note:
To update a standard field for a principal (a user or a group), use the principal-update action. To update a custom field for a principal, use the acl-field-update action.
Each SCO or account belongs to at least one access control list (ACL). The ACL lists the principals that have permission to access the SCO or account.
Call acl-field-info to determine the fields in the ACL for a SCO or account. The response contains the field-id you need for the request to acl-field-update:
<?xml version="1.0" encoding="utf-8" ?>
<results><status code="ok"/></results>
You can specify multiple trios of acl-id, field-id, and value. If you do, use an HTTP POST method, rather than a GET, to make the request. The GET method has limitations that might cause the request to be truncated. With a POST, you can add about 50 trios to the request.
To call acl-field-update, you need modify permission on the SCO or account.
Parameters
|
|
Type |
Required |
Description |
|
acl-id |
BIGINT |
Y |
sco-id of the seminar. |
|
field-id |
String |
Y |
Field to be updated:
|
|
value |
String |
Y |
The new value to be updated:
|
Filters
Results cannot be filtered or sorted.
Request URL sample1
http://example.com/api/xml ?action=acl-field-update &acl-id=integer &field-id=string &value=string &session=BreezeSessionCookieValue
Request URL sample2
https://example.com/api/xml
?action=acl-field-update
&acl-id=integer
&field-id=auto_show_guided_hint
&value=Boolean
Request URL sample3
https://example.com/api/xml
?action=acl-field-update
&acl-id=integer
&field-id=auto-correct-time-stamp
&value=Boolean
Request URL sample4
https://example.com/api/xml
?action=acl-field-update
&acl-id=integer
&field-id=meeting-video-auto-correction
&value=Boolean
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> </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). |
Sample request1
https://example.com/api/xml?action=acl-field-update&acl-id=2007035246 &field-id=name&value=Java 101
Sample request2
http://example.com/api/xml?action=acl-field-update&acl-id=7&field-id=auto_show_guided_hint&value=false
Sample request3
http://example.com/api/xml?action=acl-field-update&acl-id=7&field-id=auto_show_guided_hint&value=false
Sample request4
https://example.com/api/xml?action=acl-field-update&acl-id=7&field-id=meeting-video-auto-correction&value=false
Sample response1
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>
Sample response2
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
Sample response3
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
Sample response4
<?xml version="1.0" encoding="utf-8" ?>
<results>
<status code="ok" />
</results>
See also
