POST api/UserAccess

Creates User Access settings for a user

Request Information

URI Parameters

None.

Body Parameters

User Access Settings List

Name	Description	Type	Additional information
UserName	The name of the object	string	None.
AccessObject	The access objects	Add_UserAccess	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "UserName": "sample string 1",
  "AccessObject": {
    "ObjectID": 1,
    "ObjectType": 10,
    "AccessType": 0
  }
}

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_UserAccessList'.

Response Information

Resource Description

A get user access response containing the newly created settings

GetUserAccessResponse

Name	Description	Type	Additional information
UserAccessList	Array of User Access information	Collection of UserAccessList	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:

{
  "UserAccessList": [
    {
      "User": {
        "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
      },
      "AccessObjects": [
        {
          "ID": 1,
          "ObjectName": "sample string 2",
          "ObjectID": 3,
          "ObjectType": 10,
          "TypeDescription": "sample string 4",
          "AccessType": 0,
          "AccessTypeDescription": "sample string 5"
        },
        {
          "ID": 1,
          "ObjectName": "sample string 2",
          "ObjectID": 3,
          "ObjectType": 10,
          "TypeDescription": "sample string 4",
          "AccessType": 0,
          "AccessTypeDescription": "sample string 5"
        }
      ]
    },
    {
      "User": {
        "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
      },
      "AccessObjects": [
        {
          "ID": 1,
          "ObjectName": "sample string 2",
          "ObjectID": 3,
          "ObjectType": 10,
          "TypeDescription": "sample string 4",
          "AccessType": 0,
          "AccessTypeDescription": "sample string 5"
        },
        {
          "ID": 1,
          "ObjectName": "sample string 2",
          "ObjectID": 3,
          "ObjectType": 10,
          "TypeDescription": "sample string 4",
          "AccessType": 0,
          "AccessTypeDescription": "sample string 5"
        }
      ]
    }
  ],
  "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:44:37.1800782+10:00",
    "BuildDateUTC": "2026-01-09T23:44:37.1800782+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}