GET api/UserAccess?username={username}

Returns a list of User Access settings for a specified user

Request Information

URI Parameters

Name	Description	Type	Additional information
username	The username of the user to retrieve settings for	string	Required

Body Parameters

None.

Response Information

Resource Description

A Get User Access Response containing the settings

GetUserAccessResponse

Name	Description	Type	Additional information
UserAccessList	Array of User Access information		None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "UserAccessList": [
    {
      "User": {
        "ID": 1,
        "ClientID": 2,
        "UserName": "sample string 3",
        "GivenName": "sample string 4",
        "FamilyName": "sample string 5",
        "Email": "sample string 6",
        "UserRole": 0,
        "UserRoleDescription": "sample string 7",
        "MobileNumber": "sample string 8",
        "TimeZoneID": "sample string 9",
        "EnableAlertTimeframe": true,
        "AlertTimeframeStart": "00:00:00.1234567",
        "AlertTimeframeEnd": "00:00:00.1234567",
        "DefaultDashboard": 13,
        "DateFormat": "sample string 14",
        "TimeFormat": "sample string 15",
        "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,
        "UserName": "sample string 3",
        "GivenName": "sample string 4",
        "FamilyName": "sample string 5",
        "Email": "sample string 6",
        "UserRole": 0,
        "UserRoleDescription": "sample string 7",
        "MobileNumber": "sample string 8",
        "TimeZoneID": "sample string 9",
        "EnableAlertTimeframe": true,
        "AlertTimeframeStart": "00:00:00.1234567",
        "AlertTimeframeEnd": "00:00:00.1234567",
        "DefaultDashboard": 13,
        "DateFormat": "sample string 14",
        "TimeFormat": "sample string 15",
        "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:42:35.3193848+10:00",
    "BuildDateUTC": "2025-11-09T21:42:35.3193848+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:

<GetUserAccessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:42:35.3193848+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:42:35.3193848+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <UserAccessList xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:APIStructs.UserAccessList>
      <d2p1:AccessObjects>
        <d2p1:APIStructs.UserAccess>
          <d2p1:AccessType>Nil</d2p1:AccessType>
          <d2p1:AccessTypeDescription>sample string 5</d2p1:AccessTypeDescription>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:ObjectID>3</d2p1:ObjectID>
          <d2p1:ObjectName>sample string 2</d2p1:ObjectName>
          <d2p1:ObjectType>Device</d2p1:ObjectType>
          <d2p1:TypeDescription>sample string 4</d2p1:TypeDescription>
        </d2p1:APIStructs.UserAccess>
        <d2p1:APIStructs.UserAccess>
          <d2p1:AccessType>Nil</d2p1:AccessType>
          <d2p1:AccessTypeDescription>sample string 5</d2p1:AccessTypeDescription>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:ObjectID>3</d2p1:ObjectID>
          <d2p1:ObjectName>sample string 2</d2p1:ObjectName>
          <d2p1:ObjectType>Device</d2p1:ObjectType>
          <d2p1:TypeDescription>sample string 4</d2p1:TypeDescription>
        </d2p1:APIStructs.UserAccess>
      </d2p1:AccessObjects>
      <d2p1:User>
        <d2p1:AlertTimeframeEnd>PT0.1234567S</d2p1:AlertTimeframeEnd>
        <d2p1:AlertTimeframeStart>PT0.1234567S</d2p1:AlertTimeframeStart>
        <d2p1:ClientID>2</d2p1:ClientID>
        <d2p1:DateFormat>sample string 14</d2p1:DateFormat>
        <d2p1:DefaultDashboard>13</d2p1:DefaultDashboard>
        <d2p1:Email>sample string 6</d2p1:Email>
        <d2p1:EnableAlertTimeframe>true</d2p1:EnableAlertTimeframe>
        <d2p1:FamilyName>sample string 5</d2p1:FamilyName>
        <d2p1:GivenName>sample string 4</d2p1:GivenName>
        <d2p1:GraphTooltips>true</d2p1:GraphTooltips>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MobileNumber>sample string 8</d2p1:MobileNumber>
        <d2p1:TimeFormat>sample string 15</d2p1:TimeFormat>
        <d2p1:TimeZoneID>sample string 9</d2p1:TimeZoneID>
        <d2p1:UserName>sample string 3</d2p1:UserName>
        <d2p1:UserRole>Monitor</d2p1:UserRole>
        <d2p1:UserRoleDescription>sample string 7</d2p1:UserRoleDescription>
      </d2p1:User>
    </d2p1:APIStructs.UserAccessList>
    <d2p1:APIStructs.UserAccessList>
      <d2p1:AccessObjects>
        <d2p1:APIStructs.UserAccess>
          <d2p1:AccessType>Nil</d2p1:AccessType>
          <d2p1:AccessTypeDescription>sample string 5</d2p1:AccessTypeDescription>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:ObjectID>3</d2p1:ObjectID>
          <d2p1:ObjectName>sample string 2</d2p1:ObjectName>
          <d2p1:ObjectType>Device</d2p1:ObjectType>
          <d2p1:TypeDescription>sample string 4</d2p1:TypeDescription>
        </d2p1:APIStructs.UserAccess>
        <d2p1:APIStructs.UserAccess>
          <d2p1:AccessType>Nil</d2p1:AccessType>
          <d2p1:AccessTypeDescription>sample string 5</d2p1:AccessTypeDescription>
          <d2p1:ID>1</d2p1:ID>
          <d2p1:ObjectID>3</d2p1:ObjectID>
          <d2p1:ObjectName>sample string 2</d2p1:ObjectName>
          <d2p1:ObjectType>Device</d2p1:ObjectType>
          <d2p1:TypeDescription>sample string 4</d2p1:TypeDescription>
        </d2p1:APIStructs.UserAccess>
      </d2p1:AccessObjects>
      <d2p1:User>
        <d2p1:AlertTimeframeEnd>PT0.1234567S</d2p1:AlertTimeframeEnd>
        <d2p1:AlertTimeframeStart>PT0.1234567S</d2p1:AlertTimeframeStart>
        <d2p1:ClientID>2</d2p1:ClientID>
        <d2p1:DateFormat>sample string 14</d2p1:DateFormat>
        <d2p1:DefaultDashboard>13</d2p1:DefaultDashboard>
        <d2p1:Email>sample string 6</d2p1:Email>
        <d2p1:EnableAlertTimeframe>true</d2p1:EnableAlertTimeframe>
        <d2p1:FamilyName>sample string 5</d2p1:FamilyName>
        <d2p1:GivenName>sample string 4</d2p1:GivenName>
        <d2p1:GraphTooltips>true</d2p1:GraphTooltips>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:MobileNumber>sample string 8</d2p1:MobileNumber>
        <d2p1:TimeFormat>sample string 15</d2p1:TimeFormat>
        <d2p1:TimeZoneID>sample string 9</d2p1:TimeZoneID>
        <d2p1:UserName>sample string 3</d2p1:UserName>
        <d2p1:UserRole>Monitor</d2p1:UserRole>
        <d2p1:UserRoleDescription>sample string 7</d2p1:UserRoleDescription>
      </d2p1:User>
    </d2p1:APIStructs.UserAccessList>
  </UserAccessList>
</GetUserAccessResponse>