Query QR Info

7 min

purpose returns the qr code data and lifecycle status associated with the sim specified in the \<iccid> element some virtual sims are deployed to devices using a qr code this query provides the qr code payload string required to generate the qr code the current qr lifecycle status if a sim does not have a qr code associated with it, the response will return invalid iccid endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<query qr info version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \</query qr info> response (success) \<query qr info response api id="123456"> \<api outcome>success\</api outcome> \<qr code>lpa 1$url to provider$xxxxxxxx xxxx xxxx xxxx xxxxxxxxxxxx\</qr code> \<qr status>0\</qr status> \</query qr info response> response elements element description \<qr code> string containing the data required to generate the qr code used to deploy the sim \<qr status> integer representing the current lifecycle status of the qr code qr status values value meaning 0 unassigned 1 provided to customer 2 reserved 3 installed on device 4 deleted from device behaviour notes the \<qr code> value is not itself a qr image it is the data string required to generate the qr code for device deployment the \<qr status> allows applications to track the lifecycle of a virtual sim if the specified sim does not have qr provisioning enabled, the request will return invalid iccid 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