GET api/SuperUser?userId={userId}

Request Information

URI Parameters

Name	Description	Type	Additional information
userId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

UserViewModel

Name	Type	Additional information
Id	integer	None.
UniqueId	globally unique identifier	None.
Type	string	None.
SNUA	integer	None.
Email	string	None.
FirstName	string	None.
LastName	string	None.
FullName	string	None.
OfficePhone	string	None.
HomePhone	string	None.
Cell	string	None.
Fax	string	None.
JobTitle	string	None.
Salutation	string	None.
MainContact	boolean	None.
Inactive	boolean	None.
Verified	boolean	None.
Admin	boolean	None.
IsGroupHeader	boolean	None.
Permissions	string	None.
GroupId	integer	None.
GroupUid	globally unique identifier	None.
IsStrongPassword	boolean	None.
HostName	string	None.
DeletedDate	date	None.
DeletedByUserId	integer	None.
DeletedByUserUid	globally unique identifier	None.
CompanyId	integer	None.
CompanyUniqueId	globally unique identifier	None.
CompanyName	string	None.
IsSuperUser	boolean	None.
Status	string	None.
Password	string	None.
ConfirmPassword	string	None.
CurrentPassword	string	None.
UserRadio	RadioButtonDto	None.
GroupRadio	RadioButtonDto	None.
GroupDropDown	DropDownBoxDto	None.
HideCheckBox	CheckBoxDto	None.
InputParameter	UserInputParamaterViewModel	None.
UserPermissions	PermissionsViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "userRadio": {
    "value": true,
    "visible": true,
    "enabled": true
  },
  "groupRadio": {
    "value": true,
    "visible": true,
    "enabled": true
  },
  "groupDropDown": {
    "visible": true,
    "enabled": true,
    "items": [
      "sample string 1",
      "sample string 2"
    ],
    "guids": [
      "fd324f75-9e10-4d54-b591-f63a87af2884",
      "21a154e6-2976-4486-bbe4-bac073b0ee73"
    ],
    "selectedIndex": 1,
    "selectedItem": "sample string 3",
    "filterUid": "07077296-a806-4662-892d-6cb8c1851bad"
  },
  "hideCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "inputParameter": {
    "transactionType": 1
  },
  "userPermissions": {
    "permissions": [
      {
        "index": 1,
        "category": "sample string 2",
        "categoryId": 3,
        "name": "sample string 4",
        "hide": true,
        "locked": true,
        "hideText": "sample string 7",
        "lockedText": "sample string 8",
        "isAdmin": true,
        "dataType": "sample string 10"
      },
      {
        "index": 1,
        "category": "sample string 2",
        "categoryId": 3,
        "name": "sample string 4",
        "hide": true,
        "locked": true,
        "hideText": "sample string 7",
        "lockedText": "sample string 8",
        "isAdmin": true,
        "dataType": "sample string 10"
      }
    ],
    "clearancePermissions": {
      "clearance": [
        {
          "clearanceName": "sample string 1",
          "selected": true,
          "index": 3,
          "disabled": true
        },
        {
          "clearanceName": "sample string 1",
          "selected": true,
          "index": 3,
          "disabled": true
        }
      ],
      "administratorCheckBox": {
        "checked": true,
        "visible": true,
        "enabled": true,
        "caption": "sample string 4"
      },
      "accountManagerCheckBox": {
        "checked": true,
        "visible": true,
        "enabled": true,
        "caption": "sample string 4"
      },
      "write": [
        {
          "checked": true,
          "visible": true,
          "enabled": true,
          "caption": "sample string 4"
        },
        {
          "checked": true,
          "visible": true,
          "enabled": true,
          "caption": "sample string 4"
        }
      ],
      "overwrite": [
        {
          "checked": true,
          "visible": true,
          "enabled": true,
          "caption": "sample string 4"
        },
        {
          "checked": true,
          "visible": true,
          "enabled": true,
          "caption": "sample string 4"
        }
      ],
      "enabled": true,
      "newIndex": 2
    },
    "myDataPermissions": {
      "myData": [
        {
          "myData": "sample string 1",
          "read": true,
          "write": true
        },
        {
          "myData": "sample string 1",
          "read": true,
          "write": true
        }
      ]
    },
    "directoryPermissions": {
      "directory": [
        {
          "view": "sample string 1",
          "read": true
        },
        {
          "view": "sample string 1",
          "read": true
        }
      ]
    },
    "customSheetsPermissions": {
      "customSheet": [
        {
          "sheet": "sample string 1",
          "read": true
        },
        {
          "sheet": "sample string 1",
          "read": true
        }
      ]
    },
    "userLicensePermissions": {
      "license": [
        {
          "licenseId": 1,
          "name": "sample string 2",
          "selected": true,
          "disabled": true,
          "dataType": "sample string 5"
        },
        {
          "licenseId": 1,
          "name": "sample string 2",
          "selected": true,
          "disabled": true,
          "dataType": "sample string 5"
        }
      ]
    },
    "expandedPermissions": [
      "sample string 1",
      "sample string 2"
    ],
    "pasteButton": {
      "visible": true,
      "enabled": true,
      "caption": "sample string 3"
    }
  },
  "id": 1,
  "uniqueId": "3b7b94d0-9a54-49fc-82a6-84e6e44f87de",
  "type": "sample string 3",
  "snua": 4,
  "email": "sample string 5",
  "firstName": "sample string 6",
  "lastName": "sample string 7",
  "fullName": "sample string 8",
  "officePhone": "sample string 9",
  "homePhone": "sample string 10",
  "cell": "sample string 11",
  "fax": "sample string 12",
  "jobTitle": "sample string 13",
  "salutation": "sample string 14",
  "mainContact": true,
  "inactive": true,
  "verified": true,
  "admin": true,
  "isGroupHeader": true,
  "permissions": "sample string 20",
  "groupId": 21,
  "groupUid": "7d83045f-d9c8-4ff9-b83f-b02c72787a6b",
  "isStrongPassword": true,
  "hostName": "sample string 23",
  "deletedDate": "2025-04-25T12:11:44.7677693+00:00",
  "deletedByUserId": 1,
  "deletedByUserUid": "334a44e1-2a70-4265-b9bf-74ea0b1d67f2",
  "companyId": 24,
  "companyUniqueId": "7ac3c9d1-4c1f-4d27-98a8-15d813d74180",
  "companyName": "sample string 26",
  "isSuperUser": true,
  "status": "sample string 28",
  "password": "sample string 29",
  "confirmPassword": "sample string 30",
  "currentPassword": "sample string 31"
}

