GET api/UserAccess?username={username}&ownerID={ownerID}&ownerType={ownerType}

Returns a User Access setting for a specific object for the specified user

Request Information

URI Parameters

Name	Description	Type	Additional information
username	The username to retrieve the setting for	string	Required
ownerID		integer	Required
ownerType		OwnerType	Required

Body Parameters

None.

Response Information

Resource Description

The user access setting

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