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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
		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
}