> ## 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.TicketCategoryEntity

<h1 id="SuperOffice_WebApi_Data_TicketCategoryEntity">
  Class TicketCategoryEntity
</h1>

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

Carrier object for TicketCategoryEntity.
This entity describes the meta data for a ticket category, and provides special operations on it.

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.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 TicketCategoryEntity 123 using the WebApi client:
\<pre>\<code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ListAgent(configuration);
var ticketCategoryEntity = agent.GetTicketCategoryEntity( 123 );\</code>\</pre>

## Constructors

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity__ctor">
  TicketCategoryEntity()
</h3>

Default constructor - defaults any enum props to 0.

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

## Properties

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_AssignmentLag">
  AssignmentLag
</h3>

Number of minutes we shall override the assignment if a customer sends consecutive messages to this category

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_CategoryMaster">
  CategoryMaster
</h3>

The user associated with this category.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_ClosingStatus">
  ClosingStatus
</h3>

Determines the default status used in the GUI when creating a ticket
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[ClosingStatus\_String](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_ClosingStatus_String)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_ClosingStatus_String">
  ClosingStatus\_String
</h3>

Determines the default status used in the GUI when creating a ticket
Raw string enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[ClosingStatus](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_ClosingStatus)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_CustomFields">
  CustomFields
</h3>

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.
Custom fields combines user defined fields and extra fields into one bucket.
The individual \<xref href="SuperOffice.WebApi.Data.TicketCategoryEntity.ExtraFields" data-throw-if-not-resolved="false">\</xref> and UserDefinedFields properties are deprecated in favor of this
combined collection.
The value string is the encoded value: "\[I:123]" or "\[DT:2019-09-11]".

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

#### Property Value

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

#### Remarks

The naming convention of the key string is as follows:
\<table>\<tbody>\<tr>\<td class="term">Extra field data\</td>\<td class="description">
\[Extra field name]\<p>\</p>
Example: \<pre>\<code class="lang-csharp">'x\_gorp' = '\[I:123]'\</code>\</pre>
\</td>\</tr>\<tr>\<td class="term">User defined field data\</td>\<td class="description">
\[Prog-id name]\<p>\</p>
Example: \<pre>\<code class="lang-csharp">'SuperOffice:1' = '\[I:123]'\</code>\</pre>\<p>\</p>
\</td>\</tr>\</tbody>\</table>

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_DefaultMessageStatus">
  DefaultMessageStatus
</h3>

Default status for new messages, if 0 then there is a fallback to a user-dependent value

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_DefaultTicketStatus">
  DefaultTicketStatus
</h3>

Default status for new tickets, if 0 then there is a fallback to a user-dependent value

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_DelegateMethod">
  DelegateMethod
</h3>

An integer indicating the delegation method for this category.
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[DelegateMethod\_String](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_DelegateMethod_String)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_DelegateMethod_String">
  DelegateMethod\_String
</h3>

An integer indicating the delegation method for this category.
Raw string enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[DelegateMethod](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_DelegateMethod)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_EffectiveReplyTemplateId">
  EffectiveReplyTemplateId
</h3>

Id of reply template to merge into messages, whose ticket belongs to this category. Also takes into account 'Apply to subcategories' on parent categories. This is a calculated, readonly field.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_ExternalName">
  ExternalName
</h3>

The external name for this category, used for the customer frontend.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_ExtraFields">
  ExtraFields
</h3>

Deprecated: Use \<xref href="SuperOffice.WebApi.Data.TicketCategoryEntity.CustomFields" data-throw-if-not-resolved="false">\</xref> instead.
Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
The value string is the encoded value: "\[I:123]" or "\[DT:2019-09-11]".

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

#### Property Value

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

#### Remarks

The naming convention of the key string is as follows:
\<table>\<tbody>\<tr>\<td class="term">Plug-in data\</td>\<td class="description">
\[Plug-in name].\[Property name]
Example: DocumentPlugin.DocumentType
\</td>\</tr>\<tr>\<td class="term">Foreign key data\</td>\<td class="description">
The device identity is appended directly to the device name if it exists.
This is not commonly used, but the database opens for this as a possibility to have several devices with the same name,
and hence we would ensure an unique key if this field is used.
Example: Audience.SecretService.DefaultCountry
\</td>\</tr>\<tr>\<td class="term">User defined table data\</td>\<td class="description">
\[Table name].\[Field name]
Example: Phunneling.AggregatedSales
\</td>\</tr>\<tr>\<td class="term">Other\</td>\<td class="description">
Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary.
We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
\</td>\</tr>\</tbody>\</table>

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_Flags">
  Flags
</h3>

A bitmask representing flags for this category.
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[Flags\_String](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_Flags_String)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_Flags_String">
  Flags\_String
</h3>

A bitmask representing flags for this category.
Raw string enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[Flags](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_Flags)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_Fullname">
  Fullname
</h3>

The fullname (compiled from parents\&apos; names) for this category. E.g. \&apos;norway/product A/support\&apos;.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_MsgClosingStatus">
  MsgClosingStatus
</h3>

Determines the default status used in the GUI when adding a request to a ticket
NULL if unknown enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[MsgClosingStatus\_String](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_MsgClosingStatus_String)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_MsgClosingStatus_String">
  MsgClosingStatus\_String
</h3>

Determines the default status used in the GUI when adding a request to a ticket
Raw string enum value.

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

#### Property Value

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

#### See Also

[TicketCategoryEntity](SuperOffice.WebApi.Data.TicketCategoryEntity.md).[MsgClosingStatus](SuperOffice.WebApi.Data.TicketCategoryEntity.md#SuperOffice_WebApi_Data_TicketCategoryEntity_MsgClosingStatus)

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_Name">
  Name
</h3>

The (short) name of this category. E.g. \&apos;support\&apos;.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_NotificationEmail">
  NotificationEmail
</h3>

Comma separated list of addresses to notify when requests are redelegated to (unassigned) in this category.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_ParentId">
  ParentId
</h3>

The parent category for this category. -1 if this is a toplevel category.

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_ReplyTemplate">
  ReplyTemplate
</h3>

Reply template to merge with messages posted in this category

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

#### Property Value

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

<h3 id="SuperOffice_WebApi_Data_TicketCategoryEntity_TicketCategoryId">
  TicketCategoryId
</h3>

The id of the ticket category. (primary key)

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

#### Property Value

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

## See Also

[ListAgent](SuperOffice.WebApi.Agents.ListAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.TicketCategory](/en/api/reference/webapi/SuperOffice.WebApi.Data.TicketCategory.md)
- [SuperOffice.WebApi.Data.TicketEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.TicketEntity.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [SuperOffice.WebApi.Data.TicketCategoryMembershipEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.TicketCategoryMembershipEntity.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)