Class Associate

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for Associate.

public class Associate : Carrier

Inheritance

object ← Carrier ← Associate

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

Constructors

Associate()

Default constructor - defaults any enum props to 0.

public Associate()

Properties

AssociateId

Primary key

public virtual int AssociateId { get; set; }

Property Value

int

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.Associate.ExtraFields” data-throw-if-not-resolved=“false”></xref> and UserDefinedFields properties are deprecated in favor of this combined collection. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary CustomFields { get; set; }

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>

Deleted

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

public virtual bool Deleted { get; set; }

Property Value

bool

EjUserId

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

public virtual int EjUserId { get; set; }

Property Value

int

ExtraFields

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

public virtual StringDictionary ExtraFields { get; set; }

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>

FormalName

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

public virtual string FormalName { get; set; }

Property Value

string

FullName

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

public virtual string FullName { get; set; }

Property Value

string

GroupIdx

Primary group membership, see UserGroupLink for secondary memberships

public virtual int GroupIdx { get; set; }

Property Value

int

Name

Initials, also login name, possibly database user name

public virtual string Name { get; set; }

Property Value

string

PersonId

Owning person record <p>Use MDO List name “person” to get list items.</p>

public virtual int PersonId { get; set; }

Property Value

int

Rank

Rank order

public virtual short Rank { get; set; }

Property Value

short Tooltip or other description

public virtual string Tooltip { get; set; }

Property Value

string

Type

User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system NULL if unknown enum value.

[JsonIgnore]
public UserType? Type { get; set; }

Property Value

UserType?

Type_String

User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system Raw string enum value.

[JsonProperty("Type")]
public string Type_String { get; set; }

Property Value

string

UserName

User name

public virtual string UserName { get; set; }

Property Value

string

​Class Associate

​Inheritance

​Inherited Members

​Examples

​Constructors

​Associate()

​Properties

​AssociateId

​Property Value

​CustomFields

​Property Value

​Remarks

​Deleted

​Property Value

​EjUserId

​Property Value

​ExtraFields

​Property Value

​Remarks

​FormalName

​Property Value

​FullName

​Property Value

​GroupIdx

​Property Value

​Name

​Property Value

​PersonId

​Property Value

​Rank

​Property Value

​Tooltip

​Property Value

​Type

​Property Value

​See Also

​Type_String

​Property Value

​See Also

​UserName

​Property Value

​See Also

Class Associate

Inheritance

Inherited Members

Examples

Constructors

Associate()

Properties

AssociateId

Property Value

CustomFields

Property Value

Remarks

Deleted

Property Value

EjUserId

Property Value

ExtraFields

Property Value

Remarks

FormalName

Property Value

FullName

Property Value

GroupIdx

Property Value

Name

Property Value

PersonId

Property Value

Rank

Property Value

Tooltip

Property Value

Type

Property Value

See Also

Type_String

Property Value

See Also

UserName

Property Value

See Also