Parameters are passed to the API in the URL string and are to be URL encoded, parameters marked with a lit bulb
(  ) are required and parameters denoted with an unlit
bulb ( ) are not and will have a default value if
not supplied.
| |
Name |
Type |
Allowed Values |
Default |
Entries marked with a lit bulb ( ) are always
returned and entries marked with an unlit bulb ( ) are
not and will not be included in the API response packet if they have no value. Types marked with square
brackets are arrays, and any custom types are displayed at the bottom of this page (clicking on
the name of that type will take you to the definition).
01 <?xml version="1.0" encoding="utf-8" ?>
02 <!--
03 Please note this example does not contain every day of the month,
04 however in an actual response day-count will equal the amount of
05 days in the specified month and year and the amount of 'day'
06 entries will equal day-count (with 0 usage for those days that
07 have not yet got usage).
08 -->
09 <api-response>
10 <response-begin />
11 <method>ACCESS_GetAccountUsage</method>
12 <usage>
13 <day-count>3</day-count>
14 <days>
15 <day>
16 <received>1274063291</received>
17 <sent>32305276</sent>
18 <total>1306368567</total>
19 </day>
20 <day>
21 <received>292936059</received>
22 <sent>22721833</sent>
23 <total>315657892</total>
24 </day>
25 <day>
26 <received>0</received>
27 <sent>0</sent>
28 <total>0</total>
29 </day>
30 </days>
31 <total-received>1566999350</total-received>
32 <total-sent>55027109</total-sent>
33 <total>1622026459</total>
34 </usage>
35 <summary>
36 <dplus-used>365079468</dplus-used>
37 <anytime-used>8271055233</anytime-used>
38 <freezone-used>233261</freezone-used>
39 <topup-used>0</topup-used>
40 <prepaid-used>0</prepaid-used>
41 <offpeak-used>0</offpeak-used>
42 <total-used>8636368382</total-used>
43 <dplus-remaining>53322011732</dplus-remaining>
44 <anytime-remaining>45416035967</anytime-remaining>
45 <topup-remaining>0</topup-remaining>
46 <prepaid-remaining>0</prepaid-remaining>
47 <offpeak-remaining>0</offpeak-remaining>
48 <dplus-cap>53687091200</dplus-cap>
49 <anytime-cap>53687091200</anytime-cap>
50 <topup-cap>0</topup-cap>
51 <prepaid-cap>0</prepaid-cap>
52 <offpeak-cap>0</offpeak-cap>
53 <bus-uncapped-threshold-usage>0</bus-uncapped-threshold-usage>
54 <bus-uncapped-threshold-limit>0</bus-uncapped-threshold-limit>
55 <home-uncapped-anytime>0</home-uncapped-anytime>
56 <home-uncapped-offpeak>0</home-uncapped-offpeak>
57 <home-uncapped-dplus>0</home-uncapped-dplus>
58 <bandwidth-quality>5</bandwidth-quality>
59 </summary>
60 <error-count>0</error-count>
61 <response-end />
62 </api-response>
|