Skip to main content

Class PersonEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for PersonEntity. The Person Service. The service implements all services working with the Person object.

Inheritance

objectCarrierPersonEntity

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get PersonEntity 123 using the WebApi client: <pre><code class=“lang-csharp”>var configuration = new WebApiConfiguration(url); var agent = new PersonAgent(configuration); var personEntity = agent.GetPersonEntity( 123 );</code></pre>

Remarks

Use <xref href=“SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent” data-throw-if-not-resolved=“false”></xref>: All PersonEntity: <pre><code class=“lang-csharp”>“Person”</code></pre> Activities: <pre><code class=“lang-csharp”>“ContactActivity”</code></pre> with restriction <pre><code class=“lang-csharp”>“personId eq ” + id</code></pre>. Appointments: <pre><code class=“lang-csharp”>“Appointment”</code></pre> with restriction <pre><code class=“lang-csharp”>“personId eq ” + id</code></pre>. Documents: <pre><code class=“lang-csharp”>“Document”</code></pre> with restriction <pre><code class=“lang-csharp”>“personId eq ” + id</code></pre>. Sales: <pre><code class=“lang-csharp”>“SaleFilteredWithStakeholder”</code></pre> with restriction <pre><code class=“lang-csharp”>“person/personId eq ” + id</code></pre>. Relations: <pre><code class=“lang-csharp”>“Relation”</code></pre> with restriction <pre><code class=“lang-csharp”>“source/restrictionPersonId eq ” + id</code></pre>. Tickets: <pre><code class=“lang-csharp”>“Ticket”</code></pre> with restriction <pre><code class=“lang-csharp”>“personId eq ” + id</code></pre>.

Constructors

PersonEntity()

Default constructor - defaults any enum props to 0.

Properties

How many active ERP links are there for this person?

Property Value

int

ActiveInterests

The number of active interests.

Property Value

int

ActiveStatusMonitorId

Active status monitor identity with the lowest rank for person

Property Value

int

Address

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

Property Value

Address

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) <p>Use MDO List name “associate” to get list items.</p>

Property Value

Associate

BirthDate

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

Property Value

DateTime

BounceEmails

Email addresses with a positive bounce counter.

Property Value

string[]

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) <p>Use MDO List name “business” to get list items.</p>

Property Value

Business

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) <p>Use MDO List name “category” to get list items.</p>

Property Value

Category

ChatEmails

Property Value

EntityElement[]

Consents

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

Property Value

ConsentInfo[]

Contact

The contact the contact person is registered on. This is required unless the ‘MandatoryContactOnPerson’ preference is set. <p>Use MDO List name “contact_new” to get list items.</p>

Property Value

Contact

CorrespondingAssociate

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

Property Value

Associate

Country

The country this contact person is located in. <p>Use MDO List name “country” to get list items.</p>

Property Value

Country

CreatedBy

The user that created the person object

Property Value

Associate

CreatedByFormId

The form id of the form that created the person

Property Value

int

CreatedDate

Registered date

Property Value

DateTime

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 <xref href=“SuperOffice.WebApi.Data.PersonEntity.ExtraFields” data-throw-if-not-resolved=“false”></xref> and <xref href=“SuperOffice.WebApi.Data.PersonEntity.UserDefinedFields?text=UserDefinedFields” data-throw-if-not-resolved=“false”></xref> properties are deprecated in favor of this combined collection. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Extra field data</td><td class=“description”> [Extra field name]<p></p> Example: <pre><code class=“lang-csharp”>‘x_gorp’ = ‘[I:123]’</code></pre> </td></tr><tr><td class=“term”>User defined field data</td><td class=“description”> [Prog-id name]<p></p> Example: <pre><code class=“lang-csharp”>‘SuperOffice:1’ = ‘[I:123]’</code></pre><p></p> </td></tr></tbody></table>

CustomerLanguage

<p>Use MDO List name “customerlanguage” to get list items.</p>

Property Value

CustomerLanguage

DbiAgentId

Integration agent (eJournal)

Property Value

int

DbiKey

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

Property Value

string

DbiLastModified

When the entry was last modified.

Property Value

DateTime

DbiLastSyncronized

Last external syncronization.

Property Value

DateTime

Description

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

Property Value

string

Emails

A collection of the person’s emails

Property Value

EntityElement[]

ExtraFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.PersonEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Plug-in data</td><td class=“description”> [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType </td></tr><tr><td class=“term”>Foreign key data</td><td class=“description”> 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 </td></tr><tr><td class=“term”>User defined table data</td><td class=“description”> [Table name].[Field name] Example: Phunneling.AggregatedSales </td></tr><tr><td class=“term”>Other</td><td class=“description”> 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). </td></tr></tbody></table>

Faxes

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

Property Value

EntityElement[]

Firstname

First name

Property Value

string

FormalName

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

Property Value

string

FullName

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

Property Value

string

Interests

The person’s available and selected interests. <p>Use MDO List name “persint” to get list items.</p>

Property Value

SelectableMDOListItem[]

InternetPhones

Property Value

EntityElement[]

IsAssociate

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

Property Value

bool

Kanafname

Kana first name, used in Japanese versions only

Property Value

string

Kanalname

Kana last name, used in Japanese versions only

Property Value

string

Lastname

Last name

Property Value

string

Leadstatus

Name of leadstatus

Property Value

string

LeadstatusId

Refinement of categories of lead type. Empty if the category is not a lead type.

Property Value

int

MiddleName

Middle name or ‘van’ etc.

Property Value

string

MobilePhones

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

Property Value

EntityElement[]

Mrmrs

e.g. Mrs sex_title <p>Use MDO List name “mrmrs” to get list items.</p>

Property Value

string

NoMailing

Spam filter. Indicates if this person should retrieve advertising.

Property Value

bool

OfficePhones

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

Property Value

EntityElement[]

OtherPhones

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

Property Value

EntityElement[]

PersonId

Primary key

Property Value

int

PersonNumber

Alphanumeric user field

Property Value

string

Position

The position. This is a predefined SuperOffice value, different from Title <p>Use MDO List name “perspos” to get list items.</p>

Property Value

Position

Post1

Postal address, used in Japanese versions only

Property Value

string

Post2

Postal address, used in Japanese versions only

Property Value

string

Post3

Postal address, used in Japanese versions only

Property Value

string

PrivatePhones

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

Property Value

EntityElement[]

Retired

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

Property Value

bool

Salutation

Academic title, populated from Salutation list but can be overwritten with anything at all <p>Use MDO List name “salutation” to get list items.</p>

Property Value

string

SentInfo

Has information on username/password been sent (ejournal)

Property Value

short

ShipmentTypes

The person’s available and selected shipment types.

Property Value

SelectableMDOListItem[]

ShowContactTickets

Should tickets related to the company be shown to this person

Property Value

short

Source

How did we get this person? For future integration needs

Property Value

short

SupportAssociate

<p>Use MDO List name “associate” to get list items.</p>

Property Value

Associate

TicketPriority

<p>Use MDO List name “ticketpriority” to get list items.</p>

Property Value

TicketPriority

Title

Title

Property Value

string

UpdatedBy

The person that last updated the person object

Property Value

Associate

UpdatedDate

Last updated date

Property Value

DateTime

Urls

The urls related to this person.

Property Value

EntityElement[]

UsePersonAddress

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

Property Value

bool

UserDefinedFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.PersonEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> 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” The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

Property Value

StringDictionary

UserInfo

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

Property Value

UserInfo

UtmParameters

Utm parameters when creating this person, readonly fields

Property Value

SavedUtmParameters

See Also

PersonAgent, ArchiveAgent,