queryeSim

The article includes:

There are multiple ways to view the features and options on a SIM. All include the same basic information as queryDevice with additional fields. Refer to the table below for additional information.

Note: You must update your WSDL reference before you use this call.

Call Results information
queryeSim EID used to query and returns all fields from queryDevice.
queryDevice Provides detailed information for a SIM such as device status, features, history, plans, thresholds, cost center, and other attributes.

Note: If you use this query for devices with multiple IP addresses it will only return the lowest IP address in the StaticIP field.
queryDevice2 EID and all fields from queryDevice.
queryDeviceDetailsExt IP values (APN features) and all fields from queryDevice.

Use for devices with multiple IP addresses.
queryDeviceDetailsExt2 EID and all fields from queryDeviceDetailsExt.

 

URLs

Request URL (production) https://prismproapi.koretelematics.com/4/TransactionalAPI.svc/json/QueryESIM
Request URL (sandbox) https://prismproapi.sandbox.koretelematics.com/4/TransactionalAPI.svc/json/QueryESIM
Request method Post

 

Request

Field Data type Mandatory Min length Max length Description
eID string Y   50 EID number.

 

JSON request example

{
"eID": "89001039240040102300000000294669"
}

 

Response

Parameter name Data type Min length Max length Description
requestStatus int     Request status code.
MSISDNOrMDN string 10 50 MSISDN or MDN.
IMSIOrMIN string   50 IMSI or MIN.
status string   50 Current SIM state.
currentDataPlan string 10 120 Current data plan.
currentSMSPlan string 10 120 Current SMS plan.
futureDataPlan string 10 120 Future data plan.
futureSMSPlan string 10 120 Future SMS plan.
dailyDataThreshold int     Daily data threshold.
dailySMSThreshold int     Daily SMS threshold.
monthlyDataThreshold int     Monthly data threshold.
monthlySMSThreshold int     Monthly SMS threshold.
customField1 string   64 Custom 1 field.
customField2 string   64 Custom 2 field.
customField3 string   64 Custom 3 field.
customField5 string   64 Custom 4 field.
customField5 string   64 Custom 5 field.
customField6 string   64 Custom 6 field.
lstHistoryOverLastYear List[string]     History of SIM including activation date and feature names.
lstFeatures List[string] 10 10 each Feature number: feature name.
staticIP string   45 Static IP.
voiceDispatchNumber string   20  
mostRecentLocateId int      
previousLocateId int      
mostRecentLocateDate Datetimeoffset (0)      
mostRecentLongitude float      
mostRecentAddress float      
previousLocateDate string      
previousLatitude Datetimeoffset (0)      
previousLongitude float      
previousAddress float      
lstExtFeaturesWithIP List[string]     Feature: feature name, value: IP address.
CostCenter string   64 Cost center name.
SimSumber string   50 SIM number.

 

JSON request example

{
    "d": [
        {
            "__type": "EIDDeviceInformation:https://PRiSMProAPI.koretelematics.com/types",
            "requestStatus": 0,
            "MSISDNOrMDN": "1234567891234",
            "IMSIOrMIN": "123456789123456",
            "status": "Active",
            "currentDataPlan": "PLAN000001: Plan Name1",
            "currentSMSPlan": "PLAN000002:  Plan Name2",
            "futureDataPlan": "PLAN000001:  Plan Name1",
            "futureSMSPlan": "PLAN000002:  Plan Name2",
            "dailyDataThreshold": 205,
            "dailySMSThreshold": 1,
            "monthlyDataThreshold": 1229,
            "monthlySMSThreshold": 1,
            "customField1": "",
            "customField2": "",
            "customField3": "",
            "customField4": "",
            "customField5": "",
            "customField6": "camera system",
            "lstHistoryOverLastYear": [
                "06/16/2020 03:46 | Activation (FEAT000001: Feature Name1, FEAT000002: Feature Name2, FEAT000003: Feature Name3, FEAT000004: Feature Name4, FEAT000005: FEATURE NAME5)"
            ],
            "lstFeatures": [
                "FEAT000001: Feature Name1",
                "FEAT000002: Feature Name2",
                "FEAT000003: Feature Name3",
                "FEAT000004: Feature Name4",
                "FEAT000005: FEATURE NAME5"
            ],
            "staticIP": null,
            "voiceDispatchNumber": "",
            "mostRecentLocateId": null,
            "previousLocateId": null,
            "mostRecentLocateDate": null,
            "mostRecentLatitude": null,
            "mostRecentLongitude": null,
            "mostRecentAddress": null,
            "previousLocateDate": null,
            "previousLatitude": null,
            "previousLongitude": null,
            "previousAddress": null,
            "lstExtFeatures": [],
            "costCenter": null,
            "SimNumber": "1234567891234567891"
        }
    ]
}

Related articles