| GET | /User/Announcement/Banner |
|---|
| 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 |
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 /User/Announcement/Banner HTTP/1.1 Host: tstsrvs.redhotpie.com.au Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Mobile":{"BannerImageUrl":"String","AnnouncementType":"UpgradePage","DestinationURL":"String","AnnouncementItemID":0},"Desktop":{"BannerImageUrl":"String","AnnouncementType":"UpgradePage","DestinationURL":"String","AnnouncementItemID":0}}