POST api/roles

Request Information

URI Parameters

None.

Body Parameters

Role
NameDescriptionTypeAdditional information
RoleId

integer

None.

RoleName

string

None.

Description

string

None.

IsActive

boolean

None.

Permissions

Collection of Permission

None.

IsSystemRole

boolean

None.

CreatedAt

date

None.

PermissionCount

integer

None.

UserCount

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "RoleId": 1,
  "RoleName": "sample string 2",
  "Description": "sample string 3",
  "IsActive": true,
  "Permissions": [
    {
      "PermissionId": 1,
      "PermissionName": "sample string 2",
      "Module": "sample string 3",
      "Description": "sample string 4",
      "IsActive": true,
      "DisplayName": {},
      "RoleCount": {}
    },
    {
      "PermissionId": 1,
      "PermissionName": "sample string 2",
      "Module": "sample string 3",
      "Description": "sample string 4",
      "IsActive": true,
      "DisplayName": {},
      "RoleCount": {}
    }
  ],
  "IsSystemRole": true,
  "CreatedAt": "2025-12-22T19:59:46.0515399+05:30",
  "PermissionCount": 7,
  "UserCount": 8
}

application/xml, text/xml

Sample:
<Role xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NSGVisitor.Entities">
  <CreatedAt>2025-12-22T19:59:46.0515399+05:30</CreatedAt>
  <Description>sample string 3</Description>
  <IsActive>true</IsActive>
  <IsSystemRole>true</IsSystemRole>
  <PermissionCount>7</PermissionCount>
  <Permissions>
    <Permission>
      <Description>sample string 4</Description>
      <DisplayName />
      <IsActive>true</IsActive>
      <Module>sample string 3</Module>
      <PermissionId>1</PermissionId>
      <PermissionName>sample string 2</PermissionName>
      <RoleCount />
    </Permission>
    <Permission>
      <Description>sample string 4</Description>
      <DisplayName />
      <IsActive>true</IsActive>
      <Module>sample string 3</Module>
      <PermissionId>1</PermissionId>
      <PermissionName>sample string 2</PermissionName>
      <RoleCount />
    </Permission>
  </Permissions>
  <RoleId>1</RoleId>
  <RoleName>sample string 2</RoleName>
  <UserCount>8</UserCount>
</Role>

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 'Role'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.