| GET, POST | /Event/Search |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CategoryID | body | int | No | Returns events that match the selected category or supply -1 for all Categories. |
| DateStart | body | DateTime? | No | Returns events that are held on or after the supplied date, supply null to ignore this criteria |
| DateEnd | body | DateTime? | No | Returns events that are held on or before the supplied date, supply null to ignore this criteria |
| GoogleMapPlaceID | body | string | No | GoogleMapPlacesId used for locality based searches. |
| SponsoredType | body | EventSponsoredType | No | Used to filter the sponsored events for the top of the search (set to 'Sponsored'). General searches should be set to 'All' or not supplied. Accepted values are All, NonSponsored, Sponsored |
| FeaturedType | body | EventFeaturedType | No | Used to filter the featured events, not used in the current UI. General searches should be set to 'All' or not supplied. Accepted values are All, NonFeatured, Featured |
| Radius | body | int | No | |
| InterestedOnly | body | bool | No | |
| SearchTerm | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | List<T> | No | |
| Total | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Event/Search HTTP/1.1
Host: tstsrvs.redhotpie.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CategoryID":0,"DateStart":"\/Date(-62135596800000-0000)\/","DateEnd":"\/Date(-62135596800000-0000)\/","GoogleMapPlaceID":"String","SponsoredType":"All","FeaturedType":"All","Radius":0,"InterestedOnly":false,"SearchTerm":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Data":[{"SearchItem":{"InterestCountGuest":0,"InterestCountUpgrade":0,"InterestCountTotal":0,"InterestCount":0,"HasExpressInterest":false,"AgeRange":{"AgeFrom":0,"AgeTo":0},"GuestTypes":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"IsSponsored":false,"IsFeatured":false,"EventID":0,"Title":"String","DateHeld":"\/Date(-62135596800000-0000)\/","DateHeldUtcIso":"String","DateHeldDisplay":"String","TimeZoneInfoID":"String","TimeZone":{"ID":"String","WindowsName":"String","StandardName":"String","DaylightName":"String","SupportsDaylightSavingTime":false,"IsDaylightSavingTime":false,"IanaName":"String","AbbrGeneric":"String","AbbrStandard":"String","AbbrDaylight":"String","BaseUtcOffset":"String","DaylightOffset":"String"},"Categories":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"OrganiserType":"All","EventBannerUrl":"String","EventFeaturedBannerUrl":"String","EventGlobalBannerUrl":"String","Location":{"City":"String","State":"String","StateAbbr":"String","Country":"String"},"IsFullGuestList":false,"IsViewerOwner":false,"ApprovalStatus":"Approved","IsGroupChatAvailable":false,"IsTicketUrlPrivate":false},"Organiser":{}}],"Total":0}