Skip to main content

Class RoleEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for RoleEntity.

Inheritance

objectCarrierRoleEntity

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get RoleEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new UserAgent(configuration);
var roleEntity = agent.GetRoleEntity( 123 );

Remarks

Use : All RoleEntity:
“Role”

Constructors

RoleEntity()

Default constructor - defaults any enum props to 0.

Properties

Created

Registered when

Property Value

DateTime

CreatedBy

Created by user

Property Value

Associate

DataRights

Data rights matrix - defines role’s access to data owned by current user, users in same group, and other users.

Property Value

DataRights

Deleted

1 if role has been deleted (we do not actually delete)

Property Value

short

Name

Visible role name

Property Value

string

Rank

Sorting rank of this role in lists

Property Value

short

RoleId

Primary key

Property Value

int

RoleType

The role type. Note that changing this field has no effect, so treat this as a read-only field. NULL if unknown enum value.

Property Value

RoleType?

See Also

RoleEntity.RoleType_String

RoleType_String

The role type. Note that changing this field has no effect, so treat this as a read-only field. Raw string enum value.

Property Value

string

See Also

RoleEntity.RoleType

Tooltip

Description of the role.

Property Value

string

Updated

Last updated when

Property Value

DateTime

UpdatedBy

Last updated by user

Property Value

Associate

UseCategories

Apply role category membership to users

Property Value

short

See Also

UserAgent, ArchiveAgent,