GET V3/odata/User

Gets User entities

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of QicsUnity.Api.Areas.V3.Models.User

Name	Description	Type	Additional information
UserId	Gets or sets the UserId	integer	Required 64-bit signed integer
UserName	Gets or sets the user name	string	Required
AllCompanies	Gets or sets a value indicating whether user can access all companies	boolean	Required
AssignedCompanyIds	Gets or sets the list of AssignedCompanyId values of companies the user belongs to. This field is used only when AllCompanies is set to False.	Collection of integer
IsActive	Gets or sets a value indicating whether user is active	boolean	Required
HasMenuVisible	Gets or sets a value indicating whether user has menu visible	boolean	Required
AllowAccessTo	Gets or sets application where user has access	QicsUnity.Api.Areas.V3.Models.UserAllowAccessTo	Required
EmployeeId	Gets or sets a reference to the Employee table	integer	64-bit signed integer Nullable
RoleIds	Gets or sets the list of RoleId values of roles the user belongs to	Collection of integer
RequireTwoFactor	Gets or sets a value indicating whether Two-factor authentication is required. Filtering by this field is not supported.	boolean	Required
SuppressTwoFactor	Gets or sets a value indicating whether Two-factor authentication is suppressed. Filtering by this field is not supported.	boolean	Required
Password	Gets or sets password. Filtering by this field is not supported. Used only when inserting user, returns null (is hidden) in responses.	string
ItemDisplayFormat	Gets or sets item display format user preference. Filtering by this field is not supported.	QicsUnity.Api.Areas.V3.Models.ItemDisplayFormat	Nullable
Language	Gets or sets language user preference. Filtering by this field is not supported.	QicsUnity.Api.Areas.V3.Models.LanguageType	Nullable
RegionalFormatting	Gets or sets regional formatting user preference. Filtering by this field is not supported.	QicsUnity.Api.Areas.V3.Models.RegionalFormatting	Nullable

Response Formats

application/json, text/json

Sample:

[
  {
    "UserId": "1",
    "UserName": "sample 2",
    "AllCompanies": true,
    "AssignedCompanyIds": [
      "1",
      "2"
    ],
    "IsActive": true,
    "HasMenuVisible": true,
    "AllowAccessTo": "FortesMilestones",
    "EmployeeId": "1",
    "RoleIds": [
      "1",
      "2"
    ],
    "RequireTwoFactor": true,
    "SuppressTwoFactor": true,
    "Password": "sample 8",
    "ItemDisplayFormat": "Code",
    "Language": "Company",
    "RegionalFormatting": "English"
  },
  {
    "UserId": "1",
    "UserName": "sample 2",
    "AllCompanies": true,
    "AssignedCompanyIds": [
      "1",
      "2"
    ],
    "IsActive": true,
    "HasMenuVisible": true,
    "AllowAccessTo": "FortesMilestones",
    "EmployeeId": "1",
    "RoleIds": [
      "1",
      "2"
    ],
    "RequireTwoFactor": true,
    "SuppressTwoFactor": true,
    "Password": "sample 8",
    "ItemDisplayFormat": "Code",
    "Language": "Company",
    "RegionalFormatting": "English"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V3.Models">
  <User>
    <AllCompanies>true</AllCompanies>
    <AllowAccessTo>FortesMilestones</AllowAccessTo>
    <AssignedCompanyIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </AssignedCompanyIds>
    <EmployeeId>1</EmployeeId>
    <HasMenuVisible>true</HasMenuVisible>
    <IsActive>true</IsActive>
    <ItemDisplayFormat>Code</ItemDisplayFormat>
    <Language>Company</Language>
    <Password>sample 8</Password>
    <RegionalFormatting>English</RegionalFormatting>
    <RequireTwoFactor>true</RequireTwoFactor>
    <RoleIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </RoleIds>
    <SuppressTwoFactor>true</SuppressTwoFactor>
    <UserId>1</UserId>
    <UserName>sample 2</UserName>
  </User>
  <User>
    <AllCompanies>true</AllCompanies>
    <AllowAccessTo>FortesMilestones</AllowAccessTo>
    <AssignedCompanyIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </AssignedCompanyIds>
    <EmployeeId>1</EmployeeId>
    <HasMenuVisible>true</HasMenuVisible>
    <IsActive>true</IsActive>
    <ItemDisplayFormat>Code</ItemDisplayFormat>
    <Language>Company</Language>
    <Password>sample 8</Password>
    <RegionalFormatting>English</RegionalFormatting>
    <RequireTwoFactor>true</RequireTwoFactor>
    <RoleIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </RoleIds>
    <SuppressTwoFactor>true</SuppressTwoFactor>
    <UserId>1</UserId>
    <UserName>sample 2</UserName>
  </User>
</ArrayOfUser>