Class ContactEntity

The Contact Service. The service implements all services working with the Contact object

Carrier object for ContactEntity. Services for the ContactEntity Carrier is available from the Contact Agent.
Inheritance
object
ContactEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class ContactEntity : Carrier, IUdefFieldCarrier, IExtraFieldCarrier, IEntityCarrier
Examples

Get ContactEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ContactAgent();
   var contactEntity = agent.GetContactEntity( 123 );
}

Find all ContactEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("SimpleContact", "...", null, "getAllRows eq 1", null, 0, 100 );
var activities = archive.GetArchiveListByColumns2("ContactActivity", "...", null, "contactId eq 123", null, 0, 100 );
var appointments = archive.GetArchiveListByColumns2("Appointment", "...", null, "contactId eq 123", null, 0, 100 );
var documents = archive.GetArchiveListByColumns2("Document", "...", null, "contactId eq 123", null, 0, 100 );
var projects = archive.GetArchiveListByColumns2("ContactProjects", "...", null, "contactId eq 123", null, 0, 100 );
var sales = archive.GetArchiveListByColumns2("SaleFilteredWithStakeholder", "...", null, "contactId eq 123", null, 0, 100 );
var persons = archive.GetArchiveListByColumns2("Person", "...", null, "contactId eq 123", null, 0, 100 );
var relations = archive.GetArchiveListByColumns2("Relation", "...", null, "source/restrictionContactId eq 123", null, 0, 100 );
var tickets = archive.GetArchiveListByColumns2("Ticket", "...", null, "contactId eq 123", null, 0, 100 );

Constructors

ContactEntity()

Default constructor

Declaration
public ContactEntity()
See Also

Properties

The number of active erp links

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 contact

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

Address

The Contact Service. The service implements all services working with the Contact object

Carrier object for ContactEntity. Services for the ContactEntity Carrier is available from the Contact Agent.
Declaration
[DataMember]
public virtual Address Address { get; set; }
Property Value
Type Description
Address
See Also

Associate

The user that owns this contact.

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

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

The business that the contact is associated with. The GUI forces the user to enter a business type.

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

The category that is set on the company. The GUI forces the user to enter a category type

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

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

ContactId

Primary key

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

Country

The country this contact is located in. The country a contact is saved with, affects the phone number format, and the address layout.

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 contact

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

CreatedDate

Date registered 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

customerlanguage

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

Deleted

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

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

Department

Department

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

Description

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

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

Domains

Web domains for this contact, ordered in array by rank

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

Emails

The contact's email

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

The contact's fax numbers

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

GroupId

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

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

Interests

The contact's available and selected interests.

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

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

Kananame

Contact kana name, used in Japanese versions only

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

Name

Contact name

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

NoMailing

Spam filter. Indicates if this contact should retrieve advertising.

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

Number1

Alphanumeric user field

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

Number2

Alphanumeric user field

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

OrgNr

VAT number or similar

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

Persons

The persons belonging to the contact.

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

Phones

The contact's phone numbers

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

Source

How did we get this contact? 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

SupportPerson

The Contact Service. The service implements all services working with the Contact object

Carrier object for ContactEntity. Services for the ContactEntity Carrier is available from the Contact Agent.
Declaration
[DataMember]
public virtual Person SupportPerson { get; set; }
Property Value
Type Description
Person
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

UpdatedBy

The user that last updated the contact

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

UpdatedDate

Date last updated in UTC.

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

Urls

The contact's internet adresses

Declaration
[DataMember]
public virtual EntityElement[] Urls { get; set; }
Property Value
Type Description
EntityElement[]
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

UtmParameters

Utm parameters when creating first person and contact, readonly field

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

Xstop

STOP flag

Declaration
[DataMember]
public virtual bool Xstop { get; set; }
Property Value
Type Description
bool
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