RHP_API

<back to all web services

GetEventDetail

Returns the event details.

Requires Authentication
The following routes are available for this service:
GET/Event/{ID}
GetEventDetail Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
PreviewquerystringNo
EventDetail Parameters:
NameParameterData TypeRequiredDescription
DetailformEventNo
OrganiserformObjectNo
HasExpressInterestformboolNo
OrganiserTypeformEventOwnerTypeNo
SEOUrlformstringNo
Event Parameters:
NameParameterData TypeRequiredDescription
AgeRangeformAgeRangeNo
DescriptionformstringNo
ThemeformstringNo
DressCodeformstringNo
RulesformstringNo
CostformstringNo
TicketUrlformstringNo
PhoneformstringNo
EmailformstringNo
WebsiteformstringNo
VideoUrlformstringNo
VideoCodeformstringNo
VideoTypeformVideoTypeNo
VideoThumbURLformstringNo
GuestTypesformLookupValue[]No
EventItem Parameters:
NameParameterData TypeRequiredDescription
EventIDformintNo
TitleformstringNo
DateHeldformDateTimeNo
DateHeldUtcIsoformstringNo
DateHeldDisplayformstringNo
TimeZoneInfoIDformstringNo
TimeZoneformTimeZoneLookupItemNo
CategoriesformLookupValue[]No
OrganiserTypeformEventOwnerTypeNo
EventBannerUrlformstringNo
EventFeaturedBannerUrlformstringNo
EventGlobalBannerUrlformstringNo
LocationformLocationNo
IsFullGuestListformboolNo
IsViewerOwnerformboolNo
ApprovalStatusformApprovalStatusNo
IsGroupChatAvailableformbool?No
IsTicketUrlPrivateformbool?No
TimeZoneLookupItem Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
WindowsNameformstringNo
StandardNameformstringNo
DaylightNameformstringNo
SupportsDaylightSavingTimeformboolNo
IsDaylightSavingTimeformboolNo
IanaNameformstringNo
AbbrGenericformstringNo
AbbrStandardformstringNo
AbbrDaylightformstringNo
BaseUtcOffsetformstringNo
DaylightOffsetformstringNo
LookupValue Parameters:
NameParameterData TypeRequiredDescription
IsMatchformboolNo
LookupValueBase Parameters:
NameParameterData TypeRequiredDescription
ValueformintNo
TextformstringNo
TextAbbrformstringNo
ListIDformint?No
Location Parameters:
NameParameterData TypeRequiredDescription
CityformstringNo
StateformstringNo
StateAbbrformstringNo
CountryformstringNo
AgeRange Parameters:
NameParameterData TypeRequiredDescription
AgeFromformintNo
AgeToformintNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Event/{ID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Detail":{"AgeRange":{"AgeFrom":0,"AgeTo":0},"Description":"String","Theme":"String","DressCode":"String","Rules":"String","Cost":"String","TicketUrl":"String","Phone":"String","Email":"String","Website":"String","VideoUrl":"String","VideoCode":"String","VideoType":"NA","VideoThumbURL":"String","GuestTypes":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"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":{},"HasExpressInterest":false,"OrganiserType":"All","SEOUrl":"String"}