Show / Hide Table of Contents

Class TicketEntity

The ticket entity is used for representing a service ticket

Carrier object for TicketEntity. Services for the TicketEntity Carrier is available from the ITicketAgent.
Inheritance
Object
TicketEntity
Implements
IExtraFieldCarrier
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class TicketEntity : Carrier, IExtraFieldCarrier
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );

Constructors

TicketEntity()

Default constructor

Declaration
public TicketEntity()
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Properties

Activate

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

Declaration
public virtual DateTime Activate { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ActiveStatusMonitorId

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

Declaration
public virtual int ActiveStatusMonitorId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

AlertLevel

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

Declaration
public virtual short AlertLevel { get; set; }
Property Value
Type Description
Int16
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

AlertTimeout

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

Declaration
public virtual DateTime AlertTimeout { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Author

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

Declaration
public virtual string Author { get; set; }
Property Value
Type Description
String
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

BaseStatus

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

Use MDO List name "ticketstatus" to get list items.

Declaration
public virtual TicketBaseStatus BaseStatus { get; set; }
Property Value
Type Description
TicketBaseStatus
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Category

The ticket category entity which this ticket is connected to

Use MDO List name "ejcategory" to get list items.

Declaration
public virtual TicketCategoryEntity Category { get; set; }
Property Value
Type Description
TicketCategoryEntity
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ClosedAt

When the ticket was closed.

Declaration
public virtual DateTime ClosedAt { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ConnectId

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

Declaration
public virtual int ConnectId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedAt

When the ticket was created.

Declaration
public virtual DateTime CreatedAt { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedBy

The associate who created this ticket

Declaration
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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 ExtraFields and UserDefinedFields properties are deprecated in favor of this combined collection.

Declaration
public StringDictionary CustomFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Extra field data [Extra field name]

Example:
'x_gorp' = '[I:123]'
User defined field data [Prog-id name]

Example:
'SuperOffice:1' = '[I:123]'

Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Deadline

Deadline for ticket.

Declaration
public virtual DateTime Deadline { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ExtraFields

Deprecated: Use CustomFields instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Declaration
public StringDictionary ExtraFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Plug-in data [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType
Foreign key data 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
User defined table data [Table name].[Field name] Example: Phunneling.AggregatedSales
Other 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).
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

FirstReadByOwner

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

Declaration
public virtual DateTime FirstReadByOwner { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

FirstReadByUser

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

Declaration
public virtual DateTime FirstReadByUser { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

FormSubmission

The form submission that this ticket is connected to

Declaration
public virtual TicketFormSubmission FormSubmission { get; set; }
Property Value
Type Description
TicketFormSubmission
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

FromAddress

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

Declaration
public virtual string FromAddress { get; set; }
Property Value
Type Description
String
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

HasAttachment

Boolean indicating if this ticket has one or more attachments.

Declaration
public virtual bool HasAttachment { get; set; }
Property Value
Type Description
Boolean
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

IconHint

Icon representing ticket's state

Declaration
public virtual string IconHint { get; set; }
Property Value
Type Description
String
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Language

The language of the first external message

Declaration
public virtual string Language { get; set; }
Property Value
Type Description
String
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

LastChanged

The last time the ticket was modified.

Declaration
public virtual DateTime LastChanged { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Messages

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

Declaration
public virtual TicketMessage[] Messages { get; set; }
Property Value
Type Description
TicketMessage[]
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

NumMessages

The total number of messages for this request.

Declaration
public virtual int NumMessages { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

NumReplies

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

Declaration
public virtual int NumReplies { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

OrigHumanCategoryId

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

Declaration
public virtual int OrigHumanCategoryId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Origin

What is the origin of this ticket

Declaration
public virtual TicketOrigin Origin { get; set; }
Property Value
Type Description
TicketOrigin
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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.

Use MDO List name "associate" to get list items.

Declaration
public virtual Associate OwnedBy { get; set; }
Property Value
Type Description
Associate
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Person

The primary person that this ticket is connected to

Use MDO List name "person_new" to get list items.

Declaration
public virtual Person Person { get; set; }
Property Value
Type Description
Person
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Priority

The ticket priority entity which this ticket is connected to

Use MDO List name "ticketpriority" to get list items.

Declaration
public virtual TicketPriorityEntity Priority { get; set; }
Property Value
Type Description
TicketPriorityEntity
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Project

The project that this ticket is connected to

Use MDO List name "project" to get list items.

Declaration
public virtual Project Project { get; set; }
Property Value
Type Description
Project
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ReadByCustomer

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

Declaration
public virtual DateTime ReadByCustomer { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ReadByOwner

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

Declaration
public virtual DateTime ReadByOwner { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ReadStatus

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

Declaration
public virtual TicketReadStatus ReadStatus { get; set; }
Property Value
Type Description
TicketReadStatus
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RealTimeSpentExternally

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

Declaration
public virtual int RealTimeSpentExternally { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RealTimeSpentInternally

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

Declaration
public virtual int RealTimeSpentInternally { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RealTimeSpentQueue

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

Declaration
public virtual int RealTimeSpentQueue { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RealTimeToClose

Same as time_to_close, but not calculated based on priority.

Declaration
public virtual int RealTimeToClose { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RealTimeToReply

Same as time_to_reply, but not calculated based on priority.

Declaration
public virtual int RealTimeToReply { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RepliedAt

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

Declaration
public virtual DateTime RepliedAt { get; set; }
Property Value
Type Description
DateTime
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Sale

The sale that this ticket is connected to

Use MDO List name "sale" to get list items.

Declaration
public virtual Sale Sale { get; set; }
Property Value
Type Description
Sale
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SecondaryPersons

The secondary persons this ticket is connected to

Use MDO List name "person_new" to get list items.

Declaration
public virtual Person[] SecondaryPersons { get; set; }
Property Value
Type Description
Person[]
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Sentiment

The sentiment index of the last external message

Declaration
public virtual int Sentiment { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SentimentConfidence

The sentiment confidence of the last external message

Declaration
public virtual int SentimentConfidence { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Slevel

The securitylevel of the ticket.

Declaration
public virtual TicketSecurityLevel Slevel { get; set; }
Property Value
Type Description
TicketSecurityLevel
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Status

The ticket status entity which this ticket is connected to

Use MDO List name "ticketstatus" to get list items.

Declaration
public virtual TicketStatusEntity Status { get; set; }
Property Value
Type Description
TicketStatusEntity
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SuggestedCategoryId

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

Declaration
public virtual int SuggestedCategoryId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SuggestedCategoryName

Suggested category from AI

Declaration
public virtual string SuggestedCategoryName { get; set; }
Property Value
Type Description
String
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Tags

An array containing the tags assigned to this request

Declaration
public virtual Tag[] Tags { get; set; }
Property Value
Type Description
Tag[]
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

TicketId

The primary key (auto-incremented)

Declaration
public virtual int TicketId { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

TicketType

Type of the Request

Use MDO List name "TicketType" to get list items.

Declaration
public virtual TicketType TicketType { get; set; }
Property Value
Type Description
TicketType
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

TimeSpent

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

Declaration
public virtual int TimeSpent { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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
public virtual int TimeSpentExternally { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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
public virtual int TimeSpentInternally { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

TimeSpentQueue

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

Declaration
public virtual int TimeSpentQueue { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

TimeToClose

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

Declaration
public virtual int TimeToClose { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

TimeToReply

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

Declaration
public virtual int TimeToReply { get; set; }
Property Value
Type Description
Int32
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Title

The title of the ticket.

Declaration
public virtual string Title { get; set; }
Property Value
Type Description
String
Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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.

Examples

Get TicketEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all TicketEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ticket", "...", null, "getAllRows eq 1", null, 0, 100 );
var messages = archive.GetArchiveListByColumns2("TicketMessage", "...", null, "ticketId eq 123", null, 0, 100 );
See Also
TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Implements

IExtraFieldCarrier

See Also

TicketAgent
ITicketAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top