RHP_API

<back to all web services

GetEventSearch

Returns list of events, that match the supplied criteria.

Requires Authentication
The following routes are available for this service:
GET, POST/Event/Search
GetEventSearch Parameters:
NameParameterData TypeRequiredDescription
CategoryIDbodyintNoReturns events that match the selected category or supply -1 for all Categories.
DateStartbodyDateTime?NoReturns events that are held on or after the supplied date, supply null to ignore this criteria
DateEndbodyDateTime?NoReturns events that are held on or before the supplied date, supply null to ignore this criteria
GoogleMapPlaceIDbodystringNoGoogleMapPlacesId used for locality based searches.
SponsoredTypebodyEventSponsoredTypeNoUsed 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
FeaturedTypebodyEventFeaturedTypeNoUsed 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
RadiusbodyintNo
InterestedOnlybodyboolNo
SearchTermbodystringNo
GenericListResponse<T> Parameters:
NameParameterData TypeRequiredDescription
DataformList<T>No
TotalformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
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}