RHP_API

GetChatRooms

Returns list of Rooms and the free opening hours.

The following routes are available for this service:
GET	/Chat/Rooms

**AvailableChatRooms** Parameters:
Name	Parameter	Data Type	Required
DisplayFreeChat	form	bool	No
DailyFreeOpeningHours	form	OpeningHours	No
FreeChatBanner	form	ChatRoomBanner	No
FeatureRooms	form	List<FeatureChatRoom>	No

**OpeningHours** Parameters:
Name	Parameter	Data Type	Required	Description
OpeningTime	form	DateTime	No
ClosingTime	form	DateTime	No

**ChatRoomBanner** Parameters:
Name	Parameter	Data Type	Required	Description
Mobile	form	AnnouncementBanner	No
Desktop	form	AnnouncementBanner	No

**AnnouncementBanner** Parameters:
Name	Parameter	Data Type	Required	Description
BannerImageUrl	form	string	No	Image URL for banner ad
AnnouncementType	form	AnnouncementType	No	Type of announcement, this will determine the destination or action. Possible values: UpgradePage, Event, URL, Article
DestinationURL	form	string	No	Destination if the AnnouncementType is URL
AnnouncementItemID	form	int?	No	Announcement type Event and Article will include the ID of the item

**FeatureChatRoom** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
RoomId	form	int	No
RoomJID	form	string	No
StartTime	form	DateTime	No
EndTime	form	DateTime	No
MobileBannerURL	form	string	No
DesktopBannerURL	form	string	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 /Chat/Rooms HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

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

<AvailableChatRooms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <DailyFreeOpeningHours>
    <ClosingTime>0001-01-01T00:00:00</ClosingTime>
    <OpeningTime>0001-01-01T00:00:00</OpeningTime>
  </DailyFreeOpeningHours>
  <DisplayFreeChat>false</DisplayFreeChat>
  <FeatureRooms>
    <FeatureChatRoom>
      <DesktopBannerURL>String</DesktopBannerURL>
      <EndTime>0001-01-01T00:00:00</EndTime>
      <MobileBannerURL>String</MobileBannerURL>
      <Name>String</Name>
      <RoomId>0</RoomId>
      <RoomJID>String</RoomJID>
      <StartTime>0001-01-01T00:00:00</StartTime>
    </FeatureChatRoom>
  </FeatureRooms>
  <FreeChatBanner>
    <Desktop>
      <AnnouncementItemID>0</AnnouncementItemID>
      <AnnouncementType>UpgradePage</AnnouncementType>
      <BannerImageUrl>String</BannerImageUrl>
      <DestinationURL>String</DestinationURL>
    </Desktop>
    <Mobile>
      <AnnouncementItemID>0</AnnouncementItemID>
      <AnnouncementType>UpgradePage</AnnouncementType>
      <BannerImageUrl>String</BannerImageUrl>
      <DestinationURL>String</DestinationURL>
    </Mobile>
  </FreeChatBanner>
</AvailableChatRooms>