Availability

Breeze 4

Description

Returns information about the quotas that apply to your Adobe Connect license or Adobe Connect hosted account. Adobe Connect enforces various quotas, for example, the number of concurrent users in training, the number of downloads, the number of authors, and so on.

Although your server license determines certain quotas, you can scale your license beyond your limit. In the response from report-quotas, the soft-limit is the number defined by your license. The soft-limit is the same as the limit, unless you purchase a Burst Pack for meetings, which allows additional participants to join past the limit, on an overage basis.

Request URL

 http://server_name/api/xml 
     ?action=report-quotas 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

session

String

N

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

Filters

Results cannot be filtered or sorted.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results>  
     <status code=allowedValue />  
     <report-quotas>  
         <quota acl-id=integer quota-id=string used=integer  
                 limit=allowedValue soft-limit=integer>  
             <date-begin>datetime</date-begin>  
             <date-end>datetime</date-end>  
         </quota> 
     </report-quotas> 
 </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).

report-quotas

Container

Information about all of the quotas set for the account.

quota

Container

Information about one quota.

acl-id

BIGINT

The ID of the account on which the quota is defined.

quota-id

Allowed value

The name of the quota defined by the server, ending in -quota.

used

Integer

The number of uses that count toward this quota.

limit

Integer

The limit at which the server does not allow access. Has the same value as soft-limit, unless you have purchased a Burst Pack to allow for overage. The value is either an integer or unlimited.

soft-limit

Integer

The limit determined by your server license.

date-begin

Datetime

The date and time the quota was effective on the server.

date-end

Datetime

The date the quota expires.

Sample request

 https://example.com/api/xml?action=report-quotas

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <report-quotas> 
         <quota acl-id="624520" quota-id="download-quota"  
                 used="1" limit="unlimited" soft-limit="1000000000"> 
             <date-begin>2004-03-09T09:45:41.047-08:00</date-begin>  
             <date-end>3000-01-01T00:00:00.000-08:00</date-end>  
         </quota> 
         <quota acl-id="624520" quota-id="bandwidth-quota" used="12802" 
                 limit="unlimited" soft-limit="1000000000"> 
             <date-begin>2006-05-31T17:00:00.943-07:00</date-begin>  
             <date-end>2006-06-30T17:00:00.943-07:00</date-end>  
         </quota> 
         ... 
     </report-quotas> 
 </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