Class TicketCategoryEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for TicketCategoryEntity. This entity describes the meta data for a ticket category, and provides special operations on it.

public class TicketCategoryEntity : Carrier

Inheritance

object ← Carrier ← TicketCategoryEntity

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 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

TicketCategoryEntity()

Default constructor - defaults any enum props to 0.

public TicketCategoryEntity()

Properties

AssignmentLag

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

public virtual int AssignmentLag { get; set; }

Property Value

int

CategoryMaster

The user associated with this category.

public virtual int CategoryMaster { get; set; }

Property Value

int

ClosingStatus

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

[JsonIgnore]
public TicketCategoryClosingStatus? ClosingStatus { get; set; }

Property Value

TicketCategoryClosingStatus?

ClosingStatus_String

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

[JsonProperty("ClosingStatus")]
public string ClosingStatus_String { get; set; }

Property Value

string

CustomFields

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]”.

public virtual StringDictionary CustomFields { get; set; }

Property Value

StringDictionary

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>

DefaultMessageStatus

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

public virtual TicketStatusEntity DefaultMessageStatus { get; set; }

Property Value

TicketStatusEntity

DefaultTicketStatus

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

public virtual TicketStatusEntity DefaultTicketStatus { get; set; }

Property Value

TicketStatusEntity

DelegateMethod

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

[JsonIgnore]
public TicketCategoryDelegateMethod? DelegateMethod { get; set; }

Property Value

TicketCategoryDelegateMethod?

DelegateMethod_String

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

[JsonProperty("DelegateMethod")]
public string DelegateMethod_String { get; set; }

Property Value

string

EffectiveReplyTemplateId

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.

public virtual int EffectiveReplyTemplateId { get; set; }

Property Value

int

ExternalName

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

public virtual string ExternalName { get; set; }

Property Value

string

ExtraFields

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]”.

public virtual StringDictionary ExtraFields { get; set; }

Property Value

StringDictionary

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>

Flags

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

[JsonIgnore]
public TicketCategoryFlags? Flags { get; set; }

Property Value

TicketCategoryFlags?

Flags_String

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

[JsonProperty("Flags")]
public string Flags_String { get; set; }

Property Value

string

Fullname

The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.

public virtual string Fullname { get; set; }

Property Value

string

MsgClosingStatus

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

[JsonIgnore]
public TicketCategoryClosingStatus? MsgClosingStatus { get; set; }

Property Value

TicketCategoryClosingStatus?

MsgClosingStatus_String

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

[JsonProperty("MsgClosingStatus")]
public string MsgClosingStatus_String { get; set; }

Property Value

string

Name

The (short) name of this category. E.g. 'support'.

public virtual string Name { get; set; }

Property Value

string

NotificationEmail

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

public virtual string NotificationEmail { get; set; }

Property Value

string

ParentId

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

public virtual int ParentId { get; set; }

Property Value

int

ReplyTemplate

Reply template to merge with messages posted in this category

public virtual int ReplyTemplate { get; set; }

Property Value

int

TicketCategoryId

The id of the ticket category. (primary key)

public virtual int TicketCategoryId { get; set; }

Property Value

int

​Class TicketCategoryEntity

​Inheritance

​Inherited Members

​Examples

​Constructors

​TicketCategoryEntity()

​Properties

​AssignmentLag

​Property Value

​CategoryMaster

​Property Value

​ClosingStatus

​Property Value

​See Also

​ClosingStatus_String

​Property Value

​See Also

​CustomFields

​Property Value

​Remarks

​DefaultMessageStatus

​Property Value

​DefaultTicketStatus

​Property Value

​DelegateMethod

​Property Value

​See Also

​DelegateMethod_String

​Property Value

​See Also

​EffectiveReplyTemplateId

​Property Value

​ExternalName

​Property Value

​ExtraFields

​Property Value

​Remarks

​Flags

​Property Value

​See Also

​Flags_String

​Property Value

​See Also

​Fullname

​Property Value

​MsgClosingStatus

​Property Value

​See Also

​MsgClosingStatus_String

​Property Value

​See Also

​Name

​Property Value

​NotificationEmail

​Property Value

​ParentId

​Property Value

​ReplyTemplate

​Property Value

​TicketCategoryId

​Property Value

​See Also

Class TicketCategoryEntity

Inheritance

Inherited Members

Examples

Constructors

TicketCategoryEntity()

Properties

AssignmentLag

Property Value

CategoryMaster

Property Value

ClosingStatus

Property Value

See Also

ClosingStatus_String

Property Value

See Also

CustomFields

Property Value

Remarks

DefaultMessageStatus

Property Value

DefaultTicketStatus

Property Value

DelegateMethod

Property Value

See Also

DelegateMethod_String

Property Value

See Also

EffectiveReplyTemplateId

Property Value

ExternalName

Property Value

ExtraFields

Property Value

Remarks

Flags

Property Value

See Also

Flags_String

Property Value

See Also

Fullname

Property Value

MsgClosingStatus

Property Value

See Also

MsgClosingStatus_String

Property Value

See Also

Name

Property Value

NotificationEmail

Property Value

ParentId

Property Value

ReplyTemplate

Property Value

TicketCategoryId

Property Value

See Also