Show / Hide Table of Contents

Class ContactEntity

The Contact Service. The service implements all services working with the Contact object

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );

Constructors

ContactEntity()

Default constructor

Declaration
public ContactEntity()
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Properties

ActiveErpLinks

The number of active erp links

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ActiveInterests

The number of active interests.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ActiveStatusMonitorId

Active status monitor identity with the lowest rank for contact

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Address

The Contact Service. The service implements all services working with the Contact object

Carrier object for ContactEntity. Services for the ContactEntity Carrier is available from the IContactAgent.
Declaration
public virtual Address Address { get; set; }
Property Value
Type Description
Address
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Associate

The user that owns this contact.

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

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

BounceEmails

Email addresses with a positive bounce counter.

Declaration
public virtual string[] BounceEmails { get; set; }
Property Value
Type Description
String[]
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Business

The business that the contact is associated with. The GUI forces the user to enter a business type.

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

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Category

The category that is set on the company. The GUI forces the user to enter a category type

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

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ContactId

Primary key

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Country

The country this contact is located in. The country a contact is saved with, affects the phone number format, and the address layout.

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

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedBy

The user that created the contact

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedDate

Date registered in UTC.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CustomerLanguage

customerlanguage

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
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 ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DbiAgentId

Integration agent (eJournal)

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DbiKey

The primary key for the integrated entry in the external datasource.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DbiLastModified

When the entry was last modified.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DbiLastSyncronized

Last external syncronization.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Deleted

If nonzero, then this contact is 'deleted' and should generally not be shown

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Department

Department

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Description

Description of the contact. Usually shown as a postit note.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Domains

Web domains for this contact, ordered in array by rank

Declaration
public virtual string[] Domains { get; set; }
Property Value
Type Description
String[]
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Emails

The contact's email

Declaration
public virtual EntityElement[] Emails { get; set; }
Property Value
Type Description
EntityElement[]
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
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 ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Faxes

The contact's fax numbers

Declaration
public virtual EntityElement[] Faxes { get; set; }
Property Value
Type Description
EntityElement[]
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

GroupId

Group id of original owning associate, semantics like appnt.grp_id

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Interests

The contact's available and selected interests.

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

Declaration
public virtual SelectableMDOListItem[] Interests { get; set; }
Property Value
Type Description
SelectableMDOListItem[]
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Kananame

Contact kana name, used in Japanese versions only

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Name

Contact name

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

NoMailing

Spam filter. Indicates if this contact should retrieve advertising.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Number1

Alphanumeric user field

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Number2

Alphanumeric user field

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

OrgNr

VAT number or similar

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Persons

The persons belonging to the contact.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Phones

The contact's phone numbers

Declaration
public virtual EntityElement[] Phones { get; set; }
Property Value
Type Description
EntityElement[]
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Source

How did we get this contact? For future integration needs

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SupportAssociate

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

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SupportPerson

The Contact Service. The service implements all services working with the Contact object

Carrier object for ContactEntity. Services for the ContactEntity Carrier is available from the IContactAgent.
Declaration
public virtual Person SupportPerson { get; set; }
Property Value
Type Description
Person
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

TicketPriority

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

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedBy

The user that last updated the contact

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedDate

Date last updated in UTC.

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Urls

The contact's internet adresses

Declaration
public virtual EntityElement[] Urls { get; set; }
Property Value
Type Description
EntityElement[]
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UserDefinedFields

Deprecated: Use CustomFields instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

Declaration
public StringDictionary UserDefinedFields { get; set; }
Property Value
Type Description
StringDictionary
Examples

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Xstop

STOP flag

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

Get ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
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 ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
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 ContactEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ContactAgent();
    var contactEntity = agent.GetContactEntity( 123 );
 }

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );
See Also
ContactAgent
IContactAgent
ArchiveAgent
GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Implements

IUdefFieldCarrier
IExtraFieldCarrier
IEntityCarrier

See Also

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