Skip to main content

Class ContactEntity

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

Inheritance

objectCarrierContactEntity

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 ContactEntity 123 using the WebApi client: <pre><code class=“lang-csharp”>var configuration = new WebApiConfiguration(url); var agent = new ContactAgent(configuration); var contactEntity = agent.GetContactEntity( 123 );</code></pre>

Remarks

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

Constructors

ContactEntity()

Default constructor - defaults any enum props to 0.

Properties

The number of active erp links

Property Value

int

ActiveInterests

The number of active interests.

Property Value

int

ActiveStatusMonitorId

Active status monitor identity with the lowest rank for contact

Property Value

int

Address

Property Value

Address

Associate

The user that owns this contact. <p>Use MDO List name “associate” to get list items.</p>

Property Value

Associate

BounceEmails

Email addresses with a positive bounce counter.

Property Value

string[]

Business

The business that the contact is associated with. The GUI forces the user to enter a business type. <p>Use MDO List name “business” to get list items.</p>

Property Value

Business

Category

The category that is set on the company. The GUI forces the user to enter a category type <p>Use MDO List name “category” to get list items.</p>

Property Value

Category

ContactId

Primary key

Property Value

int

Country

The country this contact is located in. The country a contact is saved with, affects the phone number format, and the address layout. <p>Use MDO List name “country” to get list items.</p>

Property Value

Country

CreatedBy

The user that created the contact

Property Value

Associate

CreatedDate

Date registered

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.ContactEntity.ExtraFields” data-throw-if-not-resolved=“false”></xref> and <xref href=“SuperOffice.WebApi.Data.ContactEntity.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

customerlanguage

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

Deleted

If nonzero, then this contact is ‘deleted’ and should generally not be shown

Property Value

short

Department

Department

Property Value

string

Description

Description of the contact. Usually shown as a postit note.

Property Value

string

Domains

Web domains for this contact, ordered in array by rank

Property Value

string[]

Emails

The contact’s email

Property Value

EntityElement[]

ExtraFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.ContactEntity.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

The contact’s fax numbers

Property Value

EntityElement[]

GroupId

Group id of original owning associate, semantics like appnt.grp_id

Property Value

int

Interests

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

Property Value

SelectableMDOListItem[]

Kananame

Contact kana name, used in Japanese versions only

Property Value

string

Name

Contact name

Property Value

string

NoMailing

Spam filter. Indicates if this contact should retrieve advertising.

Property Value

bool

Number1

Alphanumeric user field

Property Value

string

Number2

Alphanumeric user field

Property Value

string

OrgNr

VAT number or similar

Property Value

string

Persons

The persons belonging to the contact.

Property Value

Person[]

Phones

The contact’s phone numbers

Property Value

EntityElement[]

Source

How did we get this contact? For future integration needs

Property Value

short

SupportAssociate

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

Property Value

Associate

SupportPerson

Property Value

Person

TicketPriority

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

Property Value

TicketPriority

UpdatedBy

The user that last updated the contact

Property Value

Associate

UpdatedDate

Date last updated

Property Value

DateTime

Urls

The contact’s internet adresses

Property Value

EntityElement[]

UserDefinedFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.ContactEntity.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

UtmParameters

Utm parameters when creating first person and contact, readonly field

Property Value

SavedUtmParameters

Xstop

STOP flag

Property Value

bool

See Also

ContactAgent, ArchiveAgent,