Class PersonEntity

Inheritance

Object

PersonEntity

Implements

IEntityCarrier

IUdefFieldCarrier

IExtraFieldCarrier

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class PersonEntity : Carrier, IEntityCarrier, IUdefFieldCarrier, IExtraFieldCarrier

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

Constructors

PersonEntity()

Default constructor

Declaration

public PersonEntity()

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Properties

ActiveErpLinks

How many active ERP links are there for this person?

Declaration

public virtual int ActiveErpLinks { get; set; }

Property Value

Type	Description
Int32

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ActiveStatusMonitorId

Active status monitor identity with the lowest rank for person

Declaration

public virtual int ActiveStatusMonitorId { get; set; }

Property Value

Type	Description
Int32

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Address

Structure holding formatted address data. The layout of the array structure indicates the layout of the localized address.

Declaration

public virtual Address Address { get; set; }

Property Value

Type	Description
Address

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Associate

The associate owning this person (similar to contact.Associate) - usually blank. Use the Person.Contact.Associate instead. Intended for use when individual persons are created (i.e. when Person.Contact is blank)

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

Declaration

public virtual Associate Associate { get; set; }

Property Value

Type	Description
Associate

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

BirthDate

The Person birth date as UTC Date. Year 1 = Null. Year 2 = unknown year.

Declaration

public virtual DateTime BirthDate { get; set; }

Property Value

Type	Description
DateTime

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Business

Person's business - usually blank. Use Contact.Business instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)

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

Declaration

public virtual Business Business { get; set; }

Property Value

Type	Description
Business

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Category

Person's category. Usually null. Refer to the Contact.Category instead. Intended for use when individual persons are created. (i.e. when Person.Contact is blank)

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

Declaration

public virtual Category Category { get; set; }

Property Value

Type	Description
Category

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ChatEmails

Declaration

