Availability

Acrobat Connect Pro 7

Description

Provides the list of quotas for which capacity notifications are provided, along with their current threshold settings.

Each Adobe Connect account has system quotas that determine, for example, how many seats are available for Meeting Hosts, Learners, 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 threshold and the notifications vary depending on the quota.

Request URL

 https://example.com/api/xml 
     ?action=quota-threshold-info 
     &account-id=integer 
     &session=integer

Parameters

Name

Type

Required

Description

account-id

BIGINT

N

The ID of the account for which you want quota threshold information. If you don’t specify an ID, the current account to which the user is logged in is used.

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 /> 
     <Principals> 
         <Principal principal-id="integer" type="string"/> 
     </Principals> 
     <Quotas> 
         <Quota acl-id="integer" quota-id="string" threshold-pct="integer" login-notif="boolean" email-notif="boolean" monthly-emails="boolean" limit="integer" used="integer"/> 
         <Quota acl-id="integer" quota-id="string" threshold-pct="integer" login-notif="boolean" email-notif="boolean" monthly-emails="boolean" limit="intger" used="integer"/> 
     </Quotas> 
     <Trees> 
         <Tree tree-id="integer" type="string"/> 
     </Trees> 
 </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).

Principals

Container

Lists the principals specifying the groups for which system capacity notifications are provided.

Principal

Container

Information about the principal for which system capacity notification is provided.

principal-id

BIGINT

The principal ID specifying the group.

type

String

The group type. Depending on the license, this value can be one of the following:

  • authors

  • live-admins, which specifies that the group is Meeting Hosts

Quotas

Container

Lists the quotas.

Quota

Container

Information about the quota and its settings.

acl-id

BIGINT

ACL ID of the quota.

quota-id

BIGINT

The ID of the quota. For possible values, see quota-ID.

threshold-pct

Integer

The percent value of the threshold.

login-notif

Boolean

Whether administrators are notified upon logging in that a threshold is exceeded (true) or not (false).

email-notif

Boolean

Whether administrators are notified through e-mail that a threshold is exceeded (true) or not (false).

monthly-emails

Boolean

Whether administrators are sent monthly threshold reports through e-mail (true) or not (false).

limit

Integer

The limit of member seats.

used

Integer

Number of member seats used.

Trees

Container

Provides information about the tree type quotas (the quota for the number of concurrent users per meeting).

Tree

Container

Information about the tree.

tree-id

BIGINT

The tree ID.

type

String

The tree type, which is one of the following values:

  • meetings

  • user-meetings

Sample request

 https://example.com/api/xml?action=quota-threshold-info&account-id=7

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok"/> 
     <Principals> 
         <Principal principal-id="20013" type="authors"/> 
         <Principal principal-id="10051" type="live-admins"/> 
     </Principals> 
     <Quotas> 
         <Quota acl-id="7" quota-id="training-user" threshold-pct="90" login-notif="true" email-notif="true" monthly-emails="true" limit="10" used="0"/> 
         <Quota acl-id="20013" quota-id="num-of-members-quota" threshold-pct="10" login-notif="true" email-notif="true" monthly-emails="true" limit="10" used="3"/> 
     </Quotas> 
     <Trees/> 
 </results>

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