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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Detail>
    <ApprovalStatus>Approved</ApprovalStatus>
    <Categories xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <d3p1:LookupValue>
        <d3p1:ListID>0</d3p1:ListID>
        <d3p1:Text>String</d3p1:Text>
        <d3p1:TextAbbr>String</d3p1:TextAbbr>
        <d3p1:Value>0</d3p1:Value>
        <d3p1:IsMatch>false</d3p1:IsMatch>
      </d3p1:LookupValue>
    </Categories>
    <DateHeld>0001-01-01T00:00:00</DateHeld>
    <DateHeldDisplay>String</DateHeldDisplay>
    <DateHeldUtcIso>String</DateHeldUtcIso>
    <EventBannerUrl>String</EventBannerUrl>
    <EventFeaturedBannerUrl>String</EventFeaturedBannerUrl>
    <EventGlobalBannerUrl>String</EventGlobalBannerUrl>
    <EventID>0</EventID>
    <IsFullGuestList>false</IsFullGuestList>
    <IsGroupChatAvailable>false</IsGroupChatAvailable>
    <IsTicketUrlPrivate>false</IsTicketUrlPrivate>
    <IsViewerOwner>false</IsViewerOwner>
    <Location>
      <City>String</City>
      <Country>String</Country>
      <State>String</State>
      <StateAbbr>String</StateAbbr>
    </Location>
    <OrganiserType>All</OrganiserType>
    <TimeZone xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.Model">
      <d3p1:AbbrDaylight>String</d3p1:AbbrDaylight>
      <d3p1:AbbrGeneric>String</d3p1:AbbrGeneric>
      <d3p1:AbbrStandard>String</d3p1:AbbrStandard>
      <d3p1:BaseUtcOffset>String</d3p1:BaseUtcOffset>
      <d3p1:DaylightName>String</d3p1:DaylightName>
      <d3p1:DaylightOffset>String</d3p1:DaylightOffset>
      <d3p1:ID>String</d3p1:ID>
      <d3p1:IanaName>String</d3p1:IanaName>
      <d3p1:IsDaylightSavingTime>false</d3p1:IsDaylightSavingTime>
      <d3p1:StandardName>String</d3p1:StandardName>
      <d3p1:SupportsDaylightSavingTime>false</d3p1:SupportsDaylightSavingTime>
      <d3p1:WindowsName>String</d3p1:WindowsName>
    </TimeZone>
    <TimeZoneInfoID>String</TimeZoneInfoID>
    <Title>String</Title>
    <AgeRange>
      <AgeFrom>0</AgeFrom>
      <AgeTo>0</AgeTo>
    </AgeRange>
    <Cost>String</Cost>
    <Description>String</Description>
    <DressCode>String</DressCode>
    <Email>String</Email>
    <GuestTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <d3p1:LookupValue>
        <d3p1:ListID>0</d3p1:ListID>
        <d3p1:Text>String</d3p1:Text>
        <d3p1:TextAbbr>String</d3p1:TextAbbr>
        <d3p1:Value>0</d3p1:Value>
        <d3p1:IsMatch>false</d3p1:IsMatch>
      </d3p1:LookupValue>
    </GuestTypes>
    <Phone>String</Phone>
    <Rules>String</Rules>
    <Theme>String</Theme>
    <TicketUrl>String</TicketUrl>
    <VideoCode>String</VideoCode>
    <VideoThumbURL>String</VideoThumbURL>
    <VideoType>NA</VideoType>
    <VideoUrl>String</VideoUrl>
    <Website>String</Website>
  </Detail>
  <HasExpressInterest>false</HasExpressInterest>
  <Organiser />
  <OrganiserType>All</OrganiserType>
  <SEOUrl>String</SEOUrl>
</EventDetail>