Class Associate

Carrier object for Associate. Services for the Associate Carrier is available from the IAssociateAgent.

Inheritance
Object
Associate
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class Associate : Carrier
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }

Constructors

Associate()

Default constructor

Declaration
public Associate()
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

Properties

AssociateId

Primary key

Declaration
public virtual int AssociateId { get; set; }
Property Value
Type Description
Int32
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

Deleted

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

Declaration
public virtual bool Deleted { get; set; }
Property Value
Type Description
Boolean
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

EjUserId

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users

Declaration
public virtual int EjUserId { get; set; }
Property Value
Type Description
Int32
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

FormalName

The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs)

Declaration
public virtual string FormalName { get; set; }
Property Value
Type Description
String
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

FullName

The associate's culture formatted fullname (firstname, middleName and lastname)

Declaration
public virtual string FullName { get; set; }
Property Value
Type Description
String
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

GroupIdx

Primary group membership, see UserGroupLink for secondary memberships

Declaration
public virtual int GroupIdx { get; set; }
Property Value
Type Description
Int32
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

Name

Initials, also login name, possibly database user name

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

PersonId

Owning person record

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

Declaration
public virtual int PersonId { get; set; }
Property Value
Type Description
Int32
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

Rank

Rank order

Declaration
public virtual short Rank { get; set; }
Property Value
Type Description
Int16
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

Tooltip

Tooltip or other description

Declaration
public virtual string Tooltip { get; set; }
Property Value
Type Description
String
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

Type

User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system

Declaration
public virtual UserType Type { get; set; }
Property Value
Type Description
UserType
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

UserName

User name

Declaration
public virtual string UserName { get; set; }
Property Value
Type Description
String
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
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.
Examples

Get Associate 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new AssociateAgent();
    var associate = agent.GetAssociate( 123 );
 }
See Also

See Also