Loading ...

REST API: User Overview | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: User Overview
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 18

REST API: User Overview

0 
 /5
0 (0votes)

User Properties

The user object is used to create users in the Communifire system. It includes the User ID that is used to make reference to the particular user throughout the system. Each User ID is unique and automatically generated by the Communifire system.

Attribute Description Data type
AIM User's AIM messenger ID. string
AvatarImageURL URL of the user's avatar image. string
AvatarPath Name of user's avatar image. string
Bio User's biography. string
CompanyName
 The user's company. string
ChatStatusCssClass CSS class for the user's chat status. string
ChatStatusText Text that describes a user's chat status. string
ContentMemberships List of recognition programs the user can participate in. List<int>
DOB User's date of birth. datetime
DOBString User's date of birth (string). string
DateBanned Date when the user was banned. datetime
DateFormat Date format set by the user. datetime
DateJoined Date of user joining. datetime
DateJoinedString Date (string) of user joining. string
DateLastVisited Date when user last visited the community. datetime
DateLastVisitedString Date (string) when user last visited the community. string
DefaultCulture The default culture of user. string
Description Description text. string
Email Email ID of the user. string
EmailRecieve User can choose to receive email notifications from the website.
  • OnlyExternalEmails = 1
  • NoEmails = 0
  • NotSpecified = -1
  • NoExternalEmails = 2
  • AllEmails = 3
 UserEmailReceiveType
FacebookURL User's Facebook profile link. string
FavoriteBooks Favorite books entered by user. string
FavoriteCuisines Favorite cuisines entered by user. string
FavoriteMusic Favorite music entered by user. string
FavoriteTVShows Favorite tv shows entered by user. string
FaxNumber Fax number entered by user. string
FirstName User's first name. string
Gender Gender of user.
  • Male = 2
  • Female = 3
  • None Specified = 0
 int
GoogleIM User's Google messenger ID. string
HasJoinedViaThirdPartyLogin
 Specifies if the user joined via third party SSO. bool
HomePage The homepage of the user. string
ICQIM The user's company. string
IP User's IP address. string
Image The user image in bytes. byte[]
ImageString The user image in the form of string. string
InOrgChart Specifies if the user appears in the org chart. bool
Interests Interests added by user. string
IsActivated Specifies if user is activated. bool
IsAnonymous Specifies if user is anonymous. bool
IsBanned Specifies if user is banned. bool
IsConfirmed Specifies if user is confirmed. bool
IsContactInfoVisible Specifies if user's contact information is visible publicly. bool
IsFeatured Specifies if the user is featured. bool
IsIsolated Specifies if the user is isolated. bool
IsOptInPromotionalEmails Specifies if user agrees to receive promotional emails from the website.  bool
IsPasswordEncrypted Specifies if password is encrypted. bool
IsPasswordHashed
 Specifies if password is hashed. bool
IsProfileCompleted Specifies if user profile is completed. bool
IsProfilePublic Specifies if user profile is visible publicly. bool
IsUserLocked
 Specifies if the user account is locked. bool
IsWindowsADUser
 Specifies if the user is an Active Directory user. bool
LastChatActivityDate
 When the user was last online. DateTime
LastName User's last name. string
LinkedinURL User's Linkedin profile link. string
Location User's location (not full address). string
MSN User's MSN messenger ID. string 
MediaServerID ID of the media server. int
MediaServerRootURL URL of the media server. string
MetaDescription Brief information about content that will be displayed in search engine's result page. string
MetaKeywords Keywords tell search engines the topic of the page. string
MetaTitle Title of content that will be displayed in search engine's result page. string
MiddleName User's middle name. string
NumBlogPosts Number of blog posts by the user. int
NumPosts Number of forum topic posts made by the user. int
Occupation User's job title. string
OnlineChatStatus The user's chat status. The values are: 
  • Online = 1 
  • Offline = 2
  • Invisible = 3
  • Busy = 4
  • Away = 5
  • CustomStatus = 6
 OnlineChatStatus
Password The password entered for validation. string
PhoneNumber Phone number entered by user. string
PMNotification
 Specifies if chat notification sound is enabled or not. bool
Points Points earned by the user. long
ProfileImageURL URL of the user's profile image. string
ProfilePhoto User's profile photo name. string
ProfileURL URL of user's profile. string
RankID ID of user rank in the community. int
RankImage Name of rank image. string
RankImageURL URL of user's rank image. string
RankName Name of user rank. string
Role User's role in the community. string
RoleID Unique ID of role. int
RoleIDsTLC
 List of unique IDs of the user's top level roles. Collection<int>
Salutation Salutation of user. string
ShowEmail Show/hide user's email. bool
Signature Signature string entered by user. string
SimpleFields
 List of profile field data. Dictionary<int, SimpleField>
The int is the field ID.
SkypeIM User's Skype Messenger ID. string
SpaceDigestOption
 The user's space digest preference. The values are:
  • All Digests = 1
  • Daily Digest Only = 2
  • Weekly Digest Only = 3
 SpaceDigestReceiveOption
SpaceIDs List of unique ID of spaces the user is a member of. Collection<int>
StatusNow User chat status. string
SupervisorID
 User ID of the user's supervisor. int
TimeFormat Time format set by the user. string
TimeZoneID User's time zone. string
TwitterURL User's Twitter profile link. string
UserAddress Address of the user. string
UserID ID value which uniquely identifies each user in the Communifire. Generated automatically. This cannot be changed. int
UserInfoDisplayName The user's display name. string
UserName The username entered for validation. string
UserPresenceStatus
 User's online status.
  • Active = 1
  • Offline = 3
 UserPresenceStatus
YIM User's Yahoo Messenger ID. string

Please Note Refer to REST API: Add User for how to create a new user.

 

Wiki Index

Pages

Intranet Software