GET api/CommsInterfaces?gatewayID={gatewayID}

Gets a Comms Interface by the input Gateway ID

Request Information

URI Parameters

Name	Description	Type	Additional information
gatewayID	Integer ID for a Gateway	integer	Required

Body Parameters

None.

Response Information

Resource Description

Single

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": "2025-11-09T21:25:11.6019059+10:00",
    "BuildDateUTC": "2025-11-09T21:25:11.6019059+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}