Skip to main content

Class TicketEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for TicketEntity. The ticket entity is used for representing a service ticket

Inheritance

objectCarrierTicketEntity

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 TicketEntity 123 using the WebApi client: <pre><code class=“lang-csharp”>var configuration = new WebApiConfiguration(url); var agent = new TicketAgent(configuration); var ticketEntity = agent.GetTicketEntity( 123 );</code></pre>

Remarks

Use <xref href=“SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent” data-throw-if-not-resolved=“false”></xref>: All TicketEntity: <pre><code class=“lang-csharp”>“Ticket”</code></pre> Messages: <pre><code class=“lang-csharp”>“TicketMessage”</code></pre> with restriction <pre><code class=“lang-csharp”>“ticketId eq ” + id</code></pre>.

Constructors

TicketEntity()

Default constructor - defaults any enum props to 0.

Properties

Activate

When the ticket should be activated, if it is postponed.

Property Value

DateTime

ActiveStatusMonitorId

Active status monitor identity for related contact. This is a read-only property and is ignored on Save

Property Value

int

AlertLevel

The alert level for the ticket. Matches the level value of the ticket_alert table.

Property Value

short

AlertTimeout

The datetime for when the ticket should jump to the next alert_level.

Property Value

DateTime

Author

A string representing the author of the ticket (same as author of first message).

Property Value

string

BaseStatus

The status of the ticket. I.e. active/closed/postponed/deleted NULL if unknown enum value.

Property Value

TicketBaseStatus?

See Also

TicketEntity.BaseStatus_String

BaseStatus_String

The status of the ticket. I.e. active/closed/postponed/deleted Raw string enum value.

Property Value

string

See Also

TicketEntity.BaseStatus

Category

The ticket category entity which this ticket is connected to <p>Use MDO List name “ejcategory” to get list items.</p>

Property Value

TicketCategoryEntity

ClosedAt

When the ticket was closed.

Property Value

DateTime

ConnectId

If a ticket is connected to another ticket, this field is set to the id of the &apos;master&apos; ticket.

Property Value

int

CreatedAt

When the ticket was created.

Property Value

DateTime

CreatedBy

The associate who created this ticket

Property Value

Associate

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

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>

Deadline

Deadline for ticket.

Property Value

DateTime

ExtraFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.TicketEntity.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]”.

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>

FirstReadByOwner

The datetime for when the ticket first was read by the current owner.

Property Value

DateTime

FirstReadByUser

The datetime for when the ticket first was read by a user.

Property Value

DateTime

FormSubmission

The form submission that this ticket is connected to

Property Value

TicketFormSubmission

FromAddress

The from-address used when this ticket got created, e.g. by email

Property Value

string

HasAttachment

Boolean indicating if this ticket has one or more attachments.

Property Value

bool

IconHint

Icon representing ticket’s state

Property Value

string

Language

The language of the first external message

Property Value

string

LastChanged

The last time the ticket was modified.

Property Value

DateTime

Messages

TicketMessageId,CreatedAt,SLevel and Important for all the messages connected to this ticket. For message body see the TicketMessageEntity or the TicketMessage archive.

Property Value

TicketMessage[]

NumMessages

The total number of messages for this request.

Property Value

int

NumReplies

The number of replies (messages) to the customer for this request.

Property Value

int

OrigHumanCategoryId

Will contain the category id selected by the user, when having the choice of using the suggested category or manually selecting a category

Property Value

int

Origin

What is the origin of this ticket NULL if unknown enum value.

Property Value

TicketOrigin?

See Also

TicketEntity.Origin_String

Origin_String

What is the origin of this ticket Raw string enum value.

Property Value

string

See Also

TicketEntity.Origin

OwnedBy

The associate who owns this ticket. Setting the id to 0 will make the ticket unassigned. Setting the id to 2147483647 (MaxInt) will make it automatically assigned according to the ticket category assignment rules. <p>Use MDO List name “associate” to get list items.</p>

Property Value

Associate

Person

The primary person that this ticket is connected to <p>Use MDO List name “person_new” to get list items.</p>

Property Value

Person

Priority

The ticket priority entity which this ticket is connected to <p>Use MDO List name “ticketpriority” to get list items.</p>

Property Value

TicketPriorityEntity

Project

The project that this ticket is connected to <p>Use MDO List name “project” to get list items.</p>

Property Value

Project

ReadByCustomer

The datetime for when the ticket was read by the customer.

Property Value

DateTime

ReadByOwner

The datetime for when the ticket last was read by the owner.

Property Value

DateTime

ReadStatus

Whether the owner has read the ticket or not (red, yellow, green). NULL if unknown enum value.

Property Value

TicketReadStatus?

See Also

TicketEntity.ReadStatus_String

ReadStatus_String

Whether the owner has read the ticket or not (red, yellow, green). Raw string enum value.

Property Value

string

See Also

TicketEntity.ReadStatus

RealTimeSpentExternally

The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state

Property Value

int

RealTimeSpentInternally

The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state

Property Value

int

RealTimeSpentQueue

The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state

Property Value

int

RealTimeToClose

Same as time_to_close, but not calculated based on priority.

Property Value

int

RealTimeToReply

Same as time_to_reply, but not calculated based on priority.

Property Value

int

RepliedAt

The datetime for when the ticket was replied to. I.e. the first external message added to the ticket.

Property Value

DateTime

Sale

The sale that this ticket is connected to <p>Use MDO List name “sale” to get list items.</p>

Property Value

Sale

SecondaryPersons

The secondary persons this ticket is connected to <p>Use MDO List name “person_new” to get list items.</p>

Property Value

Person[]

Sentiment

The sentiment index of the last external message

Property Value

int

SentimentConfidence

The sentiment confidence of the last external message

Property Value

int

Slevel

The securitylevel of the ticket. NULL if unknown enum value.

Property Value

TicketSecurityLevel?

See Also

TicketEntity.Slevel_String

Slevel_String

The securitylevel of the ticket. Raw string enum value.

Property Value

string

See Also

TicketEntity.Slevel

Status

The ticket status entity which this ticket is connected to <p>Use MDO List name “ticketstatus” to get list items.</p>

Property Value

TicketStatusEntity

SuggestedCategoryId

Suggestion for categorization, based on the text of the message (AI)

Property Value

int

SuggestedCategoryName

Suggested category from AI

Property Value

string

Tags

An array containing the tags assigned to this request

Property Value

Tag[]

TicketId

The primary key (auto-incremented)

Property Value

int

TicketType

Type of the Request <p>Use MDO List name “TicketType” to get list items.</p>

Property Value

TicketType

TimeSpent

The total time (minutes). Aggregated time spent from ticket&apos;s messages. Read-only for external use.

Property Value

int

TimeSpentExternally

The total time (seconds) within the priority’s office hours the ticket has been in a external waiting status (configurable), not including current state

Property Value

int

TimeSpentInternally

The total time (seconds) within the priority’s office hours the ticket has been in an open status (configurable), not including current state

Property Value

int

TimeSpentQueue

The total time (seconds) within the priority’s office hours the ticket has been in a queue status, not including current state

Property Value

int

TimeToClose

The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority&apos;s timeframe.

Property Value

int

TimeToReply

The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority&apos;s timeframe.

Property Value

int

Title

The title of the ticket.

Property Value

string

See Also

TicketAgent, ArchiveAgent,