Availability

Acrobat Connect Pro 7

Description

Returns information about system quota thresholds that have been exceeded.

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 threshold varies depending on the quota. For more information about automatic notification, see Adobe Connect User Guide.

Request URL

 https://example.com/api/xml 
     ?action=quota-threshold-exceeded 
     &account-id=Integer 
     &acl-id=Integer 
     &quota-id=String 
     &num-of-days=Integer 
     &session=String

Parameters

Name

Type

Required

Description

account-id

BIGINT

N

The ID of the account. Specify either account-id or acl-id (not both). If you do not specify either account-id or acl-id, results are returned for the account which the current user is logged into.

If you specify account-ID, results are returned for all quota thresholds that have been reached in the account.

acl-id

BIGINT

N

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

BIGINT

N

The ID of the system quota for which you want information. For available values, see quota-ID.

num-of-days

Integer

N

Number of days from the current day for which records are retrieved. If you do not specify a value, all the previous records for the specified quotas are retrieved.

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 /> 
     <Records> 
            <Record acl-id="Integer" quota-id="String" peak-used="Integer" count="Integer" threshold-pct="Integer" sco-id="Integer"> 
             <record-date>Date</record-date> 
         </Record> 
        </Records> 
 </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).

Records

Container

Lists the records returned.

Record

Container

Lists information about the record returned.

acl-id

BIGINT

The ID of the ACL returned.

quota-id

String

The ID of the quota returned. For available values, see quota-ID.

peak-used

Integer

The peak value of quota used on the specified date. This attribute is null for training and group quotas.

count

Integer

Number of times the threshold was crossed for the quota on the specified date. This attribute is null for training and group quotas.

threshold-pct

Integer

Percentage threshold when the threshold was crossed.

sco-id

BIGINT

The ID of the meeting for which the threshold was crossed. This attribute is applicable only for the quota ID concurrent-users-per-meeting; for other quotas, it is null.

Record-date

Date

Date when the threshold was crossed (UTC), in MM/DD/YYYY format.

Sample request

 https://example.com/api/xml?action=quota-threshold-exceeded&acl-id=20013&quota-id=num-of-members-quota&num-of-days=30

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
 <status code="ok"/> 
     <Records> 
         <Record acl-id="20013" quota-id="num-of-members-quota" peak-used="" count="" threshold-pct="10" sco-id=""> 
             <record-date>11/20/2007</record-date> 
         </Record> 
     </Records> 
 </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