Query Usage Levels
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.