RHP_API

GetUserSettings

Get the current user's system settings.

The following routes are available for this service:
GET	/User/Account/Settings

**UserAccountSettings** Parameters:
Name	Parameter	Data Type	Required	Description
ToolTips	form	List<ToolTip>	No	List of all viewed ToolTips
Client	form	ClientSettings	No	Client settings
Profile	form	ProfileDetailSettings	No	User Profile details
Messenger	form	MessengerSettings	No	Messenger Settings
ChatroomSettings	form	ChatroomSettings	No	Chatrooms Settings
AccountSettings	form	AccountSettings	No	Account Settings
PushSettings	form	PushSettings	No	Push Settings
LinkedAccounts	form	LinkedUserAccounts	No	Linked Accounts
StreamSettings	form	StreamSettings	No	Home Stream settings

**ToolTip** Parameters:
Name	Parameter	Data Type	Required	Description
ViewCount	form	int	No	The number of times that a tooltip has been viewed.
ToolTipType	form	ToolTipType	No	Tooltip type data.

**ToolTipType** Parameters:
Name	Parameter	Data Type	Required	Description
ID	form	int	No	ToolTipType ID
DisplayLimit	form	short	No	Maximum number of times a user can view a ToolTip
Name	form	string	No	ToolTip name

**ClientSettings** Parameters:
Name	Parameter	Data Type	Required	Description
IsSpotlightFeaturedEnabled	form	bool	No	Determines if the user has the Spotlight popup enabled.
SafeMode	form	bool	No	Determines if the user has SafeMode enabled.
FileUploadLimit	form	int	No	The maximum file upload size supported.
IsImageReplyEnabled	form	bool	No	If true allow reply with Gif or Image in all comments (and comment replies), as well as allow Gifs in Messenger.
Grants	form	ClientGrants	No	Client features settings
IsIgnoreConversationEnabled	form	bool	No	If true the ignore confersation feature is active.
IsGiftingEnabled	form	bool	No	If true the Store Credit / Gifting feature is active.
IsUserPhotoCommentsEnabled	form	bool	No	If true show the comment button on user photos.
UserVideoSizeLimit	form	int	No	The maximum user video upload size supported (bytes).
CommunityVideoSizeLimit	form	int	No	The maximum community video upload size supported (bytes).
IsVideoMessageEnabled	form	bool	No	If true the Video messaging is active.
MobileValidationNumber	form	string	No	Mobile number for manual validation.
UserVideoUploadMaxRetries	form	int	No	The number of times to poll when merging a Video.
UserVideoUploadPollInterval	form	int	No	The number milliseconds between polls when merging a Video.

**ClientGrants** Parameters:
Name	Parameter	Data Type	Required
Prospects	form	ProspectGrants	No
Photo	form	PhotoGrants	No
Message	form	MessageGrants	No
Event	form	EventGrants	No
Group	form	GroupGrants	No
Profile	form	PofileGrants	No
Community	form	CommunityGrants	No

**ProspectGrants** Parameters:
Name	Parameter	Data Type	Required
CanViewLikes	form	bool	No
CanViewMatches	form	bool	No
CanRemoveLike	form	bool	No
CanRemoveFav	form	bool	No

**PhotoGrants** Parameters:
Name	Parameter	Data Type	Required	Description
UploadRequired	form	bool	No

**MessageGrants** Parameters:
Name	Parameter	Data Type	Required
AUVisaRequired	form	bool	No
ShowReplyLimit	form	bool	No
CanMakeVideoCalls	form	bool	No

**EventGrants** Parameters:
Name	Parameter	Data Type	Required	Description
CanViewContacts	form	bool	No
CanCreateEvent	form	bool	No

**GroupGrants** Parameters:
Name	Parameter	Data Type	Required	Description
CanManageGroups	form	bool	No

**PofileGrants** Parameters:
Name	Parameter	Data Type	Required	Description
CanViewPhoneNumbers	form	bool	No
CanUseAnonymousBrowsing	form	bool	No

**CommunityGrants** Parameters:
Name	Parameter	Data Type	Required
ArticleCanComment	form	bool	No
EventCanComment	form	bool	No
StoryCanComment	form	bool	No
ForumCanComment	form	bool	No

**ProfileDetailSettings** Parameters:
Name	Parameter	Data Type	Required	Description
Country	form	Country	No

**Country** Parameters:
Name	Parameter	Data Type	Required
CountryID	form	int	No
Name	form	string	No
Code	form	string	No
Show	form	bool	No
MapzenLabel	form	string	No
GoogleMapPlacesId	form	string	No
Latitude	form	double	No
Longitude	form	double	No

**MessengerSettings** Parameters:
Name	Parameter	Data Type	Required	Description
PermissionMessageReceive	form	MessageReceivePermission	No	Determines if a user can receive a message.
PermissionVideoCall	form	MessageReceivePermission	No	Determines if a user can receive a video call.
ReplyLimitDays	form	int	No	The number of days that a user can reply after the last received message in a conversation, if less than one is returned there is no limit.
DefaultFolder	form	MessageFolders	No
OperationMethod	form	string	No
DefaultImageDuration	form	MessageImageDuration	No	Default image shared duration.
CanReceivePhotos	form	bool	No
CanReceiveGifts	form	bool	No
IsActive	form	bool?	No	If true the client should display the 'Service Unavailable' popup.
Theme	form	MessengerTheme	No

