POST api/Role/AddUsersToRole?roleId={roleId}

Request Information

URI Parameters

Name	Description	Type	Additional information
roleId		integer	Required

Body Parameters

Collection of UserDTO

Name	Type	Additional information
Id	integer	None.
UserName	string	Required Matching regular expression pattern: ([a-zA-Z0-9]).{0,50}$\|[\u0621-\u064A].{0,50} String length: inclusive between 0 and 50
FirstName	string	Required Matching regular expression pattern: ([a-zA-Z\s]+)\|(([\u0621-\u064A]\s*)+\|[\u0621-\u064A])
FirstNameOther	string	Matching regular expression pattern: ([a-zA-Z\s]+)\|(([\u0621-\u064A]\s*)+\|[\u0621-\u064A]) String length: inclusive between 2 and 50
LastName	string	Required Matching regular expression pattern: ([a-zA-Z\s]+)\|(([\u0621-\u064A]\s*)+\|[\u0621-\u064A]) String length: inclusive between 2 and 50
LastNameOther	string	Matching regular expression pattern: ([a-zA-Z\s]+)\|(([\u0621-\u064A]\s*)+\|[\u0621-\u064A]) String length: inclusive between 2 and 50
InitialName	string	String length: inclusive between 2 and 4
Email	string	Required Data type: EmailAddress Matching regular expression pattern: ^([\w\.\-]+)@([\w\-]+)((\.(\w){2,3})+)$ String length: inclusive between 0 and 50
Password	string	Required Matching regular expression pattern: ^(?=.[a-z])(?=.[A-Z])(?=.\d)(?=.[^\da-zA-Z]).{1,50}$ String length: inclusive between 1 and 50
ConfirmPassword	string	Data type: Password
IsActiveUser	boolean	None.
IsActiveDirectoryUser	boolean	None.
Phone	string	Matching regular expression pattern: ^[0-9]*$
Mobile	string	Matching regular expression pattern: ^[0-9]*$ String length: inclusive between 0 and 20
JobTitleId	globally unique identifier	None.
Address	string	String length: inclusive between 0 and 50
IsLocalAdmin	boolean	None.
IsGlobalAdmin	boolean	None.
LocationId	globally unique identifier	None.
LoginDays	string	String length: inclusive between 0 and 50
LoginTime	string	String length: inclusive between 0 and 50
IsLocked	boolean	None.
IsSecurityAnswerLocked	boolean	None.
MustChangePassword	boolean	None.
Groups	Collection of GroupDTO	None.
RoleDTOs	Collection of RoleDTO	None.
Privileges	Collection of PrivilegeDTO	None.
MenuItems	Collection of UserMenuItemDTO	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "FirstNameOther": "sample string 4",
    "LastName": "sample string 5",
    "LastNameOther": "sample string 6",
    "InitialName": "sample string 7",
    "Email": "sample string 8",
    "Password": "sample string 9",
    "ConfirmPassword": "sample string 10",
    "IsActiveUser": true,
    "IsActiveDirectoryUser": true,
    "Phone": "sample string 13",
    "Mobile": "sample string 14",
    "JobTitleId": "2dcafc93-dcc4-4287-b76f-39d68e313f13",
    "Address": "sample string 15",
    "IsLocalAdmin": true,
    "IsGlobalAdmin": true,
    "LocationId": "90fe585f-05b7-4b0a-a994-e8fb7cfb36f5",
    "LoginDays": "sample string 18",
    "LoginTime": "sample string 19",
    "IsLocked": true,
    "IsSecurityAnswerLocked": true,
    "MustChangePassword": true,
    "Groups": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true
      }
    ],
    "RoleDTOs": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true,
        "IsChecked": true
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true,
        "IsChecked": true
      }
    ],
    "Privileges": [
      {
        "Id": "1936c166-312a-4f52-adfe-6126da3a46f2",
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "ControlId": "sample string 6",
        "IsActive": true
      },
      {
        "Id": "1936c166-312a-4f52-adfe-6126da3a46f2",
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "ControlId": "sample string 6",
        "IsActive": true
      }
    ],
    "MenuItems": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "ParentId": 1,
        "URL": "sample string 4",
        "ApplicationId": 1,
        "ItemOrder": 5
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "ParentId": 1,
        "URL": "sample string 4",
        "ApplicationId": 1,
        "ItemOrder": 5
      }
    ]
  },
  {
    "Id": 1,
    "UserName": "sample string 2",
    "FirstName": "sample string 3",
    "FirstNameOther": "sample string 4",
    "LastName": "sample string 5",
    "LastNameOther": "sample string 6",
    "InitialName": "sample string 7",
    "Email": "sample string 8",
    "Password": "sample string 9",
    "ConfirmPassword": "sample string 10",
    "IsActiveUser": true,
    "IsActiveDirectoryUser": true,
    "Phone": "sample string 13",
    "Mobile": "sample string 14",
    "JobTitleId": "2dcafc93-dcc4-4287-b76f-39d68e313f13",
    "Address": "sample string 15",
    "IsLocalAdmin": true,
    "IsGlobalAdmin": true,
    "LocationId": "90fe585f-05b7-4b0a-a994-e8fb7cfb36f5",
    "LoginDays": "sample string 18",
    "LoginTime": "sample string 19",
    "IsLocked": true,
    "IsSecurityAnswerLocked": true,
    "MustChangePassword": true,
    "Groups": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true
      }
    ],
    "RoleDTOs": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true,
        "IsChecked": true
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "IsActive": true,
        "IsChecked": true
      }
    ],
    "Privileges": [
      {
        "Id": "1936c166-312a-4f52-adfe-6126da3a46f2",
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "ControlId": "sample string 6",
        "IsActive": true
      },
      {
        "Id": "1936c166-312a-4f52-adfe-6126da3a46f2",
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "Description": "sample string 4",
        "DescriptionOther": "sample string 5",
        "ControlId": "sample string 6",
        "IsActive": true
      }
    ],
    "MenuItems": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "ParentId": 1,
        "URL": "sample string 4",
        "ApplicationId": 1,
        "ItemOrder": 5
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "NameOther": "sample string 3",
        "ParentId": 1,
        "URL": "sample string 4",
        "ApplicationId": 1,
        "ItemOrder": 5
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Components.UserManagement.DTO">
  <UserDTO>
    <Address>sample string 15</Address>
    <ConfirmPassword>sample string 10</ConfirmPassword>
    <Email>sample string 8</Email>
    <FirstName>sample string 3</FirstName>
    <FirstNameOther>sample string 4</FirstNameOther>
    <Groups>
      <GroupDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </GroupDTO>
      <GroupDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </GroupDTO>
    </Groups>
    <Id>1</Id>
    <InitialName>sample string 7</InitialName>
    <IsActiveDirectoryUser>true</IsActiveDirectoryUser>
    <IsActiveUser>true</IsActiveUser>
    <IsGlobalAdmin>true</IsGlobalAdmin>
    <IsLocalAdmin>true</IsLocalAdmin>
    <IsLocked>true</IsLocked>
    <IsSecurityAnswerLocked>true</IsSecurityAnswerLocked>
    <JobTitleId>2dcafc93-dcc4-4287-b76f-39d68e313f13</JobTitleId>
    <LastName>sample string 5</LastName>
    <LastNameOther>sample string 6</LastNameOther>
    <LocationId>90fe585f-05b7-4b0a-a994-e8fb7cfb36f5</LocationId>
    <LoginDays>sample string 18</LoginDays>
    <LoginTime>sample string 19</LoginTime>
    <MenuItems>
      <UserMenuItemDTO>
        <ApplicationId>1</ApplicationId>
        <Id>1</Id>
        <ItemOrder>5</ItemOrder>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
        <ParentId>1</ParentId>
        <URL>sample string 4</URL>
      </UserMenuItemDTO>
      <UserMenuItemDTO>
        <ApplicationId>1</ApplicationId>
        <Id>1</Id>
        <ItemOrder>5</ItemOrder>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
        <ParentId>1</ParentId>
        <URL>sample string 4</URL>
      </UserMenuItemDTO>
    </MenuItems>
    <Mobile>sample string 14</Mobile>
    <MustChangePassword>true</MustChangePassword>
    <Password>sample string 9</Password>
    <Phone>sample string 13</Phone>
    <Privileges>
      <PrivilegeDTO>
        <ControlId>sample string 6</ControlId>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1936c166-312a-4f52-adfe-6126da3a46f2</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </PrivilegeDTO>
      <PrivilegeDTO>
        <ControlId>sample string 6</ControlId>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1936c166-312a-4f52-adfe-6126da3a46f2</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </PrivilegeDTO>
    </Privileges>
    <RoleDTOs>
      <RoleDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <IsChecked>true</IsChecked>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </RoleDTO>
      <RoleDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <IsChecked>true</IsChecked>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </RoleDTO>
    </RoleDTOs>
    <UserName>sample string 2</UserName>
  </UserDTO>
  <UserDTO>
    <Address>sample string 15</Address>
    <ConfirmPassword>sample string 10</ConfirmPassword>
    <Email>sample string 8</Email>
    <FirstName>sample string 3</FirstName>
    <FirstNameOther>sample string 4</FirstNameOther>
    <Groups>
      <GroupDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </GroupDTO>
      <GroupDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </GroupDTO>
    </Groups>
    <Id>1</Id>
    <InitialName>sample string 7</InitialName>
    <IsActiveDirectoryUser>true</IsActiveDirectoryUser>
    <IsActiveUser>true</IsActiveUser>
    <IsGlobalAdmin>true</IsGlobalAdmin>
    <IsLocalAdmin>true</IsLocalAdmin>
    <IsLocked>true</IsLocked>
    <IsSecurityAnswerLocked>true</IsSecurityAnswerLocked>
    <JobTitleId>2dcafc93-dcc4-4287-b76f-39d68e313f13</JobTitleId>
    <LastName>sample string 5</LastName>
    <LastNameOther>sample string 6</LastNameOther>
    <LocationId>90fe585f-05b7-4b0a-a994-e8fb7cfb36f5</LocationId>
    <LoginDays>sample string 18</LoginDays>
    <LoginTime>sample string 19</LoginTime>
    <MenuItems>
      <UserMenuItemDTO>
        <ApplicationId>1</ApplicationId>
        <Id>1</Id>
        <ItemOrder>5</ItemOrder>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
        <ParentId>1</ParentId>
        <URL>sample string 4</URL>
      </UserMenuItemDTO>
      <UserMenuItemDTO>
        <ApplicationId>1</ApplicationId>
        <Id>1</Id>
        <ItemOrder>5</ItemOrder>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
        <ParentId>1</ParentId>
        <URL>sample string 4</URL>
      </UserMenuItemDTO>
    </MenuItems>
    <Mobile>sample string 14</Mobile>
    <MustChangePassword>true</MustChangePassword>
    <Password>sample string 9</Password>
    <Phone>sample string 13</Phone>
    <Privileges>
      <PrivilegeDTO>
        <ControlId>sample string 6</ControlId>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1936c166-312a-4f52-adfe-6126da3a46f2</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </PrivilegeDTO>
      <PrivilegeDTO>
        <ControlId>sample string 6</ControlId>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1936c166-312a-4f52-adfe-6126da3a46f2</Id>
        <IsActive>true</IsActive>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </PrivilegeDTO>
    </Privileges>
    <RoleDTOs>
      <RoleDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <IsChecked>true</IsChecked>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </RoleDTO>
      <RoleDTO>
        <Description>sample string 4</Description>
        <DescriptionOther>sample string 5</DescriptionOther>
        <Id>1</Id>
        <IsActive>true</IsActive>
        <IsChecked>true</IsChecked>
        <Name>sample string 2</Name>
        <NameOther>sample string 3</NameOther>
      </RoleDTO>
    </RoleDTOs>
    <UserName>sample string 2</UserName>
  </UserDTO>
</ArrayOfUserDTO>

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 'List`1'.

Response Information

Resource Description

ReturnResult

Name	Description	Type	Additional information
ResultCode		ReturnResultCode	None.
ResultMessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCode": 1,
  "ResultMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<ReturnResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure">
  <ResultCode>NullOrEmptyUserId</ResultCode>
  <ResultMessage>sample string 1</ResultMessage>
</ReturnResult>