<a id=“SuperOffice_WebApi_Data_PersonEntity”></a> 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.

public class PersonEntity : Carrier

Inheritance

object ← Carrier ← PersonEntity

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

<a id=“SuperOffice_WebApi_Data_PersonEntity__ctor”></a> PersonEntity()

Default constructor - defaults any enum props to 0.

public PersonEntity()

Properties

<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveErpLinks”></a> ActiveErpLinks

How many active ERP links are there for this person?

public virtual int ActiveErpLinks { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveInterests”></a> ActiveInterests

The number of active interests.

public virtual int ActiveInterests { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveStatusMonitorId”></a> ActiveStatusMonitorId

Active status monitor identity with the lowest rank for person

public virtual int ActiveStatusMonitorId { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_PersonEntity_Address”></a> Address

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

public virtual Address Address { get; set; }

Property Value

Address

<a id=“SuperOffice_WebApi_Data_PersonEntity_Associate”></a> 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>

public virtual Associate Associate { get; set; }

Property Value

Associate

<a id=“SuperOffice_WebApi_Data_PersonEntity_BirthDate”></a> BirthDate

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

public virtual DateTime BirthDate { get; set; }

Property Value

DateTime

<a id=“SuperOffice_WebApi_Data_PersonEntity_BounceEmails”></a> BounceEmails

Email addresses with a positive bounce counter.

public virtual string[] BounceEmails { get; set; }

Property Value

string[]

<a id=“SuperOffice_WebApi_Data_PersonEntity_Business”></a> 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>

public virtual Business Business { get; set; }

Property Value

Business

<a id=“SuperOffice_WebApi_Data_PersonEntity_Category”></a> 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>

public virtual Category Category { get; set; }

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_ChatEmails”></a> ChatEmails

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

Property Value

EntityElement[]

<a id=“SuperOffice_WebApi_Data_PersonEntity_Consents”></a> Consents

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

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

Property Value

ConsentInfo[]

<a id=“SuperOffice_WebApi_Data_PersonEntity_Contact”></a> 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>

public virtual Contact Contact { get; set; }

Property Value

Contact

<a id=“SuperOffice_WebApi_Data_PersonEntity_CorrespondingAssociate”></a> CorrespondingAssociate

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

public virtual Associate CorrespondingAssociate { get; set; }

Property Value

Associate

<a id=“SuperOffice_WebApi_Data_PersonEntity_Country”></a> Country

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

public virtual Country Country { get; set; }

Property Value

Country

<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedBy”></a> CreatedBy

The user that created the person object

public virtual Associate CreatedBy { get; set; }

Property Value

Associate

<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedByFormId”></a> CreatedByFormId

The form id of the form that created the person

public virtual int CreatedByFormId { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedDate”></a> CreatedDate

Registered date

public virtual DateTime CreatedDate { get; set; }

Property Value

DateTime

<a id=“SuperOffice_WebApi_Data_PersonEntity_CustomFields”></a> 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]”.

public virtual StringDictionary CustomFields { get; set; }

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>

<a id=“SuperOffice_WebApi_Data_PersonEntity_CustomerLanguage”></a> CustomerLanguage

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

public virtual CustomerLanguage CustomerLanguage { get; set; }

Property Value

CustomerLanguage

<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiAgentId”></a> DbiAgentId

Integration agent (eJournal)

public virtual int DbiAgentId { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiKey”></a> DbiKey

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

public virtual string DbiKey { get; set; }

​<a id=“SuperOffice_WebApi_Data_PersonEntity”></a> Class PersonEntity

​Inheritance

​Inherited Members

​Examples

​Remarks

​Constructors

​<a id=“SuperOffice_WebApi_Data_PersonEntity__ctor”></a> PersonEntity()

​Properties

​<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveErpLinks”></a> ActiveErpLinks

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveInterests”></a> ActiveInterests

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveStatusMonitorId”></a> ActiveStatusMonitorId

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Address”></a> Address

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Associate”></a> Associate

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_BirthDate”></a> BirthDate

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_BounceEmails”></a> BounceEmails

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Business”></a> Business

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Category”></a> Category

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_ChatEmails”></a> ChatEmails

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Consents”></a> Consents

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Contact”></a> Contact

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_CorrespondingAssociate”></a> CorrespondingAssociate

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Country”></a> Country

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedBy”></a> CreatedBy

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedByFormId”></a> CreatedByFormId

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedDate”></a> CreatedDate

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_CustomFields”></a> CustomFields

​Property Value

​Remarks

​<a id=“SuperOffice_WebApi_Data_PersonEntity_CustomerLanguage”></a> CustomerLanguage

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiAgentId”></a> DbiAgentId

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiKey”></a> DbiKey

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiLastModified”></a> DbiLastModified

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiLastSyncronized”></a> DbiLastSyncronized

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Description”></a> Description

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Emails”></a> Emails

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_ExtraFields”></a> ExtraFields

​Property Value

​Remarks

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Faxes”></a> Faxes

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Firstname”></a> Firstname

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_FormalName”></a> FormalName

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_FullName”></a> FullName

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Interests”></a> Interests

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_InternetPhones”></a> InternetPhones

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_IsAssociate”></a> IsAssociate

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Kanafname”></a> Kanafname

​Property Value

​<a id=“SuperOffice_WebApi_Data_PersonEntity_Kanalname”></a> Kanalname

​Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity”></a> Class PersonEntity

Inheritance

Inherited Members

Examples

Remarks

Constructors

<a id=“SuperOffice_WebApi_Data_PersonEntity__ctor”></a> PersonEntity()

Properties

<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveErpLinks”></a> ActiveErpLinks

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveInterests”></a> ActiveInterests

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_ActiveStatusMonitorId”></a> ActiveStatusMonitorId

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Address”></a> Address

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Associate”></a> Associate

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_BirthDate”></a> BirthDate

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_BounceEmails”></a> BounceEmails

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Business”></a> Business

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Category”></a> Category

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_ChatEmails”></a> ChatEmails

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Consents”></a> Consents

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Contact”></a> Contact

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_CorrespondingAssociate”></a> CorrespondingAssociate

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Country”></a> Country

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedBy”></a> CreatedBy

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedByFormId”></a> CreatedByFormId

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_CreatedDate”></a> CreatedDate

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_CustomFields”></a> CustomFields

Property Value

Remarks

<a id=“SuperOffice_WebApi_Data_PersonEntity_CustomerLanguage”></a> CustomerLanguage

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiAgentId”></a> DbiAgentId

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiKey”></a> DbiKey

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiLastModified”></a> DbiLastModified

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_DbiLastSyncronized”></a> DbiLastSyncronized

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Description”></a> Description

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Emails”></a> Emails

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_ExtraFields”></a> ExtraFields

Property Value

Remarks

<a id=“SuperOffice_WebApi_Data_PersonEntity_Faxes”></a> Faxes

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Firstname”></a> Firstname

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_FormalName”></a> FormalName

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_FullName”></a> FullName

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Interests”></a> Interests

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_InternetPhones”></a> InternetPhones

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_IsAssociate”></a> IsAssociate

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Kanafname”></a> Kanafname

Property Value

<a id=“SuperOffice_WebApi_Data_PersonEntity_Kanalname”></a> Kanalname

Property Value