Skip to main content

Get Device & SIM Details

GET https://link.monoz.io/api/v1/{ORG-ID}/Device/Sim/Detail/{ICCID}

Returns the device & sim details & data consumed by the sim for last 30 days from current date.

Args​
ORG-ID
The unique ID assigned to your organisation
ICCID
Unique ICCID of target device

Response​
200
Ok Success
Response Body​

Name   string

Device name as registered in monoZ:Link

ICCID   string

Unique device ID as registered in monoZ:Link

IMEILock   boolean

Flag that indicates if SIM is locked to the current device IMEI.

ActivationDate   timestamp

The date when the SIM card was activated

ExpiryDate   timestamp

The date when the SIM card shall be expired

Status   integer

Status of the SIM/Device. A SIM can be enabled (active) or disabled (deactivated)

MessageCount   integer

Total number of succesful uplink messages from the device

DLMessageCount   integer

Total number of Downlink messages from monoZ:Link to device

Volume   integer

The remaining data volume of the SIM/device

CreatedDate   timestamp

Date of regisration of device in monoZ:Link

UpdatedDate   timestamp

Date of last update of the device in monoZ:Link

400
Invalid If the input value is not correct format
401
Unauthorized If the API Key is wrong or there is no permission to access the requested data.
404
Not Found If the specified ICCID was not found in the system.
500
Server Error As described in Message field.
cURL​
    curl --location 'https://link.monoz.io/api/v1/mti/Device/Sim/Detail/1234567890\
    --header X-API-Key: abcdefgh123456
Response​
{
    "Error": false,
    "Message": "FetchSuccess",
    "StatusCode": 200,
    "Data": {
        "Name": "Device name as registeres in monoZ:Link",
        "ICCID": "Unique device ID as registered in monoZ:Link",
        "IMEILock": "Flag that indicates if SIM is locked to the current device IMEI.",
        "ActivationDate": "The date when the SIM card was activated",
        "ExpiryDate": "The date when the SIM card shall be expired",
        "Status": "Status of the SIM/Device. A SIM can be enabled (active) or disabled (deactivated)",
        "MessageCount": "Total number of succesful uplink messages from the device",
        "DLMessageCount": "Total number of Downlink messages from monoZ:Link to device",
        "Volume": "The remaining data volume of the SIM/device"
        "CreatedDate": "Date of regisration of device in monoZ:Link",
        "UpdatedDate": "Date of last update of the device in monoZ:Link"
    }
}