POST api/Role

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RoleDescription	string	None.
RoleName	string	None.
IsPortalRole	boolean	None.
RolePermissions	Collection of SaveRolePermissionViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "RoleDescription": "sample string 1",
  "RoleName": "sample string 2",
  "IsPortalRole": true,
  "RolePermissions": [
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "PermissionId": 1
    },
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "PermissionId": 1
    }
  ]
}

application/xml, text/xml

Sample:

<CreateRoleViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <IsPortalRole>true</IsPortalRole>
  <RoleDescription>sample string 1</RoleDescription>
  <RoleName>sample string 2</RoleName>
  <RolePermissions>
    <SaveRolePermissionViewModel>
      <EntityAttributeId>1</EntityAttributeId>
      <EntityCategoryId>1</EntityCategoryId>
      <EntityDefinitionId>1</EntityDefinitionId>
      <FileDirectoryId>1</FileDirectoryId>
      <PermissionId>1</PermissionId>
    </SaveRolePermissionViewModel>
    <SaveRolePermissionViewModel>
      <EntityAttributeId>1</EntityAttributeId>
      <EntityCategoryId>1</EntityCategoryId>
      <EntityDefinitionId>1</EntityDefinitionId>
      <FileDirectoryId>1</FileDirectoryId>
      <PermissionId>1</PermissionId>
    </SaveRolePermissionViewModel>
  </RolePermissions>
</CreateRoleViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReadRoleViewModel

Name	Type	Additional information
ApplicationId	globally unique identifier	None.
Description	string	None.
IsUsed	boolean	None.
LoweredRoleName	string	None.
RoleId	globally unique identifier	None.
RoleName	string	None.
RolePermissions	Collection of ReadRolePermissionViewModel	None.
UserCompanyId	integer	None.
IsPortalRole	boolean	None.