POST api/CommsInterfaces

Create a Comms Interface

Request Information

URI Parameters

None.

Body Parameters

The Comms Interface to be created

Name	Description	Type	Additional information
SIMID	Integer ID of a SIM to attach to this Comms Interface	integer	None.
Make	Make	Make	None.
Model	Model	string	None.
UID	Unique Identifier	string	None.
UIDType	Type of unique identifier	UIDType	None.
CommsType	Communications type for this interface	CommsType	None.
Address	WAN or IP Address	string	None.
Firmware1	Firmware field 1	string	None.
Firmware2	Firmware field 2	string	None.
Notes	Notes for the Comms Interface	string	None.
GatewayID	Integer ID of the Gateway this Comms Interface is attached to, if applicable	integer	None.
Ping	Whether or not to perform a ping to the Comms Interface before connecting to it	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "SIMID": 1,
  "Make": 0,
  "Model": "sample string 3",
  "UID": "sample string 4",
  "UIDType": 0,
  "CommsType": 0,
  "Address": "sample string 5",
  "Firmware1": "sample string 6",
  "Firmware2": "sample string 7",
  "Notes": "sample string 8",
  "GatewayID": 1,
  "Ping": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Add_CommsInterface'.

Response Information

Resource Description

Returns the created Comms Interface and messages

GetCommsInterfaceResponse

Name	Description	Type	Additional information
CommsInterfaces	Array of Comms Interfaces	Collection of CommsInterfaceStruct	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "CommsInterfaces": [
    {
      "ID": 1,
      "Make": 0,
      "Model": "sample string 2",
      "UID": "sample string 3",
      "UIDType": 0,
      "CommsType": 0,
      "Address": "sample string 4",
      "Firmware1": "sample string 5",
      "Firmware2": "sample string 6",
      "Notes": "sample string 7",
      "GatewayID": 1,
      "GatewayName": "sample string 8",
      "Ping": true,
      "SIMCard": {
        "ID": 1,
        "SerialNumber": "sample string 2",
        "PhoneNumber": "sample string 3",
        "Plan": "sample string 4",
        "State": 0,
        "CommsInterfaceID": 1
      }
    },
    {
      "ID": 1,
      "Make": 0,
      "Model": "sample string 2",
      "UID": "sample string 3",
      "UIDType": 0,
      "CommsType": 0,
      "Address": "sample string 4",
      "Firmware1": "sample string 5",
      "Firmware2": "sample string 6",
      "Notes": "sample string 7",
      "GatewayID": 1,
      "GatewayName": "sample string 8",
      "Ping": true,
      "SIMCard": {
        "ID": 1,
        "SerialNumber": "sample string 2",
        "PhoneNumber": "sample string 3",
        "Plan": "sample string 4",
        "State": 0,
        "CommsInterfaceID": 1
      }
    }
  ],
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2026-01-09T23:52:05.2659375+10:00",
    "BuildDateUTC": "2026-01-09T23:52:05.2659375+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}