Class Ticket

The ticket carrier is used for representing a service request.

Carrier object for Ticket. Services for the Ticket Carrier is available from the Ticket Agent.
Inheritance
object
Ticket
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class Ticket : Carrier
Examples

Get Ticket 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new TicketAgent();
   var ticket = agent.GetTicket( 123 );
}

Constructors

Ticket()

Default constructor

Declaration
public Ticket()
See Also

Properties

Activate

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

Declaration
[DataMember]
public virtual DateTime Activate { get; set; }
Property Value
Type Description
DateTime
See Also

AlertLevel

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

Declaration
[DataMember]
public virtual short AlertLevel { get; set; }
Property Value
Type Description
short
See Also

AlertTimeout

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

Declaration
[DataMember]
public virtual DateTime AlertTimeout { get; set; }
Property Value
Type Description
DateTime
See Also

Author

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

Declaration
[DataMember]
public virtual string Author { get; set; }
Property Value
Type Description
string
See Also

BaseStatus

The status of the ticket. I.e. active/closed/postponed/deleted

Declaration
[DataMember]
public virtual TicketBaseStatus BaseStatus { get; set; }
Property Value
Type Description
TicketBaseStatus
See Also

Category

The id of the category a ticket is in.

Declaration
[DataMember]
public virtual int Category { get; set; }
Property Value
Type Description
int
See Also

CategoryFullname

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

Declaration
[DataMember]
public virtual string CategoryFullname { get; set; }
Property Value
Type Description
string
See Also

CategoryName

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

Declaration
[DataMember]
public virtual string CategoryName { get; set; }
Property Value
Type Description
string
See Also

ClosedAt

When the ticket was closed.

Declaration
[DataMember]
public virtual DateTime ClosedAt { get; set; }
Property Value
Type Description
DateTime
See Also

ConnectId

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

Declaration
[DataMember]
public virtual int ConnectId { get; set; }
Property Value
Type Description
int
See Also

ContactId

The company of the person in the cust_id field, if that person belongs to a company

Declaration
[DataMember]
public virtual int ContactId { get; set; }
Property Value
Type Description
int
See Also

ContactName

The name of the connected contact

Declaration
[DataMember]
public virtual string ContactName { get; set; }
Property Value
Type Description
string
See Also

CreatedAt

When the ticket was created.

Declaration
[DataMember]
public virtual DateTime CreatedAt { get; set; }
Property Value
Type Description
DateTime
See Also

CreatedBy

The id of the user who created the ticket. 1 (system user) if the ticket was created externally

Declaration
[DataMember]
public virtual int CreatedBy { get; set; }
Property Value
Type Description
int
See Also

CreatedByName

Initials, also login name, possibly database user name

Declaration
[DataMember]
public virtual string CreatedByName { get; set; }
Property Value
Type Description
string
See Also

CustId

The reference to the customer. NULL or -1 if ticket is not connected to customer.

Declaration
[DataMember]
public virtual int CustId { get; set; }
Property Value
Type Description
int
See Also

Deadline

Deadline for ticket.

Declaration
[DataMember]
public virtual DateTime Deadline { get; set; }
Property Value
Type Description
DateTime
See Also

FirstReadByUser

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

Declaration
[DataMember]
public virtual DateTime FirstReadByUser { get; set; }
Property Value
Type Description
DateTime
See Also

FormSubmissionId

If this ticket was created from a form submission, this field will point to that record

Declaration
[DataMember]
public virtual int FormSubmissionId { get; set; }
Property Value
Type Description
int
See Also

FromAddress

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

Declaration
[DataMember]
public virtual string FromAddress { get; set; }
Property Value
Type Description
string
See Also

HasAttachment

Boolean indicating if this ticket has one or more attachments.

Declaration
[DataMember]
public virtual bool HasAttachment { get; set; }
Property Value
Type Description
bool
See Also

Language

The language of the first external message

Declaration
[DataMember]
public virtual string Language { get; set; }
Property Value
Type Description
string
See Also

LastChanged

The last time the ticket was modified.

Declaration
[DataMember]
public virtual DateTime LastChanged { get; set; }
Property Value
Type Description
DateTime
See Also

NumMessages

The total number of messages for this request.

Declaration
[DataMember]
public virtual int NumMessages { get; set; }
Property Value
Type Description
int
See Also

NumReplies

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

Declaration
[DataMember]
public virtual int NumReplies { get; set; }
Property Value
Type Description
int
See Also

Origin

What is the origin of this ticket

Declaration
[DataMember]
public virtual TicketOrigin Origin { get; set; }
Property Value
Type Description
TicketOrigin
See Also

OwnedBy

The id of the user who owns the ticket. 1 (system user) if the ticket is unassigned.

Declaration
[DataMember]
public virtual int OwnedBy { get; set; }
Property Value
Type Description
int
See Also

OwnedByAssociateId

The associate id of the owner of the ticket.

Declaration
[DataMember]
public virtual int OwnedByAssociateId { get; set; }
Property Value
Type Description
int
See Also

OwnedByName

Initials, also login name, possibly database user name

Declaration
[DataMember]
public virtual string OwnedByName { get; set; }
Property Value
Type Description
string
See Also

PersonFirstname

First name

Declaration
[DataMember]
public virtual string PersonFirstname { get; set; }
Property Value
Type Description
string
See Also

