Contents

Summary

A user in the TeamDynamix People database.

Properties

Name Editable? Required? Type Nullable? Summary
UID Guid The UID of the user.
ReferenceID Int32 The integer ID of the user.
BEID Guid The UID of the organization associated with the user.
BEIDInt Int32 The integer ID of the organization associated with the user.
IsActive This field is editable through the web API. Boolean The active status of the user.
IsConfidential This field is editable through the web API. Boolean The confidential status of the user.
UserName String The username of the user.
FullName String The full name of the user.
FirstName This field is editable through the web API. This field is required. String The first name of the user.
LastName This field is editable through the web API. This field is required. String The last name of the user.
MiddleName This field is editable through the web API. String This field is nullable. The middle name of the user.
Salutation This field is editable through the web API. String This field is nullable. The salutation of the user.
Nickname This field is editable through the web API. String This field is nullable. The nickname of the user.
DefaultAccountID This field is editable through the web API. Int32 The ID of the default account/department associated with the user.
DefaultAccountName String The name of the default account/department associated with the user.
PrimaryEmail This field is editable through the web API. This field is required. String The primary email address of the user.
AlternateEmail This field is editable through the web API. String This field is nullable. The alternate email address of the user.
ExternalID This field is editable through the web API. String This field is nullable. The organizational ID of the user.
AlternateID This field is editable through the web API. String This field is nullable. The alternate ID of the user.
Applications This field is editable through the web API. String[] This field is nullable. The system-defined (non-platform) applications associated with the user.
SecurityRoleName String The name of the global security role associated with the user.
SecurityRoleID This field is editable through the web API. String The UID of the global security role associated with the user.
Permissions String[] This field is nullable. The global security role permissions associated with the user.
OrgApplications This field is editable through the web API. TeamDynamix.Api.Apps.UserApplication[] This field is nullable. The organizationally-defined (platform) applications associated with the user.
PrimaryClientPortalApplicationID This field is editable through the web API. Int32 This field is nullable. The ID of the primary client portal application associated with the user.
GroupIDs Int32[] This field is nullable. The IDs of the groups associated with the user.
AlertEmail This field is editable through the web API. String This field is nullable. The alert email address of the user where system notifications are delivered.
ProfileImageFileName String The profile image file name of the user.
Company This field is editable through the web API. This field is required. String The company of the user.
Title This field is editable through the web API. String This field is nullable. The title of the user.
HomePhone This field is editable through the web API. String This field is nullable. The home phone number of the user.
PrimaryPhone This field is editable through the web API. String This field is nullable. The primary phone number of the user.
WorkPhone This field is editable through the web API. String This field is nullable. The work phone number of the user.
Pager This field is editable through the web API. String This field is nullable. The pager number of the user.
OtherPhone This field is editable through the web API. String This field is nullable. The other phone number of the user.
MobilePhone This field is editable through the web API. String This field is nullable. The mobile phone number of the user.
Fax This field is editable through the web API. String This field is nullable. The fax number of the user.
DefaultPriorityID This field is editable through the web API. Int32 The ID of the default priority associated with the user.
DefaultPriorityName String The name of the default priority associated with the user.
AboutMe This field is editable through the web API. String This field is nullable. The "About Me" information associated with the user.
TechnicianSignature This field is editable through the web API. String This field is nullable. The technician signature associated with the user.
ApplyTechnicianSignatureToUpdatesAndComments This field is editable through the web API. Boolean Determines whether the technician signature associated with the user is applied to the updates and comments for all tickets and ticket tasks.
ApplyTechnicianSignatureToReplies This field is editable through the web API. Boolean Determines whether the technician signature associated with the user is applied to the replies for all tickets and ticket tasks.
WorkAddress This field is editable through the web API. String This field is nullable. The work address of the user.
WorkCity This field is editable through the web API. String This field is nullable. The work city of the user.
WorkState This field is editable through the web API. String This field is nullable. The work state abbreviation of the user.
WorkZip This field is editable through the web API. String This field is nullable. The work zip code of the user.
WorkCountry This field is editable through the web API. String This field is nullable. The work country of the user.
HomeAddress This field is editable through the web API. String This field is nullable. The home address of the user.
HomeCity This field is editable through the web API. String This field is nullable. The home city of the user.
HomeState This field is editable through the web API. String This field is nullable. The home state abbreviation of the user.
HomeZip This field is editable through the web API. String This field is nullable. The home zip code of the user.
HomeCountry This field is editable through the web API. String This field is nullable. The home country of the user.
LocationID This field is editable through the web API. Int32 The ID of the location associated with the user.
LocationName String The name of the location associated with the user.
LocationRoomID This field is editable through the web API. Int32 The ID of the location room associated with the user.
LocationRoomName String The name of the location room associated with the user.
DefaultRate This field is editable through the web API. Double The default bill rate of the user.
CostRate This field is editable through the web API. Double The cost rate of the user.
IsEmployee This field is editable through the web API. Boolean The employee status of the user.
WorkableHours This field is editable through the web API. Double The number of workable hours in a work day for the user.
IsCapacityManaged This field is editable through the web API. Boolean Whether the user's capacity is managed, meaning they can have capacity and will appear on capacity/availability reports.
ReportTimeAfterDate This field is editable through the web API. DateTime The date after which the user should start reporting time. This also governs capacity calculations.
EndDate This field is editable through the web API. DateTime The date after which the user is no longer available for scheduling and no longer required to log time.
ShouldReportTime This field is editable through the web API. Boolean Whether the user should report time.
ReportsToUID This field is editable through the web API. String This field is nullable. The UID of the person who the user reports to.
ReportsToFullName String The full name of the person who the user reports to.
ResourcePoolID This field is editable through the web API. Int32 The ID of the resource pool associated with the user.
ResourcePoolName String The name of the resource pool associated with the user.
TZID This field is editable through the web API. Int32 The ID of the time zone associated with the user.
TZName String The name of the time zone associated with the user.
TypeID TeamDynamix.Api.Users.UserType The type of the user.
AuthenticationUserName This field is editable through the web API. String This field is nullable. The authentication username of the user, used for authenticating with non-TeamDynamix authentication types.
AuthenticationProviderID This field is editable through the web API. Int32 This field is nullable. The ID of the authentication provider the new user will use for authentication.
Attributes This field is editable through the web API. TeamDynamix.Api.CustomAttributes.CustomAttribute[] This field is nullable. The custom attributes associated with the user.
IMProvider This field is editable through the web API. String This field is nullable. The Instant Messenger (IM) provider associated with the user.
IMHandle This field is editable through the web API. String This field is nullable. The Instant Messenger (IM) username/handle associated with the user.

Remarks

Any type of field that is a collection, such as TeamDynamix.Api.Users.User.Attributes and TeamDynamix.Api.Users.User.Permissions, is only returned when a single user is selected.

To increase performance, these collection fields are excluded from the data returned by endpoints such as api/people/search and api/people/lookup.