Using Our APIs
Commands
Cancel Location
6 min
purpose requests a network cancel location for the specified sim this operation can be useful if a mobile device is not reporting or appears unreachable however, please read the information and warning below carefully before using this command when a mobile device registers on a network, its location information is stored in multiple network elements (such as the hlr, vlr, msc, and sgsn) as the device moves between cells or networks, this information is updated so that inbound calls and sms can be correctly routed in rare cases, this location information may become corrupted or not cleared correctly issuing a cancel location request instructs the network elements to delete any stored location information relating to the sim in theory, this forces the device to issue a location update the next time it attempts to interact with the network, refreshing its registration details important behaviour notes many devices will not issue a location update unless they are power cycled power cycling a device will often trigger a location update even without a cancel location request it is strongly recommended that devices periodically power cycle can be power cycled remotely (for example, via sms) warning if a device does not respond to a cancel location request with a location update and does not periodically power cycle, issuing this command may result in the device being permanently excluded from network services until manual intervention is possible following a cancel location request, the network may be unable to locate the device to deliver sms messages as a result, you cannot rely on sms to remotely power cycle the device after issuing this command it is strongly recommended that you test the cancel location behaviour using a convenient test unit before applying this operation to live devices in the field do not expect an instant result the effects of a cancel location request may not be seen until the device next power cycles operational impact api commands perform live configuration changes changes take effect immediately commands may affect sim status, service availability, charging, or usage limits requests cannot be undone automatically ensure all parameters are validated before submitting requests to the production environment endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<cancel location version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \</cancel location> response (success) \<cancel location response api id="123456"> \<api outcome>success\</api outcome> \</cancel location response> 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