public virtual EntityElement[] ChatEmails { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Consents

The person's available consent information. Missing consents are not deleted. To remove a consent, mark its legalbase as 'WITHDRAWN'

Declaration

public virtual ConsentInfo[] Consents { get; set; }

Property Value

Type	Description
ConsentInfo[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Contact

The contact the contact person is registered on. This is required unless the 'MandatoryContactOnPerson' preference is set.

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

Declaration

public virtual Contact Contact { get; set; }

Property Value

Type	Description
Contact

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CorrespondingAssociate

The associate corresponding to this person. Will be empty if the person is not a user (internal associate user, external user).

Declaration

public virtual Associate CorrespondingAssociate { get; set; }

Property Value

Type	Description
Associate

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Country

The country this contact person is located in.

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

Declaration

public virtual Country Country { get; set; }

Property Value

Type	Description
Country

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedBy

The user that created the person object

Declaration

public virtual Associate CreatedBy { get; set; }

Property Value

Type	Description
Associate

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedByFormId

The form id of the form that created the person

Declaration

public virtual int CreatedByFormId { get; set; }

Property Value

Type	Description
Int32

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedDate

Registered date in UTC.

Declaration

public virtual DateTime CreatedDate { get; set; }

Property Value

Type	Description
DateTime

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CustomerLanguage

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

Declaration

public virtual CustomerLanguage CustomerLanguage { get; set; }

Property Value

Type	Description
CustomerLanguage

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Description

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Emails

A collection of the person's emails

Declaration

public virtual EntityElement[] Emails { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Faxes

Returns a collection of fax numbers that belong to the contact person.

Declaration

public virtual EntityElement[] Faxes { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Firstname

First name

Declaration

public virtual string Firstname { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

FormalName

Get formal name for a person, as used in labels. (Full name + person title + academic title)

Declaration

public virtual string FormalName { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

FullName

The person's full name localized to the current culture/country. (internal name used in clients for employees)

Declaration

public virtual string FullName { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Interests

The person's available and selected interests.

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

Declaration

public virtual SelectableMDOListItem[] Interests { get; set; }

Property Value

Type	Description
SelectableMDOListItem[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

InternetPhones

Declaration

public virtual EntityElement[] InternetPhones { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

IsAssociate

Checks if the person object is an associate. The property is read-only.

Declaration

public virtual bool IsAssociate { get; set; }

Property Value

Type	Description
Boolean

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Kanafname

Kana first name, used in Japanese versions only

Declaration

public virtual string Kanafname { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Kanalname

Kana last name, used in Japanese versions only

Declaration

public virtual string Kanalname { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Lastname

Last name

Declaration

public virtual string Lastname { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

MiddleName

Middle name or 'van' etc.

Declaration

public virtual string MiddleName { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

MobilePhones

Returns a collection of mobile phone numbers that belong to the contact person.

Declaration

public virtual EntityElement[] MobilePhones { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Mrmrs

e.g. Mrs sex_title

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

Declaration

public virtual string Mrmrs { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

NoMailing

Spam filter. Indicates if this person should retrieve advertising.

Declaration

public virtual bool NoMailing { get; set; }

Property Value

Type	Description
Boolean

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

OfficePhones

Returns a collection of office phone numbers that belong to the contact person.

Declaration

public virtual EntityElement[] OfficePhones { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

OtherPhones

Returns a collection of pagers that belong to the contact person.

Declaration

public virtual EntityElement[] OtherPhones { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

PersonId

Primary key

Declaration

public virtual int PersonId { get; set; }

Property Value

Type	Description
Int32

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

PersonNumber

Alphanumeric user field

Declaration

public virtual string PersonNumber { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Position

The position. This is a predefined SuperOffice value, different from Title

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

Declaration

public virtual Position Position { get; set; }

Property Value

Type	Description
Position

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Post1

Postal address, used in Japanese versions only

Declaration

public virtual string Post1 { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Post2

Postal address, used in Japanese versions only

Declaration

public virtual string Post2 { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Post3

Postal address, used in Japanese versions only

Declaration

public virtual string Post3 { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

PrivatePhones

Returns a collection of phone numbers that belong to the contact person.

Declaration

public virtual EntityElement[] PrivatePhones { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Retired

True if the user is retired and should have no rights, not appear in lists, etc.

Declaration

public virtual bool Retired { get; set; }

Property Value

Type	Description
Boolean

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Salutation

Academic title, populated from Salutation list but can be overwritten with anything at all

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

Declaration

public virtual string Salutation { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SentInfo

Has information on username/password been sent (ejournal)

Declaration

public virtual short SentInfo { get; set; }

Property Value

Type	Description
Int16

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ShipmentTypes

The person's available and selected shipment types.

Declaration

public virtual SelectableMDOListItem[] ShipmentTypes { get; set; }

Property Value

Type	Description
SelectableMDOListItem[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ShowContactTickets

Should tickets related to the company be shown to this person

Declaration

public virtual short ShowContactTickets { get; set; }

Property Value

Type	Description
Int16

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Source

How did we get this person? For future integration needs

Declaration

public virtual short Source { get; set; }

Property Value

Type	Description
Int16

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Title

Title

Declaration

public virtual string Title { get; set; }

Property Value

Type	Description
String

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedBy

The person that last updated the person object

Declaration

public virtual Associate UpdatedBy { get; set; }

Property Value

Type	Description
Associate

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedDate

Last updated date in UTC.

Declaration

public virtual DateTime UpdatedDate { get; set; }

Property Value

Type	Description
DateTime

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Urls

The urls related to this person.

Declaration

public virtual EntityElement[] Urls { get; set; }

Property Value

Type	Description
EntityElement[]

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UsePersonAddress

True if the person's address should be used as mailing address, instead of the contact's address.

Declaration

public virtual bool UsePersonAddress { get; set; }

Property Value

Type	Description
Boolean

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UserInfo

Information about the user if this person is a user. If IsAssociate (e.g. is user is true) the UserInfo will be provided.

Declaration

public virtual UserInfo UserInfo { get; set; }

Property Value

Type	Description
UserInfo

Examples

Get PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

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 PersonEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var personEntity = agent.GetPersonEntity( 123 );
 }

Find all PersonEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Person", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "personId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "personId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "personId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "person/personId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionPersonId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "personId eq 123", null, 0, 100 );

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Implements

IEntityCarrier

IUdefFieldCarrier

IExtraFieldCarrier

See Also

PersonAgent

IPersonAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)