**MessengerTheme** Parameters:
Name	Parameter	Data Type	Required	Description
DarkMode	form	bool	No	DEPRECATED. Replaced with DarkModeSetting
DarkModeSetting	form	ToggleWithDefault	No
ThemeType	form	MessengerThemeType	No
FontSize	form	MessengerFontSize	No

**ChatroomSettings** Parameters:
Name	Parameter	Data Type	Required	Description
PermissionMessageReceive	form	ChatroomMessageReceivePermission	No	Determine's who the user can receive message from.
IsSoundEnabled	form	bool	No	Determine's if the user wants the sounds to play.
IsActive	form	bool	No	If true the client should display the 'Service Unavailable' popup.

**AccountSettings** Parameters:
Name	Parameter	Data Type	Required	Description
ProfileViewable	form	bool	No
ShowOnline	form	bool	No
AnonymousBrowsing	form	bool	No
ReceiveEmailMessages	form	bool	No	This parameter is deprecated, use email settings
AccountStatus	form	AccountStatus	No	AccountStatus indicates the status of a user account
AccountPaused	form	bool	No	This parameter is deprecated, use AccountStatus
AccountRequiresAuthentication	form	bool	No	This parameter is deprecated, use AccountStatus
EmailNotificationSettings	form	EmailNotificationSettings	No
NewPasswordRequired	form	bool	No
FeatureProfile	form	bool	No
PromoteProfile	form	bool	No
ProfileBoostExpiry	form	DateTime?	No
ProfileViewSettings	form	ProfileViewSettings	No
ShareProfileCode	form	string	No
ValidationViewSetting	form	ProfileViewSettings	No
IntimateInfoViewSettings	form	ProfileViewSettings	No
ProfileActivityViewSettings	form	ProfileViewSettings	No
AccountDeletedDate	form	DateTime?	No
GCLID	form	string	No

**EmailNotificationSettings** Parameters:
Name	Parameter	Data Type	Required
MatchReport	form	bool	No
DateFinder	form	bool	No
Events	form	bool	No
Offers	form	bool	No
RHPTeamMessages	form	bool	No

**PushSettings** Parameters:
Name	Parameter	Data Type	Required	Description
IsEnabled	form	bool	No	This parameter is deprecated
PushToken	form	string	No
NotificationSettings	form	PushNotificationSettings	No

**PushNotificationSettings** Parameters:
Name	Parameter	Data Type	Required
Messages	form	MessageReceivePermission	No
Views	form	MessageReceivePermission	No
Likes	form	MessageReceivePermission	No
Favourites	form	MessageReceivePermission	No
GroupChat	form	GroupChatPushNotificationPermission	No
Matches	form	bool	No
RHPTeamMessages	form	bool	No
PushTags	form	string	No
DateFinderInterest	form	bool	No
ForumComment	form	bool	No
StoryComment	form	bool	No
EventComment	form	bool	No

**LinkedUserAccounts** Parameters:
Name	Parameter	Data Type	Required
Facebook	form	bool	No
Apple	form	bool	No
Google	form	bool	No

