RHP_API

GetClubSearch

Search for groups/clubs based on location (googleMapPlaceID), search radius, and/or categories

The following routes are available for this service:
GET	/Club/Search

**SearchClubBasedCriteria** Parameters:
Name	Parameter	Data Type	Required	Description
GoogleMapPlaceID	form	string	No	GoogleMapPlacesId used for locality based searches.
SearchRadius	form	short	No	Search radius, maps to 'Proximity
Tags	form	Tag[]	No	Search by tags, empty array means all, maps to 'Advanced Search'
CategoryID	form	int	No	Legacy Search by Category

**Pagination** Parameters:
Name	Parameter	Data Type	Required	Description
Size	form	int	No
Page	form	int	No

**Tag** Parameters:
Name	Parameter	Data Type	Required	Description
TagID	form	int	No
Keyword	form	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.

GET /Club/Search HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

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

<GenericListResponseOfClubSearchItemSjC_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:ClubSearchItem>
      <d2p1:Categories>
        <LookupValue>
          <ListID>0</ListID>
          <Text>String</Text>
          <TextAbbr>String</TextAbbr>
          <Value>0</Value>
          <IsMatch>false</IsMatch>
        </LookupValue>
      </d2p1:Categories>
      <d2p1:ClubID>0</d2p1:ClubID>
      <d2p1:ClubName>String</d2p1:ClubName>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DisplayEmail>String</d2p1:DisplayEmail>
      <d2p1:IsFeatured>false</d2p1:IsFeatured>
      <d2p1:IsSponsored>false</d2p1:IsSponsored>
      <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:MainPhoto>
        <FullUrl>String</FullUrl>
        <Height>0</Height>
        <IsMain>false</IsMain>
        <PhotoID>0</PhotoID>
        <SortNumber>0</SortNumber>
        <ThumbUrl>String</ThumbUrl>
        <Width>0</Width>
      </d2p1:MainPhoto>
      <d2p1:Rating>0</d2p1:Rating>
      <d2p1:Rules>String</d2p1:Rules>
      <d2p1:SEOUrl>String</d2p1:SEOUrl>
      <d2p1:SeekingInfo>
        <d2p1:SeekingAgeRange>
          <d2p1:AgeFrom>0</d2p1:AgeFrom>
          <d2p1:AgeTo>0</d2p1:AgeTo>
        </d2p1:SeekingAgeRange>
        <d2p1:SeekingLocation>String</d2p1:SeekingLocation>
        <d2p1:SeekingTypes>
          <LookupValue>
            <ListID>0</ListID>
            <Text>String</Text>
            <TextAbbr>String</TextAbbr>
            <Value>0</Value>
            <IsMatch>false</IsMatch>
          </LookupValue>
        </d2p1:SeekingTypes>
      </d2p1:SeekingInfo>
      <d2p1:Tags>
        <d2p1:Tag>
          <d2p1:Keyword>String</d2p1:Keyword>
          <d2p1:TagID>0</d2p1:TagID>
        </d2p1:Tag>
      </d2p1:Tags>
      <d2p1:Website>String</d2p1:Website>
      <d2p1:ClubMemberCount>0</d2p1:ClubMemberCount>
      <d2p1:CommentCount>0</d2p1:CommentCount>
    </d2p1:ClubSearchItem>
  </Data>
  <Total>0</Total>
</GenericListResponseOfClubSearchItemSjC_PYTVK>