<a id=“SuperOffice_WebApi_Data_User”></a> Class User

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for User. SuperOffice User, with login credentials and an associated person.

public class User : Carrier

Inheritance

object ← Carrier ← User

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

Remarks

Use <xref href=“SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent” data-throw-if-not-resolved=“false”></xref>: All User: <pre><code class=“lang-csharp”>“AllUsers”</code></pre>

Constructors

<a id=“SuperOffice_WebApi_Data_User__ctor”></a> User()

Default constructor - defaults any enum props to 0.

public User()

Properties

<a id=“SuperOffice_WebApi_Data_User_AssociateId”></a> AssociateId

Primary key

public virtual int AssociateId { get; set; }

Property Value

int

<a id=“SuperOffice_WebApi_Data_User_Credentials”></a> Credentials

List of credentials registered for this user. i.e. valid authentication methods.

public virtual Credential[] Credentials { get; set; }

Property Value

Credential[]

<a id=“SuperOffice_WebApi_Data_User_CustomFields”></a> 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.User.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>

<a id=“SuperOffice_WebApi_Data_User_Deleted”></a> 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

<a id=“SuperOffice_WebApi_Data_User_EjUserId”></a> 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

<a id=“SuperOffice_WebApi_Data_User_ExtraFields”></a> ExtraFields

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

<a id=“SuperOffice_WebApi_Data_User_IsOnTravel”></a> IsOnTravel

True if the user is on travel.

public virtual bool IsOnTravel { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_User_IsPersonRetired”></a> IsPersonRetired

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

public virtual bool IsPersonRetired { get; set; }

Property Value

bool

<a id=“SuperOffice_WebApi_Data_User_Lastlogin”></a> Lastlogin

Last login date

public virtual DateTime Lastlogin { get; set; }

Property Value

DateTime

<a id=“SuperOffice_WebApi_Data_User_Lastlogout”></a> Lastlogout

Last logout date

public virtual DateTime Lastlogout { get; set; }

Property Value

DateTime

<a id=“SuperOffice_WebApi_Data_User_LicenseOwners”></a> LicenseOwners

The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user

public virtual LicenseOwner[] LicenseOwners { get; set; }

Property Value

LicenseOwner[]

<a id=“SuperOffice_WebApi_Data_User_Name”></a> Name

Initials, UserId - also used as login name for on-site installations. Identifies user in archives.

public virtual string Name { get; set; }

Property Value

string

<a id=“SuperOffice_WebApi_Data_User_NickName”></a> NickName

The unique nick name for this user. Used in Service as an alias, similar to Name/Initials.

public virtual string NickName { get; set; }

Property Value

string

<a id=“SuperOffice_WebApi_Data_User_OtherGroups”></a> OtherGroups

The other groups this user is a member of, apart from the main user group. <p>Use MDO List name “usergroup” to get list items.</p>

public virtual UserGroup[] OtherGroups { get; set; }

Property Value

UserGroup[]

<a id=“SuperOffice_WebApi_Data_User_Person”></a> Person

The person associated with this user. Detailed information about the user <p>Use MDO List name “person_new” to get list items.</p>

public virtual Person Person { get; set; }

Property Value

Person

<a id=“SuperOffice_WebApi_Data_User_PostSaveCommands”></a> PostSaveCommands

Post custom commands the client should execute after save has completed.

public virtual CustomCommand[] PostSaveCommands { get; set; }

Property Value

CustomCommand[]

<a id=“SuperOffice_WebApi_Data_User_Rank”></a> Rank

Rank order

public virtual short Rank { get; set; }

Property Value

short

<a id=“SuperOffice_WebApi_Data_User_RequestSignature”></a> RequestSignature

ej users request signature

public virtual string RequestSignature { get; set; }

Property Value

string

<a id=“SuperOffice_WebApi_Data_User_Role”></a> Role

Users role for role-based security. Determines permissions and access rights for the user.

public virtual Role Role { get; set; }

Property Value

Role

<a id=“SuperOffice_WebApi_Data_User_TicketCategories”></a> TicketCategories

Request Ticket Categories assigned to the user. <p>Use MDO List name “ejCategory” to get list items.</p>

public virtual MDOListItem[] TicketCategories { get; set; }

Property Value

MDOListItem[] Tooltip or other description

public virtual string Tooltip { get; set; }

Property Value

string

<a id=“SuperOffice_WebApi_Data_User_Type”></a> Type

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate NULL if unknown enum value.

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

Property Value

UserType?

<a id=“SuperOffice_WebApi_Data_User_Type_String”></a> Type_String

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate Raw string enum value.

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

Property Value

string

<a id=“SuperOffice_WebApi_Data_User_UserGroup”></a> UserGroup

The main user group that this user belongs to. <p>Use MDO List name “usergroup” to get list items.</p>

public virtual UserGroup UserGroup { get; set; }

Property Value

UserGroup

<a id=“SuperOffice_WebApi_Data_User_UserName”></a> UserName

User name, a.k.a. Login name. This might be an e-mail address.

public virtual string UserName { get; set; }

Property Value

string

<a id=“SuperOffice_WebApi_Data_User_WaitingForApproval”></a> WaitingForApproval

The user is waiting for an administrator to approve/grant her/him access.

public virtual bool WaitingForApproval { get; set; }

Property Value

bool

​<a id=“SuperOffice_WebApi_Data_User”></a> Class User

​Inheritance

​Inherited Members

​Examples

​Remarks

​Constructors

​<a id=“SuperOffice_WebApi_Data_User__ctor”></a> User()

​Properties

​<a id=“SuperOffice_WebApi_Data_User_AssociateId”></a> AssociateId

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Credentials”></a> Credentials

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_CustomFields”></a> CustomFields

​Property Value

​Remarks

​<a id=“SuperOffice_WebApi_Data_User_Deleted”></a> Deleted

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_EjUserId”></a> EjUserId

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_ExtraFields”></a> ExtraFields

​Property Value

​Remarks

​<a id=“SuperOffice_WebApi_Data_User_IsOnTravel”></a> IsOnTravel

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_IsPersonRetired”></a> IsPersonRetired

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Lastlogin”></a> Lastlogin

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Lastlogout”></a> Lastlogout

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_LicenseOwners”></a> LicenseOwners

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Name”></a> Name

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_NickName”></a> NickName

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_OtherGroups”></a> OtherGroups

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Person”></a> Person

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_PostSaveCommands”></a> PostSaveCommands

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Rank”></a> Rank

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_RequestSignature”></a> RequestSignature

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Role”></a> Role

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_TicketCategories”></a> TicketCategories

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Tooltip”></a> Tooltip

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_Type”></a> Type

​Property Value

​See Also

​<a id=“SuperOffice_WebApi_Data_User_Type_String”></a> Type_String

​Property Value

​See Also

​<a id=“SuperOffice_WebApi_Data_User_UserGroup”></a> UserGroup

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_UserName”></a> UserName

​Property Value

​<a id=“SuperOffice_WebApi_Data_User_WaitingForApproval”></a> WaitingForApproval

​Property Value

​See Also

<a id=“SuperOffice_WebApi_Data_User”></a> Class User

Inheritance

Inherited Members

Examples

Remarks

Constructors

<a id=“SuperOffice_WebApi_Data_User__ctor”></a> User()

Properties

<a id=“SuperOffice_WebApi_Data_User_AssociateId”></a> AssociateId

Property Value

<a id=“SuperOffice_WebApi_Data_User_Credentials”></a> Credentials

Property Value

<a id=“SuperOffice_WebApi_Data_User_CustomFields”></a> CustomFields

Property Value

Remarks

<a id=“SuperOffice_WebApi_Data_User_Deleted”></a> Deleted

Property Value

<a id=“SuperOffice_WebApi_Data_User_EjUserId”></a> EjUserId

Property Value

<a id=“SuperOffice_WebApi_Data_User_ExtraFields”></a> ExtraFields

Property Value

Remarks

<a id=“SuperOffice_WebApi_Data_User_IsOnTravel”></a> IsOnTravel

Property Value

<a id=“SuperOffice_WebApi_Data_User_IsPersonRetired”></a> IsPersonRetired

Property Value

<a id=“SuperOffice_WebApi_Data_User_Lastlogin”></a> Lastlogin

Property Value

<a id=“SuperOffice_WebApi_Data_User_Lastlogout”></a> Lastlogout

Property Value

<a id=“SuperOffice_WebApi_Data_User_LicenseOwners”></a> LicenseOwners

Property Value

<a id=“SuperOffice_WebApi_Data_User_Name”></a> Name

Property Value

<a id=“SuperOffice_WebApi_Data_User_NickName”></a> NickName

Property Value

<a id=“SuperOffice_WebApi_Data_User_OtherGroups”></a> OtherGroups

Property Value

<a id=“SuperOffice_WebApi_Data_User_Person”></a> Person

Property Value

<a id=“SuperOffice_WebApi_Data_User_PostSaveCommands”></a> PostSaveCommands

Property Value

<a id=“SuperOffice_WebApi_Data_User_Rank”></a> Rank

Property Value

<a id=“SuperOffice_WebApi_Data_User_RequestSignature”></a> RequestSignature

Property Value

<a id=“SuperOffice_WebApi_Data_User_Role”></a> Role

Property Value

<a id=“SuperOffice_WebApi_Data_User_TicketCategories”></a> TicketCategories

Property Value

<a id=“SuperOffice_WebApi_Data_User_Tooltip”></a> Tooltip

Property Value

<a id=“SuperOffice_WebApi_Data_User_Type”></a> Type

Property Value

See Also

<a id=“SuperOffice_WebApi_Data_User_Type_String”></a> Type_String

Property Value

See Also

<a id=“SuperOffice_WebApi_Data_User_UserGroup”></a> UserGroup

Property Value

<a id=“SuperOffice_WebApi_Data_User_UserName”></a> UserName

Property Value

<a id=“SuperOffice_WebApi_Data_User_WaitingForApproval”></a> WaitingForApproval

Property Value

See Also