GET api/Admin/ClientReport

Returns a Client Report

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Returns a view

ClientReportResponse
NameDescriptionTypeAdditional information
ClientReport

Client Report

ClientReport

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:
{
  "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:04.9673353+10:00",
    "BuildDateUTC": "2026-01-09T23:52:04.9673353+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "ClientReport": {
    "TotalClients": 1,
    "ClientInformation": [
      {
        "ID": 1,
        "Name": "sample string 2",
        "ParentClientID": 3,
        "ParentClientName": "sample string 4",
        "Active": true,
        "BillingName": "sample string 6",
        "BillingAddress": "sample string 7",
        "BillingStreet": "sample string 8",
        "BillingCity": "sample string 9",
        "BillingStateTerritory": "sample string 10",
        "BillingAreaCode": "sample string 11",
        "BillingCountry": "sample string 12",
        "ContactName": "sample string 13",
        "ContactEmail": "sample string 14",
        "ContactPhone": "sample string 15",
        "TotalNetworkCount": 16,
        "TotalDataNodeCount": 17,
        "TotalConnectedDeviceCount": 18,
        "TotalCalculatedDeviceCount": 19,
        "TotalUsers": 20,
        "NetworkInformation": [
          {
            "ID": 1,
            "Name": "sample string 2",
            "CommsInterface": {
              "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
              }
            },
            "DataNodeCount": 3,
            "ConnectedDeviceCount": 4,
            "CalculatedDeviceCount": 5
          },
          {
            "ID": 1,
            "Name": "sample string 2",
            "CommsInterface": {
              "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
              }
            },
            "DataNodeCount": 3,
            "ConnectedDeviceCount": 4,
            "CalculatedDeviceCount": 5
          }
        ]
      },
      {
        "ID": 1,
        "Name": "sample string 2",
        "ParentClientID": 3,
        "ParentClientName": "sample string 4",
        "Active": true,
        "BillingName": "sample string 6",
        "BillingAddress": "sample string 7",
        "BillingStreet": "sample string 8",
        "BillingCity": "sample string 9",
        "BillingStateTerritory": "sample string 10",
        "BillingAreaCode": "sample string 11",
        "BillingCountry": "sample string 12",
        "ContactName": "sample string 13",
        "ContactEmail": "sample string 14",
        "ContactPhone": "sample string 15",
        "TotalNetworkCount": 16,
        "TotalDataNodeCount": 17,
        "TotalConnectedDeviceCount": 18,
        "TotalCalculatedDeviceCount": 19,
        "TotalUsers": 20,
        "NetworkInformation": [
          {
            "ID": 1,
            "Name": "sample string 2",
            "CommsInterface": {
              "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
              }
            },
            "DataNodeCount": 3,
            "ConnectedDeviceCount": 4,
            "CalculatedDeviceCount": 5
          },
          {
            "ID": 1,
            "Name": "sample string 2",
            "CommsInterface": {
              "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
              }
            },
            "DataNodeCount": 3,
            "ConnectedDeviceCount": 4,
            "CalculatedDeviceCount": 5
          }
        ]
      }
    ]
  }
}