| GET | /Chat/Rooms |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DisplayFreeChat | form | bool | No | |
| DailyFreeOpeningHours | form | OpeningHours | No | |
| FreeChatBanner | form | ChatRoomBanner | No | |
| FeatureRooms | form | List<FeatureChatRoom> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OpeningTime | form | DateTime | No | |
| ClosingTime | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Mobile | form | AnnouncementBanner | No | |
| Desktop | form | AnnouncementBanner | No |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"DisplayFreeChat":false,"DailyFreeOpeningHours":{"OpeningTime":"\/Date(-62135596800000-0000)\/","ClosingTime":"\/Date(-62135596800000-0000)\/"},"FreeChatBanner":{"Mobile":{"BannerImageUrl":"String","AnnouncementType":"UpgradePage","DestinationURL":"String","AnnouncementItemID":0},"Desktop":{"BannerImageUrl":"String","AnnouncementType":"UpgradePage","DestinationURL":"String","AnnouncementItemID":0}},"FeatureRooms":[{"Name":"String","RoomId":0,"RoomJID":"String","StartTime":"\/Date(-62135596800000-0000)\/","EndTime":"\/Date(-62135596800000-0000)\/","MobileBannerURL":"String","DesktopBannerURL":"String"}]}