Class PersonEntity

Inheritance
object
PersonEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.2.0.0")]
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()
See Also

Properties

How many active ERP links are there for this person?

Declaration
[DataMember]
public virtual int ActiveErpLinks { get; set; }
Property Value
Type Description
int

ActiveInterests

The number of active interests.

Declaration
[DataMember]
public virtual int ActiveInterests { get; set; }
Property Value
Type Description
int
See Also

ActiveStatusMonitorId

Active status monitor identity with the lowest rank for person

Declaration
[DataMember]
public virtual int ActiveStatusMonitorId { get; set; }
Property Value
Type Description
int
See Also

Address

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

Declaration
[DataMember]
public virtual Address Address { get; set; }
Property Value
Type Description
Address
See Also

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
[DataMember]
public virtual Associate Associate { get; set; }
Property Value
Type Description
Associate
See Also

BirthDate

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

Declaration
[DataMember]
public virtual DateTime BirthDate { get; set; }
Property Value
Type Description
DateTime
See Also

BounceEmails

Email addresses with a positive bounce counter.

Declaration
[DataMember]
public virtual string[] BounceEmails { get; set; }
Property Value
Type Description
string[]
See Also

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
[DataMember]
public virtual Business Business { get; set; }
Property Value
Type Description
Business
See Also

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
[DataMember]
public virtual Category Category { get; set; }
Property Value
Type Description
Category
See Also

ChatEmails

Declaration
[DataMember]
public virtual EntityElement[] ChatEmails { get; set; }
Property Value
Type Description
EntityElement[]
See Also

Consents

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

Declaration
[DataMember]
public virtual ConsentInfo[] Consents { get; set; }
Property Value
Type Description
ConsentInfo[]
See Also

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
[DataMember]
public virtual Contact Contact { get; set; }
Property Value
Type Description
Contact
See Also

CorrespondingAssociate

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

Declaration
[DataMember]
public virtual Associate CorrespondingAssociate { get; set; }
Property Value
Type Description
Associate
See Also

Country

The country this contact person is located in.

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

Declaration
[DataMember]
public virtual Country Country { get; set; }
Property Value
Type Description
Country
See Also

CreatedBy

The user that created the person object

Declaration
[DataMember]
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
See Also

CreatedByFormId

The form id of the form that created the person

Declaration
[DataMember]
public virtual int CreatedByFormId { get; set; }
Property Value
Type Description
int
See Also

CreatedDate

Registered date in UTC.

Declaration
[DataMember]
public virtual DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

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
[DataMember]
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]'

See Also

CustomerLanguage

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

Declaration
[DataMember]
public virtual CustomerLanguage CustomerLanguage { get; set; }
Property Value
Type Description
CustomerLanguage
See Also

DbiAgentId

Integration agent (eJournal)

Declaration
[DataMember]
public virtual int DbiAgentId { get; set; }
Property Value
Type Description
int
See Also

DbiKey

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

Declaration
[DataMember]
public virtual string DbiKey { get; set; }
Property Value
Type Description
string
See Also

DbiLastModified

When the entry was last modified.

Declaration
[DataMember]
public virtual DateTime DbiLastModified { get; set; }
Property Value
Type Description
DateTime
See Also

DbiLastSyncronized

Last external syncronization.

Declaration
[DataMember]
public virtual DateTime DbiLastSyncronized { get; set; }
Property Value
Type Description
DateTime
See Also

Description

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

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

Emails

A collection of the person's emails

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

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
[DataMember]
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).
See Also

Faxes

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

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

Firstname

First name

Declaration
[DataMember]
public virtual string Firstname { get; set; }
Property Value
Type Description
string
See Also

FormalName

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

Declaration
[DataMember]
public virtual string FormalName { get; set; }
Property Value
Type Description
string
See Also

FullName

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

Declaration
[DataMember]
public virtual string FullName { get; set; }
Property Value
Type Description
string
See Also

Interests

The person's available and selected interests.

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

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

InternetPhones

Declaration
[DataMember]
public virtual EntityElement[] InternetPhones { get; set; }
Property Value
Type Description
EntityElement[]
See Also

IsAssociate

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

Declaration
[DataMember]
public virtual bool IsAssociate { get; set; }
Property Value
Type Description
bool
See Also

Kanafname

Kana first name, used in Japanese versions only

Declaration
[DataMember]
public virtual string Kanafname { get; set; }
Property Value
Type Description
string
See Also

Kanalname

