Availability

Acrobat Connect Pro 7

Description

Updates the threshold settings of the specified quotas.

Each Adobe Connect account has system quotas that determine, for example, how many seats are available for meeting hosts, trainers, training managers, and so on. Each quota has a threshold; when the threshold is crossed, the system notifies administrators that the quota is in danger of being reached. The settings for the thresholds and notifications vary depending on the quota, and you can configure the settings using this action.

Request URL

 https://example.com/api/xml 
     ?action=quota-threshold-update 
     &account-id=integer 
     &acl-id=integer 
     &quota-id=string 
     &threshold-pct=integer 
     &login-notif=Boolean 
     &email-notif=Boolean 
     &monthly-emails=Boolean

Parameters

Name

Type

Required

Description

account-id

BIGINT

N

The ID of the account for which quota settings are updated.

acl-id

BIGINT

Y

The ID of the SCO, account, or principal for which you want threshold information. Can be a valid sco-id, account-id, or principal-id. If you do not specify a value for acl-id, the value for account-id is used.

The value to use for acl-id depends on the quota ID used; for more information, see quota-ID.

quota-id

String

Y

The ID of the quota whose settings are updated. For available values, see quota-ID.

threshold-pct

Integer

Y

The percent threshold for the quota. The lower the value, the more frequently administrators are notified when the threshold is exceeded (if notifications are enabled).

login-notif

Boolean

Y

Specifies whether to notify administrators upon logging in that a threshold is exceeded (true) or not (false).

email-notif

Boolean

Y

Specifies whether to notify administrators through e-mail that a threshold is exceeded (true) or not (false).

monthly-emails

Boolean

Y

Specifies whether to send administrators monthly threshold reports through e-mail (true) or not (false).

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

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 request

 https://example.com/api/xml?action=quota-threshold-update&account-id=7&acl-id=7&quota-id=training-user&threshold-pct=90&login-notif=false&email-notif=true&monthly-emails=true

Sample response

 <?xml version="1.0" encoding="utf-8" ?> 
 <results> 
     <status code="ok" /> 
 </results>

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy