Class Associate

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

Inheritance
object
Associate
Implements
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class Associate : Carrier, IExtraFieldCarrier
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()
See Also

Properties

AssociateId

Primary key

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

Deleted

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

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

EjUserId

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

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

FormalName

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

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

FullName

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

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

GroupIdx

Primary group membership, see UserGroupLink for secondary memberships

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

Name

Initials, also login name, possibly database user name

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

PersonId

Owning person record

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

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

Rank

Rank order

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

Tooltip

Tooltip or other description

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

Type

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

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

UserName

User name

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