cPanel XMLAPI - resellerstats


DESCRIPTION

This function shows account statistics for a specific reseller's accounts.


VARIABLES

INPUT

reseller
Name of the reseller to see account information for.

OUTPUT

resellerstats
Reseller statistics conatiner.

result
Results container.

accts
Account information container.

bandwidthlimit
Account bandwidth limit.

bandwidthused
Bandwidth used by the account this month.

deleted
Whetehr or not the account has been deleted. (1 = Yes, 0 = No)

diskquota
Account disk space limit.

diskused
Disk space used by the account.

domain
Main domain name associated with the account.

package
Package used by the account.

user
Username associated with the account.

diskused
Total disk space used by the reseller.

reseller
Nane of the reseller.

status (boolean)
Whether or not the operation succeeded. Yes=1, No=0.

statusmsg (string)
Any message related to the result of the operation. Format statusmsg=``message''

totalbwalloc
Total bandwidth allocated to the reseller.

totalbwused
Total bandwidth used by the reseller this month.

totaldiskalloc
Total disk space allocated to the reseller.


EXAMPLES

Calling this URL in WebHost Manager: https://cpaneldev.net:2087/xml-api/resellerstats?reseller=bob

will produce XML similar to:

<resellerstats>

        <result>
        <accts>
        
        <bandwidthlimit>0.00</bandwidthlimit>
        
        <bandwidthused>0.00</bandwidthused>
        
        <deleted>1</deleted>
        
        <diskquota>0.00</diskquota>
        
        <diskused>0.00</diskused>
        
        <domain>somedomain.tld</domain>
        
        <package>deleted account</package>
        
        <user>user</user>
        
        </accts>
        
                <accts>
                
        <bandwidthlimit>1000.00</bandwidthlimit>
        
        <bandwidthused>256.31</bandwidthused>
        
        <deleted>0</deleted>
        
        <diskquota>1000.00</diskquota>
        
        <diskused>500.21</diskused>
        
        <domain>otherdomain.tld</domain>
        
        <package>gold</package>
        
        <user>somed</user>
        
        </accts>
        
        <diskused>516.6</diskused>
        
        <reseller>bob</reseller>
        
        <status>1</status>
        
        <statusmsg>Fetched Reseller Data OK</statusmsg>
        
        <totalbwalloc>3200</totalbwalloc>
        
        <totalbwused>1007.07</totalbwused>
        
        <totaldiskalloc>1800</totaldiskalloc>
        
        </result>
        
        </resellerstats>


COPYRIGHT

Copyright 2007 cPanel Inc.