Return a JSON style result. The JSON format is:
{ /*OBJECT*/ | |||||||||||||||||||||||||||||||||||
"Result": NUMBER | 200 means OK, other error code meanings are similar to HTTP Response. | ||||||||||||||||||||||||||||||||||
"Status": "STRING" | Status message. Responsing result status of API executive, if there errors, it will describe reasons. | ||||||||||||||||||||||||||||||||||
"Data": { /*OBJECT*/ | |||||||||||||||||||||||||||||||||||
"3gppInfo": { /*OBJECT*/ | SIM info | ||||||||||||||||||||||||||||||||||
"Imei": "STRING" | The IMEI of the device | ||||||||||||||||||||||||||||||||||
"RegistrationState": INTEGER | A MMModem3gppRegistrationState value specifying the mobile registration status as defined in 3GPP
| ||||||||||||||||||||||||||||||||||
"OperatorName": "STRING" | Name of the operator to which the mobile is currently registered. | ||||||||||||||||||||||||||||||||||
"OperatorCode": INTEGER | Code of the operator to which the mobile is currently registered. | ||||||||||||||||||||||||||||||||||
"EnabledFacilityLocks": INTEGER | Bitmask of MMModem3gppFacility values for which PIN locking is enabled.
| ||||||||||||||||||||||||||||||||||
"ModemObj": /*OBJECT*/ | The path of the Modem object available in this device | ||||||||||||||||||||||||||||||||||
"ModemInfo": { /*OBJECT*/ | Modeminfo | ||||||||||||||||||||||||||||||||||
"Sim": "STRING" | The path of the SIM object available in this device | ||||||||||||||||||||||||||||||||||
"CurrentCapabilities": INTEGER | Bitmask of MMModemCapability values, specifying the generic family of access technologies the modem currently supports without a firmware reload or reinitialization.
| ||||||||||||||||||||||||||||||||||
"MaxBearers": INTEGER | The maximum number of defined packet data bearers the modem supports. | ||||||||||||||||||||||||||||||||||
"MaxActiveBearers": INTEGER | The maximum number of active MM_BEARER_TYPE_DEFAULT bearers that may be explicitly enabled by the user. | ||||||||||||||||||||||||||||||||||
"Manufacturer": "STRING" | The equipment manufacturer, as reported by the modem. | ||||||||||||||||||||||||||||||||||
"Model": "STRING" | The equipment model, as reported by the modem. | ||||||||||||||||||||||||||||||||||
"Revision": "STRING" | The revision identification of the software, as reported by the modem. | ||||||||||||||||||||||||||||||||||
"DeviceIdentifier": "STRING" | A best-effort device identifier based on various device information like model name, firmware revision, USB/PCI/PCMCIA IDs, and other properties. | ||||||||||||||||||||||||||||||||||
"Device": "STRING" | The physical modem device reference (ie, USB, PCI, PCMCIA device), which may be dependent upon the operating system. | ||||||||||||||||||||||||||||||||||
"Drivers": "STRING" | The Operating System device drivers handling communication with the modem hardware. | ||||||||||||||||||||||||||||||||||
"Plugin": "STRING" | The name of the plugin handling this modem. | ||||||||||||||||||||||||||||||||||
"PrimaryPort": "STRING" | The name of the primary port using to control the modem. | ||||||||||||||||||||||||||||||||||
"EquipmentIdentifier": "STRING" | The identity of the device.This will be the IMEI number for GSM devices and the hex-format ESN/MEID for CDMA devices. | ||||||||||||||||||||||||||||||||||
"UnlockRequired": "STRING" | Current lock state of the device, given as a MMModemLock value. | ||||||||||||||||||||||||||||||||||
"UnlockRetries": "STRING" | A dictionary in which the keys are MMModemLock flags, and the values are integers giving the number of PIN tries remaining before the code becomes blocked (requiring a PUK) or permanently blocked. Dictionary entries exist only for the codes for which the modem is able to report retry counts. | ||||||||||||||||||||||||||||||||||
"State": INTEGER | Overall state of the modem, given as a MMModemState value.
| ||||||||||||||||||||||||||||||||||
"StateFailedReason": "STRING" | Error specifying why the modem is in MM_MODEM_STATE_FAILED state, given as a MMModemStateFailedReason value. | ||||||||||||||||||||||||||||||||||
"AccessTechnologies": INTEGER | Bitmask of MMModemAccessTechnology values, specifying the current network access technologies used by the device to communicate with the network.
| ||||||||||||||||||||||||||||||||||
"SignalQuality": "STRING" | Signal quality in percent (0 - 100) of the dominant access technology the device is using to communicate with the network. Always 0 for POTS devices.The additional boolean value indicates if the quality value given was recently taken. | ||||||||||||||||||||||||||||||||||
"OwnNumbers": "STRING" | List of numbers being currently handled by this modem. | ||||||||||||||||||||||||||||||||||
"PowerState": "STRING" | A MMModemPowerState value specifying the current power state of the modem. | ||||||||||||||||||||||||||||||||||
"SupportedModes": "STRING" | This property exposes the supported mode combinations, given as an array of unsigned integer pairs.where:The first integer is a bitmask of MMModemMode values, specifying the allowed modes.The second integer is a single MMModemMode, which specifies the preferred access technology, among the ones defined in the allowed modes. | ||||||||||||||||||||||||||||||||||
"CurrentModes": "STRING" | A pair of MMModemMode values, where the first one is a bitmask specifying the access technologies (eg 2G/3G/4G) the device is currently allowed to use when connecting to a network, and the second one is the preferred mode of those specified as allowed. | ||||||||||||||||||||||||||||||||||
"SupportedBands": "STRING" | List of MMModemBand values, specifying the radio frequency and technology bands supported by the device. | ||||||||||||||||||||||||||||||||||
"CurrentBands": "STRING" | List of MMModemBand values, specifying the radio frequency and technology bands the device is currently using when connecting to a network. | ||||||||||||||||||||||||||||||||||
"SupportedIpFamilies": "STRING" | Bitmask of MMBearerIpFamily values, specifying the IP families supported by the device. | ||||||||||||||||||||||||||||||||||
} | |||||||||||||||||||||||||||||||||||
} | |||||||||||||||||||||||||||||||||||
} | |||||||||||||||||||||||||||||||||||
} |
KILOVIEW Device HTTP API, v1.0
Copyright (c) 2016, KILOVIEW Electronics.