queryDeviceDetailsExt2 – KORE Support

The article includes:

URLs
Request
Response

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.

Call	Results information
queryDeviceDetailsExt2	EID and all fields from queryDeviceDetailsExt.
queryDeviceDetailsExt	IP values (APN features) and all fields from queryDevice. Use for devices with multiple IP addresses.
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.
queryeSim	EID used to query and returns all fields from queryDevice.

URLs

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

Request

Field	Data type	Mandatory	Min length	Max length	Description
deviceNumber	string	Y	11	20	The SIM number or ICCID.

JSON request example

{
"deviceNumber": "12345678912345678912"
}

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.
EID	string		50	EID

JSON request example

{
"d": {
"__type": "DeviceInformation2:https://PRiSMProAPI.koretelematics.com/types",
"requestStatus": 0,
"MSISDNOrMDN": "1234567891",
"IMSIOrMIN": "123456789123456",
"status": "Active",
"currentDataPlan": "PLAN000001: Plan Name",
"currentSMSPlan": "NA",
"futureDataPlan": "PLAN000001: Plan Name",
"futureSMSPlan": "NA",
"dailyDataThreshold": 2048,
"dailySMSThreshold": 10,
"monthlyDataThreshold": 12288,
"monthlySMSThreshold": 100,
"customField1": "",
"customField2": "",
"customField3": "",
"customField4": "",
"customField5": "",
"customField6": "",
"lstHistoryOverLastYear": [
"08/04/2020 00:33 | Activation (FEAT000001: FeatureName1, FEAT000002: FeatureName2, FEAT000003: FeatureName3)"
],
"lstFeatures": [
"FEAT000001: FeatureName1",
"FEAT000002: FeatureName2",
"FEAT000003: FeatureName3"
],
"staticIP": "127.0.0.1",
"voiceDispatchNumber": "",
"mostRecentLocateId": null,
"previousLocateId": null,
"mostRecentLocateDate": null,
"mostRecentLatitude": null,
"mostRecentLongitude": null,
"mostRecentAddress": null,
"previousLocateDate": null,
"previousLatitude": null,
"previousLongitude": null,
"previousAddress": null,
"lstExtFeatures": [],
"LstFeaturesWithIp": [
{
"__type": "KeyValuePairOfstringstring:#System.Collections.Generic",
"key": "FEAT000001: FeatureName1",
"value": ""
},
{
"__type": "KeyValuePairOfstringstring:#System.Collections.Generic",
"key": "FEAT000002: FeatureName2",
"value": "127.0.0.1"
},
{
"__type": "KeyValuePairOfstringstring:#System.Collections.Generic",
"key": "FEAT000003: FeatureName3",
"value": ""
}
],
"costCenter": null,
"EID": null
}
}