Using Our APIs
Information Requests
Query Usage Levels
7 min
purpose returns the current usage monitoring levels assigned to the sim specified in the \<iccid> element these values represent the sim level warning threshold cut off (limit) threshold the meaning of these values depends on the sim type endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<query usage levels version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \</query usage levels> response (success) \<query usage levels response api id="123456"> \<api outcome>success\</api outcome> \<warning>100\</warning> \<limit>500\</limit> \</query usage levels response> response elements element description \<warning> decimal value representing the warning threshold \<limit> decimal value representing the cut off threshold interpretation by sim type the values returned must be interpreted according to the sim type manx telecom sims sim types 1 net, multinet voda, multinet m2m, smart o2 voda values represent a monetary threshold in £ nominal balance the warning or limit is triggered when the nominal balance reaches the specified amount example if \<warning>10\</warning> is returned, the warning level is triggered when the nominal balance reaches £10 00 all other supported sim types sim types include multinet kpn c, multinet kpn o, multinet kpn lbs, ee, o2 uk, multinet rog c, 3 global, verizon, verizon m1, tele2 and all caburn sims values represent a threshold in megabytes (mb) the warning or cut off level is triggered when data usage reaches the specified amount example if \<limit>1 5\</limit> is returned, the sim will be cut off when data usage reaches 1 5mb behaviour notes these levels may be inherited from the default group settings or may have been individually configured via sim action if a sim reaches its cut off level, it will not be able to generate further chargeable traffic until the limit is increased or the sim is moved to another group response (failure) if a request cannot be processed, the response will include api outcome indicating failure an error description explaining the reason failure responses may occur due to invalid authentication credentials invalid or unknown identifiers (for example iccid or msisdn) invalid or missing parameters values not permitted for the specified sim type or account configuration insufficient permissions integrating systems should validate input data before submission and implement appropriate error handling and logging