**StreamSettings** Parameters:
Name	Parameter	Data Type	Required	Description
ActivityFilters	form	UserActivityFilter[]	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /User/Account/Settings HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserAccountSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <AccountSettings>
    <AccountDeletedDate>0001-01-01T00:00:00</AccountDeletedDate>
    <AccountPaused>false</AccountPaused>
    <AccountRequiresAuthentication>false</AccountRequiresAuthentication>
    <AccountStatus>Active</AccountStatus>
    <AnonymousBrowsing>false</AnonymousBrowsing>
    <EmailNotificationSettings>
      <DateFinder>false</DateFinder>
      <Events>false</Events>
      <MatchReport>false</MatchReport>
      <Offers>false</Offers>
      <RHPTeamMessages>false</RHPTeamMessages>
    </EmailNotificationSettings>
    <FeatureProfile>false</FeatureProfile>
    <GCLID>String</GCLID>
    <IntimateInfoViewSettings>Everyone</IntimateInfoViewSettings>
    <NewPasswordRequired>false</NewPasswordRequired>
    <ProfileActivityViewSettings>Everyone</ProfileActivityViewSettings>
    <ProfileBoostExpiry>0001-01-01T00:00:00</ProfileBoostExpiry>
    <ProfileViewSettings>Everyone</ProfileViewSettings>
    <ProfileViewable>false</ProfileViewable>
    <PromoteProfile>false</PromoteProfile>
    <ReceiveEmailMessages>false</ReceiveEmailMessages>
    <ShareProfileCode>String</ShareProfileCode>
    <ShowOnline>false</ShowOnline>
    <ValidationViewSetting>Everyone</ValidationViewSetting>
  </AccountSettings>
  <ChatroomSettings>
    <IsActive>false</IsActive>
    <IsSoundEnabled>false</IsSoundEnabled>
    <PermissionMessageReceive>Anyone</PermissionMessageReceive>
  </ChatroomSettings>
  <Client>
    <CommunityVideoSizeLimit>0</CommunityVideoSizeLimit>
    <FileUploadLimit>0</FileUploadLimit>
    <Grants>
      <Community>
        <ArticleCanComment>false</ArticleCanComment>
        <EventCanComment>false</EventCanComment>
        <ForumCanComment>false</ForumCanComment>
        <StoryCanComment>false</StoryCanComment>
      </Community>
      <Event>
        <CanCreateEvent>false</CanCreateEvent>
        <CanViewContacts>false</CanViewContacts>
      </Event>
      <Group>
        <CanManageGroups>false</CanManageGroups>
      </Group>
      <Message>
        <AUVisaRequired>false</AUVisaRequired>
        <CanMakeVideoCalls>false</CanMakeVideoCalls>
        <ShowReplyLimit>false</ShowReplyLimit>
      </Message>
      <Photo>
        <UploadRequired>false</UploadRequired>
      </Photo>
      <Profile>
        <CanUseAnonymousBrowsing>false</CanUseAnonymousBrowsing>
        <CanViewPhoneNumbers>false</CanViewPhoneNumbers>
      </Profile>
      <Prospects>
        <CanRemoveFav>false</CanRemoveFav>
        <CanRemoveLike>false</CanRemoveLike>
        <CanViewLikes>false</CanViewLikes>
        <CanViewMatches>false</CanViewMatches>
      </Prospects>
    </Grants>
    <IsGiftingEnabled>false</IsGiftingEnabled>
    <IsIgnoreConversationEnabled>false</IsIgnoreConversationEnabled>
    <IsImageReplyEnabled>false</IsImageReplyEnabled>
    <IsSpotlightFeaturedEnabled>false</IsSpotlightFeaturedEnabled>
    <IsUserPhotoCommentsEnabled>false</IsUserPhotoCommentsEnabled>
    <IsVideoMessageEnabled>false</IsVideoMessageEnabled>
    <MobileValidationNumber>String</MobileValidationNumber>
    <SafeMode>false</SafeMode>
    <UserVideoSizeLimit>0</UserVideoSizeLimit>
    <UserVideoUploadMaxRetries>0</UserVideoUploadMaxRetries>
    <UserVideoUploadPollInterval>0</UserVideoUploadPollInterval>
  </Client>
  <LinkedAccounts>
    <Apple>false</Apple>
    <Facebook>false</Facebook>
    <Google>false</Google>
  </LinkedAccounts>
  <Messenger>
    <CanReceiveGifts>false</CanReceiveGifts>
    <CanReceivePhotos>false</CanReceivePhotos>
    <DefaultFolder>All</DefaultFolder>
    <DefaultImageDuration>None</DefaultImageDuration>
    <IsActive>false</IsActive>
    <OperationMethod>String</OperationMethod>
    <PermissionMessageReceive>Anyone</PermissionMessageReceive>
    <PermissionVideoCall>Anyone</PermissionVideoCall>
    <ReplyLimitDays>0</ReplyLimitDays>
    <Theme>
      <DarkMode>false</DarkMode>
      <DarkModeSetting>Default</DarkModeSetting>
      <FontSize>Small</FontSize>
      <ThemeType>Green</ThemeType>
    </Theme>
  </Messenger>
  <Profile>
    <Country>
      <Code>String</Code>
      <CountryID>0</CountryID>
      <GoogleMapPlacesId>String</GoogleMapPlacesId>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <MapzenLabel>String</MapzenLabel>
      <Name>String</Name>
      <Show>false</Show>
    </Country>
  </Profile>
  <PushSettings>
    <IsEnabled>false</IsEnabled>
    <NotificationSettings>
      <DateFinderInterest>false</DateFinderInterest>
      <EventComment>false</EventComment>
      <Favourites>Anyone</Favourites>
      <ForumComment>false</ForumComment>
      <GroupChat>Anyone</GroupChat>
      <Likes>Anyone</Likes>
      <Matches>false</Matches>
      <Messages>Anyone</Messages>
      <PushTags>String</PushTags>
      <RHPTeamMessages>false</RHPTeamMessages>
      <StoryComment>false</StoryComment>
      <Views>Anyone</Views>
    </NotificationSettings>
    <PushToken>String</PushToken>
  </PushSettings>
  <StreamSettings>
    <ActivityFilters xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.Model">
      <d3p1:UserActivityFilter>Events</d3p1:UserActivityFilter>
    </ActivityFilters>
  </StreamSettings>
  <ToolTips>
    <ToolTip>
      <ToolTipType>
        <DisplayLimit>0</DisplayLimit>
        <ID>0</ID>
        <Name>String</Name>
      </ToolTipType>
      <ViewCount>0</ViewCount>
    </ToolTip>
  </ToolTips>
</UserAccountSettings>