Show / Hide Table of Contents

Class Person

Carrier object for Person. Services for the Person Carrier is available from the IPersonAgent.

Inheritance
Object
Person
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class Person : Carrier
Examples

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

Person()

Default constructor

Declaration
public Person()
Examples

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ActiveInterests

Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

AssociateId

Id of the item's owner (Associate id)

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

AssociateName

Name of the person's owner

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

CategoryName

The category list item name

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactCountryId

The persons contact country id

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactDepartment

The persons contact department

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactFax

Actual phone number as eneterd by the user

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactFullName

Company full name + department

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactId

Owning contact ID

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactName

The persons company name

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactOrgNr

The persons contact organization number

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

ContactPhone

Returns the direct phone that belong to the persons contact.

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

CountryId

Country

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Description

Info text/description on person.

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

DirectPhone

Returns the direct phone that belong to the contact person.

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Email

First email on contact person.

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

EmailName

E-mail description

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

FaxPhone

Returns the fax phone that belong to the contact person.

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Firstname

First name

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

FullName

Get the persons full name (internal name used in clients for employees).

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Kanafname

Kana first name, used in Japanese versions only

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Kanalname

Kana last name, used in Japanese versions only

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Lastname

Last name

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

MiddleName

Middle name or 'van' etc.

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

MobilePhone

Returns the mobile phone that belong to the contact person.

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Mrmrs

e.g. Mrs sex_title

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

PersonId

Primary key

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

PersonNumber

Alphanumeric user field

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Position

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

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Post1

Postal address, used in Japanese versions only

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Post2

Postal address, used in Japanese versions only

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Post3

Postal address, used in Japanese versions only

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Rank

Display sort sequence for default sort order

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Retired

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

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

SupportAssociateId

Our support contact for this person

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

SupportLanguageId

Support priority ID

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

TicketPriorityId

Ticket priority ID

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Title

Title

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

UsePersonAddress

If 1, use person's address for mailing instead of company address

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

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

Examples

Get Person 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new PersonAgent();
    var person = agent.GetPerson( 123 );
 }
See Also
PersonAgent
IPersonAgent

See Also

PersonAgent
IPersonAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top