application/xml, text/xml

Sample:

<UserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Admin>true</Admin>
  <Cell>sample string 11</Cell>
  <CompanyId>24</CompanyId>
  <CompanyName>sample string 26</CompanyName>
  <CompanyUniqueId>7ac3c9d1-4c1f-4d27-98a8-15d813d74180</CompanyUniqueId>
  <ConfirmPassword>sample string 30</ConfirmPassword>
  <CurrentPassword>sample string 31</CurrentPassword>
  <DeletedByUserId>1</DeletedByUserId>
  <DeletedByUserUid>334a44e1-2a70-4265-b9bf-74ea0b1d67f2</DeletedByUserUid>
  <DeletedDate>2025-04-25T12:11:44.7677693+00:00</DeletedDate>
  <Email>sample string 5</Email>
  <Fax>sample string 12</Fax>
  <FirstName>sample string 6</FirstName>
  <FullName>sample string 8</FullName>
  <GroupDropDown xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:FilterUid>07077296-a806-4662-892d-6cb8c1851bad</d2p1:FilterUid>
    <d2p1:Guids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>fd324f75-9e10-4d54-b591-f63a87af2884</d3p1:guid>
      <d3p1:guid>21a154e6-2976-4486-bbe4-bac073b0ee73</d3p1:guid>
    </d2p1:Guids>
    <d2p1:Items xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Items>
    <d2p1:SelectedIndex>1</d2p1:SelectedIndex>
    <d2p1:SelectedItem>sample string 3</d2p1:SelectedItem>
    <d2p1:Visible>true</d2p1:Visible>
  </GroupDropDown>
  <GroupId>21</GroupId>
  <GroupRadio xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Value>true</d2p1:Value>
    <d2p1:Visible>true</d2p1:Visible>
  </GroupRadio>
  <GroupUid>7d83045f-d9c8-4ff9-b83f-b02c72787a6b</GroupUid>
  <HideCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 4</d2p1:Caption>
    <d2p1:Checked>true</d2p1:Checked>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </HideCheckBox>
  <HomePhone>sample string 10</HomePhone>
  <HostName>sample string 23</HostName>
  <Id>1</Id>
  <Inactive>true</Inactive>
  <InputParameter>
    <TransactionType>Add</TransactionType>
  </InputParameter>
  <IsGroupHeader>true</IsGroupHeader>
  <IsStrongPassword>true</IsStrongPassword>
  <IsSuperUser>true</IsSuperUser>
  <JobTitle>sample string 13</JobTitle>
  <LastName>sample string 7</LastName>
  <MainContact>true</MainContact>
  <OfficePhone>sample string 9</OfficePhone>
  <Password>sample string 29</Password>
  <Permissions>sample string 20</Permissions>
  <SNUA>4</SNUA>
  <Salutation>sample string 14</Salutation>
  <Status>sample string 28</Status>
  <Type>sample string 3</Type>
  <UniqueId>3b7b94d0-9a54-49fc-82a6-84e6e44f87de</UniqueId>
  <UserPermissions>
    <ClearancePermissions>
      <AccountManagerCheckBox xmlns:d4p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
        <d4p1:Caption>sample string 4</d4p1:Caption>
        <d4p1:Checked>true</d4p1:Checked>
        <d4p1:Enabled>true</d4p1:Enabled>
        <d4p1:Visible>true</d4p1:Visible>
      </AccountManagerCheckBox>
      <AdministratorCheckBox xmlns:d4p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
        <d4p1:Caption>sample string 4</d4p1:Caption>
        <d4p1:Checked>true</d4p1:Checked>
        <d4p1:Enabled>true</d4p1:Enabled>
        <d4p1:Visible>true</d4p1:Visible>
      </AdministratorCheckBox>
      <Clearance>
        <ClearancePermissionViewModel>
          <ClearanceName>sample string 1</ClearanceName>
          <Disabled>true</Disabled>
          <Index>3</Index>
          <Selected>true</Selected>
        </ClearancePermissionViewModel>
        <ClearancePermissionViewModel>
          <ClearanceName>sample string 1</ClearanceName>
          <Disabled>true</Disabled>
          <Index>3</Index>
          <Selected>true</Selected>
        </ClearancePermissionViewModel>
      </Clearance>
      <Enabled>true</Enabled>
      <NewIndex>2</NewIndex>
      <Overwrite xmlns:d4p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
        <d4p1:CheckBoxDto>
          <d4p1:Caption>sample string 4</d4p1:Caption>
          <d4p1:Checked>true</d4p1:Checked>
          <d4p1:Enabled>true</d4p1:Enabled>
          <d4p1:Visible>true</d4p1:Visible>
        </d4p1:CheckBoxDto>
        <d4p1:CheckBoxDto>
          <d4p1:Caption>sample string 4</d4p1:Caption>
          <d4p1:Checked>true</d4p1:Checked>
          <d4p1:Enabled>true</d4p1:Enabled>
          <d4p1:Visible>true</d4p1:Visible>
        </d4p1:CheckBoxDto>
      </Overwrite>
      <Write xmlns:d4p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
        <d4p1:CheckBoxDto>
          <d4p1:Caption>sample string 4</d4p1:Caption>
          <d4p1:Checked>true</d4p1:Checked>
          <d4p1:Enabled>true</d4p1:Enabled>
          <d4p1:Visible>true</d4p1:Visible>
        </d4p1:CheckBoxDto>
        <d4p1:CheckBoxDto>
          <d4p1:Caption>sample string 4</d4p1:Caption>
          <d4p1:Checked>true</d4p1:Checked>
          <d4p1:Enabled>true</d4p1:Enabled>
          <d4p1:Visible>true</d4p1:Visible>
        </d4p1:CheckBoxDto>
      </Write>
    </ClearancePermissions>
    <CustomSheetsPermissions>
      <CustomSheet>
        <CustomSheetPermissionsViewModel>
          <Read>true</Read>
          <Sheet>sample string 1</Sheet>
        </CustomSheetPermissionsViewModel>
        <CustomSheetPermissionsViewModel>
          <Read>true</Read>
          <Sheet>sample string 1</Sheet>
        </CustomSheetPermissionsViewModel>
      </CustomSheet>
    </CustomSheetsPermissions>
    <DirectoryPermissions>
      <Directory>
        <DirectoryPermissionViewModel>
          <Read>true</Read>
          <View>sample string 1</View>
        </DirectoryPermissionViewModel>
        <DirectoryPermissionViewModel>
          <Read>true</Read>
          <View>sample string 1</View>
        </DirectoryPermissionViewModel>
      </Directory>
    </DirectoryPermissions>
    <ExpandedPermissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ExpandedPermissions>
    <MyDataPermissions>
      <MyData>
        <MyDataPermissionViewModel>
          <MyData>sample string 1</MyData>
          <Read>true</Read>
          <Write>true</Write>
        </MyDataPermissionViewModel>
        <MyDataPermissionViewModel>
          <MyData>sample string 1</MyData>
          <Read>true</Read>
          <Write>true</Write>
        </MyDataPermissionViewModel>
      </MyData>
    </MyDataPermissions>
    <PasteButton xmlns:d3p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
      <d3p1:Caption>sample string 3</d3p1:Caption>
      <d3p1:Enabled>true</d3p1:Enabled>
      <d3p1:Visible>true</d3p1:Visible>
    </PasteButton>
    <Permissions>
      <PermissionViewModel>
        <Category>sample string 2</Category>
        <CategoryId>3</CategoryId>
        <DataType>sample string 10</DataType>
        <Hide>true</Hide>
        <HideText>sample string 7</HideText>
        <Index>1</Index>
        <Locked>true</Locked>
        <LockedText>sample string 8</LockedText>
        <Name>sample string 4</Name>
        <isAdmin>true</isAdmin>
      </PermissionViewModel>
      <PermissionViewModel>
        <Category>sample string 2</Category>
        <CategoryId>3</CategoryId>
        <DataType>sample string 10</DataType>
        <Hide>true</Hide>
        <HideText>sample string 7</HideText>
        <Index>1</Index>
        <Locked>true</Locked>
        <LockedText>sample string 8</LockedText>
        <Name>sample string 4</Name>
        <isAdmin>true</isAdmin>
      </PermissionViewModel>
    </Permissions>
    <UserLicensePermissions>
      <License>
        <UserLicensePermissionViewModel>
          <DataType>sample string 5</DataType>
          <Disabled>true</Disabled>
          <LicenseId>1</LicenseId>
          <Name>sample string 2</Name>
          <Selected>true</Selected>
        </UserLicensePermissionViewModel>
        <UserLicensePermissionViewModel>
          <DataType>sample string 5</DataType>
          <Disabled>true</Disabled>
          <LicenseId>1</LicenseId>
          <Name>sample string 2</Name>
          <Selected>true</Selected>
        </UserLicensePermissionViewModel>
      </License>
    </UserLicensePermissions>
  </UserPermissions>
  <UserRadio xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Value>true</d2p1:Value>
    <d2p1:Visible>true</d2p1:Visible>
  </UserRadio>
  <Verified>true</Verified>
</UserViewModel>