Kana last name, used in Japanese versions only

Declaration
[DataMember]
public virtual string Kanalname { get; set; }
Property Value
Type Description
string
See Also

Lastname

Last name

Declaration
[DataMember]
public virtual string Lastname { get; set; }
Property Value
Type Description
string
See Also

MiddleName

Middle name or 'van' etc.

Declaration
[DataMember]
public virtual string MiddleName { get; set; }
Property Value
Type Description
string
See Also

MobilePhones

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

Declaration
[DataMember]
public virtual EntityElement[] MobilePhones { get; set; }
Property Value
Type Description
EntityElement[]
See Also

Mrmrs

e.g. Mrs sex_title

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

Declaration
[DataMember]
public virtual string Mrmrs { get; set; }
Property Value
Type Description
string
See Also

NoMailing

Spam filter. Indicates if this person should retrieve advertising.

Declaration
[DataMember]
public virtual bool NoMailing { get; set; }
Property Value
Type Description
bool
See Also

OfficePhones

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

Declaration
[DataMember]
public virtual EntityElement[] OfficePhones { get; set; }
Property Value
Type Description
EntityElement[]
See Also

OtherPhones

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

Declaration
[DataMember]
public virtual EntityElement[] OtherPhones { get; set; }
Property Value
Type Description
EntityElement[]
See Also

PersonId

Primary key

Declaration
[DataMember]
public virtual int PersonId { get; set; }
Property Value
Type Description
int
See Also

PersonNumber

Alphanumeric user field

Declaration
[DataMember]
public virtual string PersonNumber { get; set; }
Property Value
Type Description
string
See Also

Position

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

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

Declaration
[DataMember]
public virtual Position Position { get; set; }
Property Value
Type Description
Position
See Also

Post1

Postal address, used in Japanese versions only

Declaration
[DataMember]
public virtual string Post1 { get; set; }
Property Value
Type Description
string
See Also

Post2

Postal address, used in Japanese versions only

Declaration
[DataMember]
public virtual string Post2 { get; set; }
Property Value
Type Description
string
See Also

Post3

Postal address, used in Japanese versions only

Declaration
[DataMember]
public virtual string Post3 { get; set; }
Property Value
Type Description
string
See Also

PrivatePhones

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

Declaration
[DataMember]
public virtual EntityElement[] PrivatePhones { get; set; }
Property Value
Type Description
EntityElement[]
See Also

Retired

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

Declaration
[DataMember]
public virtual bool Retired { get; set; }
Property Value
Type Description
bool
See Also

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
[DataMember]
public virtual string Salutation { get; set; }
Property Value
Type Description
string
See Also

SentInfo

Has information on username/password been sent (ejournal)

Declaration
[DataMember]
public virtual short SentInfo { get; set; }
Property Value
Type Description
short
See Also

ShipmentTypes

The person's available and selected shipment types.

Declaration
[DataMember]
public virtual SelectableMDOListItem[] ShipmentTypes { get; set; }
Property Value
Type Description
SelectableMDOListItem[]
See Also

ShowContactTickets

Should tickets related to the company be shown to this person

Declaration
[DataMember]
public virtual short ShowContactTickets { get; set; }
Property Value
Type Description
short
See Also

Source

How did we get this person? For future integration needs

Declaration
[DataMember]
public virtual short Source { get; set; }
Property Value
Type Description
short
See Also

SupportAssociate

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

Declaration
[DataMember]
public virtual Associate SupportAssociate { get; set; }
Property Value
Type Description
Associate
See Also

TicketPriority

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

Declaration
[DataMember]
public virtual TicketPriority TicketPriority { get; set; }
Property Value
Type Description
TicketPriority
See Also

Title

Title

Declaration
[DataMember]
public virtual string Title { get; set; }
Property Value
Type Description
string
See Also

UpdatedBy

The person that last updated the person object

Declaration
[DataMember]
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
See Also

UpdatedDate

Last updated date in UTC.

Declaration
[DataMember]
public virtual DateTime UpdatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

Urls

The urls related to this person.

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

UsePersonAddress

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

Declaration
[DataMember]
public virtual bool UsePersonAddress { get; set; }
Property Value
Type Description
bool
See Also

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
[DataMember]
public StringDictionary UserDefinedFields { get; set; }
Property Value
Type Description
StringDictionary
See Also

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
[DataMember]
public virtual UserInfo UserInfo { get; set; }
Property Value
Type Description
UserInfo
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

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.
See Also

Implements

See Also