> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.RoleEntity

# <a id="SuperOffice_WebApi_Data_RoleEntity" /> Class RoleEntity

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for RoleEntity.

```csharp theme={null}
public class RoleEntity : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[RoleEntity](SuperOffice.WebApi.Data.RoleEntity.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get RoleEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new UserAgent(configuration);
var roleEntity = agent.GetRoleEntity( 123 );</code></pre>

## Remarks

Use <xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false" />:
All RoleEntity: <pre><code class="lang-csharp">"Role"</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_RoleEntity__ctor" /> RoleEntity()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public RoleEntity()
```

## Properties

### <a id="SuperOffice_WebApi_Data_RoleEntity_Created" /> Created

Registered when

```csharp theme={null}
public virtual DateTime Created { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_RoleEntity_CreatedBy" /> CreatedBy

Created by user

```csharp theme={null}
public virtual Associate CreatedBy { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

### <a id="SuperOffice_WebApi_Data_RoleEntity_DataRights" /> DataRights

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

```csharp theme={null}
public virtual DataRights DataRights { get; set; }
```

#### Property Value

[DataRights](SuperOffice.WebApi.Data.DataRights.md)

### <a id="SuperOffice_WebApi_Data_RoleEntity_Deleted" /> Deleted

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

```csharp theme={null}
public virtual short Deleted { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_RoleEntity_Name" /> Name

Visible role name

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_RoleEntity_Rank" /> Rank

Sorting rank of this role in lists

```csharp theme={null}
public virtual short Rank { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_RoleEntity_RoleId" /> RoleId

Primary key

```csharp theme={null}
public virtual int RoleId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_RoleEntity_RoleType" /> 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.

```csharp theme={null}
[JsonIgnore]
public RoleType? RoleType { get; set; }
```

#### Property Value

[RoleType](SuperOffice.WebApi.Data.RoleType.md)?

#### See Also

[RoleEntity](SuperOffice.WebApi.Data.RoleEntity.md).[RoleType\_String](SuperOffice.WebApi.Data.RoleEntity.md#SuperOffice_WebApi_Data_RoleEntity_RoleType_String)

### <a id="SuperOffice_WebApi_Data_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.

```csharp theme={null}
[JsonProperty("RoleType")]
public string RoleType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[RoleEntity](SuperOffice.WebApi.Data.RoleEntity.md).[RoleType](SuperOffice.WebApi.Data.RoleEntity.md#SuperOffice_WebApi_Data_RoleEntity_RoleType)

### <a id="SuperOffice_WebApi_Data_RoleEntity_Tooltip" /> Tooltip

Description of the role.

```csharp theme={null}
public virtual string Tooltip { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_RoleEntity_Updated" /> Updated

Last updated when

```csharp theme={null}
public virtual DateTime Updated { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_RoleEntity_UpdatedBy" /> UpdatedBy

Last updated by user

```csharp theme={null}
public virtual Associate UpdatedBy { get; set; }
```

#### Property Value

[Associate](SuperOffice.WebApi.Data.Associate.md)

### <a id="SuperOffice_WebApi_Data_RoleEntity_UseCategories" /> UseCategories

Apply role category membership to users

```csharp theme={null}
public virtual short UseCategories { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

## See Also

[UserAgent](SuperOffice.WebApi.Agents.UserAgent.md),
[ArchiveAgent](SuperOffice.WebApi.Agents.ArchiveAgent.md),


## Related topics

- [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md)
- [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md)
- [SuperOffice.WebApi.Data.User CreateDefaultRoleEntityFromTypeRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_CreateDefaultRoleEntityFromTypeRequest.md)
- [SuperOffice.WebApi.Data.DocumentTemplateEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.DocumentTemplateEntity.md)
- [SuperOffice.WebApi.Data.Role](/en/api/reference/webapi/SuperOffice.WebApi.Data.Role.md)
- [SuperOffice.WebApi.Data.RoleType](/en/api/reference/webapi/SuperOffice.WebApi.Data.RoleType.md)