Class Ticket
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for Ticket.
The ticket carrier is used for representing a service request.
Inheritance
object ←
Carrier ←
Ticket
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 Ticket 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new TicketAgent(configuration);
var ticket = agent.GetTicket( 123 );
Constructors
Ticket()
Default constructor - defaults any enum props to 0.
Properties
Activate
When the ticket should be activated, if it is postponed.
Property Value
DateTime
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
Ticket.BaseStatus_String
BaseStatus_String
The status of the ticket. I.e. active/closed/postponed/deleted
Raw string enum value.
Property Value
string
See Also
Ticket.BaseStatus
Category
The id of the category a ticket is in.
Property Value
int
CategoryFullname
The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.
Property Value
string
CategoryName
The (short) name of this category. E.g. 'support'.
Property Value
string
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 'master' ticket.
Property Value
int
The company of the person in the cust_id field, if that person belongs to a company
Property Value
int
The name of the connected contact
Property Value
string
CreatedAt
When the ticket was created.
Property Value
DateTime
CreatedBy
The id of the user who created the ticket. 1 (system user) if the ticket was created externally
Property Value
int
CreatedByName
Initials, also login name, possibly database user name
Property Value
string
CustId
The reference to the customer. NULL or -1 if ticket is not connected to customer.
Property Value
int
Deadline
Deadline for ticket.
Property Value
DateTime
FirstReadByUser
The datetime for when the ticket first was read by a user.
Property Value
DateTime
If this ticket was created from a form submission, this field will point to that record
Property Value
int
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
Language
The language of the first external message
Property Value
string
LastChanged
The last time the ticket was modified.
Property Value
DateTime
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
Origin
What is the origin of this ticket
NULL if unknown enum value.
Property Value
TicketOrigin?
See Also
Ticket.Origin_String
Origin_String
What is the origin of this ticket
Raw string enum value.
Property Value
string
See Also
Ticket.Origin
OwnedBy
The id of the user who owns the ticket. 1 (system user) if the ticket is unassigned.
Property Value
int
OwnedByAssociateId
The associate id of the owner of the ticket.
Property Value
int
OwnedByName
Initials, also login name, possibly database user name
Property Value
string
PersonFirstname
First name
Property Value
string
PersonFullname
Get the full name for the primary person (customer)
Property Value
string
PersonLastname
Last name
Property Value
string
PersonMiddleName
Middle name or ‘van’ etc.
Property Value
string
Priority
The reference to the ticket_priority table.
Property Value
int
PriorityName
The name of the priority.
Property Value
string
ProjectId
Reference to project table
Property Value
int
ProjectName
The name of the connected project
Property Value
string
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
Ticket.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
Ticket.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
SaleHeading
The heading of the connected sale
Property Value
string
SaleId
Reference to sale table
Property Value
int
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
Ticket.Slevel_String
Slevel_String
The securitylevel of the ticket.
Raw string enum value.
Property Value
string
See Also
Ticket.Slevel
TicketId
The primary key (auto-incremented)
Property Value
int
TicketStatus
User defined ticket status
Property Value
int
TicketStatusDisplayValue
Get the display name of the ticket status.
Property Value
string
TicketTypeId
The id of the Request Type
Property Value
int
TicketTypeName
The name of the Request Type
Property Value
string
TimeSpent
The total time (minutes). Aggregated time spent from ticket'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'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's timeframe.
Property Value
int
Title
The title of the ticket.
Property Value
string
See Also
TicketAgent