PersonFullname

Get the full name for the primary person (customer)

Declaration
[DataMember]
public virtual string PersonFullname { get; set; }
Property Value
Type Description
string
See Also

PersonLastname

Last name

Declaration
[DataMember]
public virtual string PersonLastname { get; set; }
Property Value
Type Description
string
See Also

PersonMiddleName

Middle name or 'van' etc.

Declaration
[DataMember]
public virtual string PersonMiddleName { get; set; }
Property Value
Type Description
string
See Also

Priority

The reference to the ticket_priority table.

Declaration
[DataMember]
public virtual int Priority { get; set; }
Property Value
Type Description
int
See Also

PriorityName

The name of the priority.

Declaration
[DataMember]
public virtual string PriorityName { get; set; }
Property Value
Type Description
string
See Also

ProjectId

Reference to project table

Declaration
[DataMember]
public virtual int ProjectId { get; set; }
Property Value
Type Description
int
See Also

ProjectName

The name of the connected project

Declaration
[DataMember]
public virtual string ProjectName { get; set; }
Property Value
Type Description
string
See Also

ReadByCustomer

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

Declaration
[DataMember]
public virtual DateTime ReadByCustomer { get; set; }
Property Value
Type Description
DateTime
See Also

ReadByOwner

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

Declaration
[DataMember]
public virtual DateTime ReadByOwner { get; set; }
Property Value
Type Description
DateTime
See Also

ReadStatus

Whether the owner has read the ticket or not (red, yellow, green).

Declaration
[DataMember]
public virtual TicketReadStatus ReadStatus { get; set; }
Property Value
Type Description
TicketReadStatus
See Also

RealTimeSpentExternally

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

Declaration
[DataMember]
public virtual int RealTimeSpentExternally { get; set; }
Property Value
Type Description
int
See Also

RealTimeSpentInternally

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

Declaration
[DataMember]
public virtual int RealTimeSpentInternally { get; set; }
Property Value
Type Description
int
See Also

RealTimeSpentQueue

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

Declaration
[DataMember]
public virtual int RealTimeSpentQueue { get; set; }
Property Value
Type Description
int
See Also

RealTimeToClose

Same as time_to_close, but not calculated based on priority.

Declaration
[DataMember]
public virtual int RealTimeToClose { get; set; }
Property Value
Type Description
int
See Also

RealTimeToReply

Same as time_to_reply, but not calculated based on priority.

Declaration
[DataMember]
public virtual int RealTimeToReply { get; set; }
Property Value
Type Description
int
See Also

RepliedAt

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

Declaration
[DataMember]
public virtual DateTime RepliedAt { get; set; }
Property Value
Type Description
DateTime
See Also

SaleHeading

The heading of the connected sale

Declaration
[DataMember]
public virtual string SaleHeading { get; set; }
Property Value
Type Description
string
See Also

SaleId

Reference to sale table

Declaration
[DataMember]
public virtual int SaleId { get; set; }
Property Value
Type Description
int
See Also

Sentiment

The sentiment index of the last external message

Declaration
[DataMember]
public virtual int Sentiment { get; set; }
Property Value
Type Description
int
See Also

SentimentConfidence

The sentiment confidence of the last external message

Declaration
[DataMember]
public virtual int SentimentConfidence { get; set; }
Property Value
Type Description
int
See Also

Slevel

The securitylevel of the ticket.

Declaration
[DataMember]
public virtual TicketSecurityLevel Slevel { get; set; }
Property Value
Type Description
TicketSecurityLevel
See Also

TicketId

The primary key (auto-incremented)

Declaration
[DataMember]
public virtual int TicketId { get; set; }
Property Value
Type Description
int
See Also

TicketStatus

User defined ticket status

Declaration
[DataMember]
public virtual int TicketStatus { get; set; }
Property Value
Type Description
int
See Also

TicketStatusDisplayValue

Get the display name of the ticket status.

Declaration
[DataMember]
public virtual string TicketStatusDisplayValue { get; set; }
Property Value
Type Description
string
See Also

TicketTypeId

The id of the Request Type

Declaration
[DataMember]
public virtual int TicketTypeId { get; set; }
Property Value
Type Description
int
See Also

TicketTypeName

The name of the Request Type

Declaration
[DataMember]
public virtual string TicketTypeName { get; set; }
Property Value
Type Description
string
See Also

TimeSpent

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

Declaration
[DataMember]
public virtual int TimeSpent { get; set; }
Property Value
Type Description
int
See Also

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

Declaration
[DataMember]
public virtual int TimeSpentExternally { get; set; }
Property Value
Type Description
int
See Also

TimeSpentInternally

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

Declaration
[DataMember]
public virtual int TimeSpentInternally { get; set; }
Property Value
Type Description
int
See Also

TimeSpentQueue

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

Declaration
[DataMember]
public virtual int TimeSpentQueue { get; set; }
Property Value
Type Description
int
See Also

TimeToClose

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

Declaration
[DataMember]
public virtual int TimeToClose { get; set; }
Property Value
Type Description
int
See Also

TimeToReply

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

Declaration
[DataMember]
public virtual int TimeToReply { get; set; }
Property Value
Type Description
int
See Also

Title

The title of the ticket.

Declaration
[DataMember]
public virtual string Title { get; set; }
Property Value
Type Description
string
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also