Class ContactRelationEntity

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the IRelationAgent.

Inheritance

Object

ContactRelationEntity

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class ContactRelationEntity : Carrier

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

ContactRelationEntity()

Default constructor

Declaration

public ContactRelationEntity()

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Properties

ActiveText

Active text for the relation.

Declaration

public virtual string ActiveText { get; set; }

Property Value

Type	Description
String

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Comment

Comment for relation

Declaration

public virtual string Comment { get; set; }

Property Value

Type	Description
String

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedBy

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the IRelationAgent.

Declaration

public virtual Associate CreatedBy { get; set; }

Property Value

Type	Description
Associate

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CreatedDate

Registered when in UTC.

Declaration

public virtual DateTime CreatedDate { get; set; }

Property Value

Type	Description
DateTime

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DestinationContactId

Id of the destination contact. The value is mandatory.

Declaration

public virtual int DestinationContactId { get; set; }

Property Value

Type	Description
Int32

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DestinationContactName

Name of the destination contact.

Declaration

public virtual string DestinationContactName { get; set; }

Property Value

Type	Description
String

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DestinationPersonId

Id of the destination person. The value is not mandatory. The person must belong to the destination contact.

Declaration

public virtual int DestinationPersonId { get; set; }

Property Value

Type	Description
Int32

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

DestinationPersonName

Name of the destination person.

Declaration

public virtual string DestinationPersonName { get; set; }

Property Value

Type	Description
String

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

PassiveText

Passive text for the relation.

Declaration

public virtual string PassiveText { get; set; }

Property Value

Type	Description
String

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RelationDefinitionId

Reference to definition

Declaration

public virtual int RelationDefinitionId { get; set; }

Property Value

Type	Description
Int32

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

RelationId

Primary key

Declaration

public virtual int RelationId { get; set; }

Property Value

Type	Description
Int32

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Reversed

Is direction reversed relative to definition

Declaration

public virtual short Reversed { get; set; }

Property Value

Type	Description
Int16

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SourceContactId

Id of the source contact. The value is mandatory.

Declaration

public virtual int SourceContactId { get; set; }

Property Value

Type	Description
Int32

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SourceContactName

Name of the source contact.

Declaration

public virtual string SourceContactName { get; set; }

Property Value

Type	Description
String

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SourcePersonId

Id of the source person. The value is not mandatory. The person must belong to the source contact.

Declaration

public virtual int SourcePersonId { get; set; }

Property Value

Type	Description
Int32

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

SourcePersonName

Name of the source person.

Declaration

public virtual string SourcePersonName { get; set; }

Property Value

Type	Description
String

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedBy

Relationship between a (contact/person) and another (contact/person), as described by the RelationDefinition.

Carrier object for ContactRelationEntity. Services for the ContactRelationEntity Carrier is available from the IRelationAgent.

Declaration

public virtual Associate UpdatedBy { get; set; }

Property Value

Type	Description
Associate

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

UpdatedDate

Last updated when in UTC.

Declaration

public virtual DateTime UpdatedDate { get; set; }

Property Value

Type	Description
DateTime

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
String	The carrier contents.

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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.

Examples

Get ContactRelationEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new RelationAgent();
    var contactRelationEntity = agent.GetContactRelationEntity( 123 );
 }

Find all ContactRelationEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Relation", "...", null, "getAllRows eq 1", null, 0, 100 );

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

See Also

RelationAgent

IRelationAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)