RHP_API

<back to all web services

PatchClientChatroomSettings

Update the user client messenger settings.

Requires Authentication
The following routes are available for this service:
PATCH/User/Account/Settings/Chatroom
PatchClientChatroomSettings Parameters:
NameParameterData TypeRequiredDescription
PermissionMessageReceivequeryChatroomMessageReceivePermission?No
IsSoundEnabledquerybool?No
ChatroomSettings Parameters:
NameParameterData TypeRequiredDescription
PermissionMessageReceiveformChatroomMessageReceivePermissionNoDetermine's who the user can receive message from.
IsSoundEnabledformboolNoDetermine's if the user wants the sounds to play.
IsActiveformboolNoIf true the client should display the 'Service Unavailable' popup.

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.

PATCH /User/Account/Settings/Chatroom HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchClientChatroomSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <IsSoundEnabled>false</IsSoundEnabled>
  <PermissionMessageReceive>Anyone</PermissionMessageReceive>
</PatchClientChatroomSettings>

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

<ChatroomSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <IsActive>false</IsActive>
  <IsSoundEnabled>false</IsSoundEnabled>
  <PermissionMessageReceive>Anyone</PermissionMessageReceive>
</ChatroomSettings>