NetworkInterface
NetworkInterface contains specific information related to external network interfaces for devices where Remote Manager needs to have knowledge of that information in order to interact with those devices. For example, Remote Manager uses NetworkInterface records to associate phone numbers with one or more mobile identification numbers (SIM or modem serial number, depending upon the mobile technology).
URI
http://<hostname>/ws/NetworkInterface
Formats
| HTTP Method | Format | Description |
|---|---|---|
| GET | /ws/NetworkInterface | Display a list of modems provisioned in your account. |
| POST | /ws/NetworkInterface | Add a modem to your account. |
| PUT | /ws/NetworkInterface | Update modem information for your account. |
| DELETE | /ws/NetworkInterface | Delete a modem from your account. |
Elements
id
Element that uniquely identifies the network interface and consists of the following:
niId
System-generated identifier for the network interface.
niVersion
A value of 0 indicates the most recent version of the network interface record.
niPhoneCarrier
An integer that represents the telephone carrier service subscription for the network interface. The value is specific to the internal implementation of the SMS service used to send and receive SMS messages.
niTerminated
Boolean value that indicates whether the network interface is terminated. Enter either true or false.
niEffectiveStartDate
Date the network interface was added to Remote Manager.
cstId
Remote Manager identifier for the customer.
grpId
Remote Manager identifier for the customer group.
devId
Device ID of the device associated with this network interface record.
devVersion
A value of 0 which indicates the most recent version of the device record.
niInterfaceType
Integer that indicates the network interface type:
0: None
1: GSM
2: CDMA
3: ORBCOMM
4: Iridium
niSimId
Network interface SIM indentifier which is the ICCID, MEID, or ESN of the SIM or cellular modem.
niModemId
Modem ID of the satellite modem.
niPhone
Telephone number of the cellular line using international format for telephone numbers. For example:
+1 123-456-7890
niActivePhone
Boolean value that indicates whether this network interface record contains the telephone number (niPhone) to which Remote Manager sends SMS messages for this device. Only one NetworkInterface record can have niActivePhone set to true per device.
niIdigiPhone
Short or long code the device uses to communicate with Remote Manager.
niIdigiServiceId
Keyword used in the shared code
niImsi
International Mobile Subscriber Identity (IMSI) of the SIM.