POST api/Users

Create User

Request Information

URI Parameters

None.

Body Parameters

The user being created

Name	Description	Type	Additional information
Password	The password	string	None.
ClientID	ID of the Client this user belongs to	integer	None.
UserName	The username	string	None.
GivenName	The user's given name	string	None.
FamilyName	The user's family name	string	None.
Active	Whether or not the user is active. Only available to those with sufficient access privileges	boolean	None.
Email	The user's email address	string	None.
UserRole	The user's role (access level)	UserRole	None.
UserRoleDescription	The user's role string form.	string	None.
MobileNumber	The user's mobile phone number	string	None.
TimeZoneID	The user's set time zone.	string	None.
EnableAlertTimeframe	Whether or not this user has a set timeframe for receiving alerts	boolean	None.
AlertTimeframeStart	The start of the user's Alert Timeframe	time interval	None.
AlertTimeframeEnd	The end of the user's Alert Timeframe	time interval	None.
DefaultDashboard	The User's default dashboard, for the WebApp	integer	None.
DateFormat	Format string for displaying Date information	string	None.
TimeFormat	Format string for displaying Time information	string	None.
GraphTooltips	Whether or not to display tooltips on MultiGraphs	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "Password": "sample string 3",
  "ClientID": 4,
  "UserName": "sample string 5",
  "GivenName": "sample string 6",
  "FamilyName": "sample string 7",
  "Active": true,
  "Email": "sample string 8",
  "UserRole": 0,
  "UserRoleDescription": "Monitor",
  "MobileNumber": "sample string 9",
  "TimeZoneID": "sample string 10",
  "EnableAlertTimeframe": true,
  "AlertTimeframeStart": "00:00:00.1234567",
  "AlertTimeframeEnd": "00:00:00.1234567",
  "DefaultDashboard": 1,
  "DateFormat": "sample string 11",
  "TimeFormat": "sample string 12",
  "GraphTooltips": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A user response

GetUsersResponse

Name	Description	Type	Additional information
Users	Array of users	Collection of UserStruct	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:

{
  "Users": [
    {
      "ID": 1,
      "ClientID": 2,
      "ClientName": "sample string 3",
      "UserName": "sample string 4",
      "GivenName": "sample string 5",
      "FamilyName": "sample string 6",
      "Active": true,
      "Email": "sample string 7",
      "UserRole": 0,
      "UserRoleDescription": "Monitor",
      "MobileNumber": "sample string 8",
      "TimeZoneID": "sample string 9",
      "EnableAlertTimeframe": true,
      "AlertTimeframeStart": "00:00:00.1234567",
      "AlertTimeframeEnd": "00:00:00.1234567",
      "DefaultDashboard": 1,
      "DateFormat": "sample string 10",
      "TimeFormat": "sample string 11",
      "GraphTooltips": true
    },
    {
      "ID": 1,
      "ClientID": 2,
      "ClientName": "sample string 3",
      "UserName": "sample string 4",
      "GivenName": "sample string 5",
      "FamilyName": "sample string 6",
      "Active": true,
      "Email": "sample string 7",
      "UserRole": 0,
      "UserRoleDescription": "Monitor",
      "MobileNumber": "sample string 8",
      "TimeZoneID": "sample string 9",
      "EnableAlertTimeframe": true,
      "AlertTimeframeStart": "00:00:00.1234567",
      "AlertTimeframeEnd": "00:00:00.1234567",
      "DefaultDashboard": 1,
      "DateFormat": "sample string 10",
      "TimeFormat": "sample string 11",
      "GraphTooltips": true
    }
  ],
  "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-02-04T12:21:34.9628314+10:00",
    "BuildDateUTC": "2026-02-04T12:21:34.9628314+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}