Query Device List

# Query Device List

Query the device list.

# POST

https://eim.simlessly.com/api/v1/open/esim/device/information (opens new window)

# Request Body Structure

Name Type MOC Description Example
eid String O eid eid and imei cannot be null simultaneously
imei String O IMEI eid and imei cannot be passed simultaneously

# Request Body Example

{
    "eid": "81049980000170000000002700000017",
    "imei": "273203576794093"
}

# Response Body Structure

Name Type MOC Description Example
deviceDetailResp OpenDeviceProfilesResp M Device details See below
deviceProfilesResp OpenDeviceDetailResp M Device profile details See below

# OpenDeviceProfilesResp

Name Type MOC Description Example
profileItemList List< ProfileItem> M Profile list See below

# ProfileItem

Name Type MOC Description Example
iccid String M ICCID 89148000007829999354
operator String M Operator China Mobile
status String M Status ENABLED
apn String M APN apn

# OpenDeviceDetailResp

Name Type MOC Description Example
id Long M id 1
eid String M eid 81049980000170000000002700000017
imei String M IMEI 273203576794093
deviceName String M Device name deviceName
organization String M Organization organization
groupName String M Group name groupName
deviceProfileStatus String M Device profile status ENABLE
profileNumber Integer O Profile number 1
debugEnable Integer O Debug enable 0
createTime DateTime O Create time 2021-07-01 00:00:00
activateDate DateTime O Activate date 2021-07-01 00:00:00
lastPullTime DateTime O Last pull time 2021-07-01 00:00:00
nextConnectTime DateTime O Next connect time 2021-07-01 00:00:00
country String O Country SG
deviceStatus String O Device status ONLINE
devicePullInterval Integer O Device pull interval 10

# Example of Response

{
    "deviceDetailResp": {
        "profileItemList": [
            {
                "iccid": "89148000007829999354",
                "operator": "China Mobile",
                "status": "ENABLED",
                "apn": "apn"
            }
        ]
    },
    "deviceProfilesResp": {
        "id": 1,
        "eid": "81049980000170000000002700000017",
        "imei": "273203576794093",
        "deviceName": "deviceName",
        "organization": "organization",
        "groupName": "groupName",
        "deviceProfileStatus": "ENABLE",
        "profileNumber": 1,
        "debugEnable": 0,
        "createTime": "2021-07-01 00:00:00",
        "activateDate": "2021-07-01 00:00:00",
        "lastPullTime": "2021-07-01 00:00:00",
        "nextConnectTime": "2021-07-01 00:00:00",
        "country": "SG",
        "deviceStatus": "ONLINE",
        "devicePullInterval": 10
    }
}