RHP_API

<back to all web services

GetUserChatroomAuthorisation

Get Chat Room user authorisation

Requires Authentication
The following routes are available for this service:
GET/User/ChatRoom
GetUserChatroomAuthorisation Parameters:
NameParameterData TypeRequiredDescription
RoomIdentifierquerystringNo
UserChatRoomAuthorisation Parameters:
NameParameterData TypeRequiredDescription
CanAccessChatformboolNo
ReasonformUserChatAuthorisationReasonNo
RemainingTimeformint?No
IsModeratorformboolNo
VideoCanViewformintNo
VideoCanBroadcastformboolNo
CanAccessFeaturedChatformboolNo
FeaturedRoomReasonformUserChatAuthorisationReasonNo

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/ChatRoom HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserChatRoomAuthorisation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <CanAccessChat>false</CanAccessChat>
  <CanAccessFeaturedChat>false</CanAccessFeaturedChat>
  <FeaturedRoomReason>Authorised</FeaturedRoomReason>
  <IsModerator>false</IsModerator>
  <Reason>Authorised</Reason>
  <RemainingTime>0</RemainingTime>
  <VideoCanBroadcast>false</VideoCanBroadcast>
  <VideoCanView>0</VideoCanView>
</UserChatRoomAuthorisation>