RHP_API

GetEventSearch

Returns list of events, that match the supplied criteria.

The following routes are available for this service:
GET, POST	/Event/Search

**GetEventSearch** Parameters:
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

**GenericListResponse<T>** Parameters:
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 .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.

POST /Event/Search HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetEventSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <CategoryID>0</CategoryID>
  <DateEnd>0001-01-01T00:00:00</DateEnd>
  <DateStart>0001-01-01T00:00:00</DateStart>
  <FeaturedType>All</FeaturedType>
  <GoogleMapPlaceID>String</GoogleMapPlaceID>
  <InterestedOnly>false</InterestedOnly>
  <Radius>0</Radius>
  <SearchTerm>String</SearchTerm>
  <SponsoredType>All</SponsoredType>
</GetEventSearch>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenericListResponseOfEventSearchDetailSjC_PYTVK xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
    <d2p1:EventSearchDetail>
      <d2p1:Organiser />
      <d2p1:SearchItem>
        <d2p1:ApprovalStatus>Approved</d2p1:ApprovalStatus>
        <d2p1:Categories>
          <LookupValue>
            <ListID>0</ListID>
            <Text>String</Text>
            <TextAbbr>String</TextAbbr>
            <Value>0</Value>
            <IsMatch>false</IsMatch>
          </LookupValue>
        </d2p1:Categories>
        <d2p1:DateHeld>0001-01-01T00:00:00</d2p1:DateHeld>
        <d2p1:DateHeldDisplay>String</d2p1:DateHeldDisplay>
        <d2p1:DateHeldUtcIso>String</d2p1:DateHeldUtcIso>
        <d2p1:EventBannerUrl>String</d2p1:EventBannerUrl>
        <d2p1:EventFeaturedBannerUrl>String</d2p1:EventFeaturedBannerUrl>
        <d2p1:EventGlobalBannerUrl>String</d2p1:EventGlobalBannerUrl>
        <d2p1:EventID>0</d2p1:EventID>
        <d2p1:IsFullGuestList>false</d2p1:IsFullGuestList>
        <d2p1:IsGroupChatAvailable>false</d2p1:IsGroupChatAvailable>
        <d2p1:IsTicketUrlPrivate>false</d2p1:IsTicketUrlPrivate>
        <d2p1:IsViewerOwner>false</d2p1:IsViewerOwner>
        <d2p1:Location>
          <d2p1:City>String</d2p1:City>
          <d2p1:Country>String</d2p1:Country>
          <d2p1:State>String</d2p1:State>
          <d2p1:StateAbbr>String</d2p1:StateAbbr>
        </d2p1:Location>
        <d2p1:OrganiserType>All</d2p1:OrganiserType>
        <d2p1:TimeZone xmlns:d5p1="http://schemas.datacontract.org/2004/07/RHP.Model">
          <d5p1:AbbrDaylight>String</d5p1:AbbrDaylight>
          <d5p1:AbbrGeneric>String</d5p1:AbbrGeneric>
          <d5p1:AbbrStandard>String</d5p1:AbbrStandard>
          <d5p1:BaseUtcOffset>String</d5p1:BaseUtcOffset>
          <d5p1:DaylightName>String</d5p1:DaylightName>
          <d5p1:DaylightOffset>String</d5p1:DaylightOffset>
          <d5p1:ID>String</d5p1:ID>
          <d5p1:IanaName>String</d5p1:IanaName>
          <d5p1:IsDaylightSavingTime>false</d5p1:IsDaylightSavingTime>
          <d5p1:StandardName>String</d5p1:StandardName>
          <d5p1:SupportsDaylightSavingTime>false</d5p1:SupportsDaylightSavingTime>
          <d5p1:WindowsName>String</d5p1:WindowsName>
        </d2p1:TimeZone>
        <d2p1:TimeZoneInfoID>String</d2p1:TimeZoneInfoID>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:AgeRange>
          <d2p1:AgeFrom>0</d2p1:AgeFrom>
          <d2p1:AgeTo>0</d2p1:AgeTo>
        </d2p1:AgeRange>
        <d2p1:GuestTypes>
          <LookupValue>
            <ListID>0</ListID>
            <Text>String</Text>
            <TextAbbr>String</TextAbbr>
            <Value>0</Value>
            <IsMatch>false</IsMatch>
          </LookupValue>
        </d2p1:GuestTypes>
        <d2p1:HasExpressInterest>false</d2p1:HasExpressInterest>
        <d2p1:InterestCount>0</d2p1:InterestCount>
        <d2p1:InterestCountGuest>0</d2p1:InterestCountGuest>
        <d2p1:InterestCountUpgrade>0</d2p1:InterestCountUpgrade>
        <d2p1:IsFeatured>false</d2p1:IsFeatured>
        <d2p1:IsSponsored>false</d2p1:IsSponsored>
      </d2p1:SearchItem>
    </d2p1:EventSearchDetail>
  </Data>
  <Total>0</Total>
</GenericListResponseOfEventSearchDetailSjC_PYTVK>