RHP_API

SearchClubGroup

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

The following routes are available for this service:
POST	/Club/SearchGroup

**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.

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

<SearchClubGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Page xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Page>
  <Size xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Size>
  <CategoryID>0</CategoryID>
  <GoogleMapPlaceID>String</GoogleMapPlaceID>
  <SearchRadius>0</SearchRadius>
  <Tags>
    <Tag>
      <Keyword>String</Keyword>
      <TagID>0</TagID>
    </Tag>
  </Tags>
</SearchClubGroup>

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

<GenericListResponseOfClubGroupSearchItemSjC_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:ClubGroupSearchItem>
      <d2p1:ApprovalState>Pending</d2p1:ApprovalState>
      <d2p1:Banner>
        <ApprovalState>Pending</ApprovalState>
        <FullUrl>String</FullUrl>
        <Height>0</Height>
        <Width>0</Width>
      </d2p1:Banner>
      <d2p1:ClubID>0</d2p1:ClubID>
      <d2p1:ClubMemberCount>0</d2p1:ClubMemberCount>
      <d2p1:ClubName>String</d2p1:ClubName>
      <d2p1:Friends>
        <d2p1:FriendProfile>
          <Age1>0</Age1>
          <Age2>0</Age2>
          <AgeTitle>String</AgeTitle>
          <CountryID>0</CountryID>
          <IsAdmin>false</IsAdmin>
          <IsDiamond>false</IsDiamond>
          <IsOnline>false</IsOnline>
          <IsViewable>false</IsViewable>
          <Location>String</Location>
          <MainPhoto>
            <FullUrl>String</FullUrl>
            <ThumbUrl>String</ThumbUrl>
            <Classification>0</Classification>
            <GalleryID>0</GalleryID>
            <Height>0</Height>
            <ImageActionType>ShowImage</ImageActionType>
            <ImageType>None</ImageType>
            <IsAccepted>false</IsAccepted>
            <IsLiked>false</IsLiked>
            <IsPublic>false</IsPublic>
            <MemberLikeCount>0</MemberLikeCount>
            <PhotoID>0</PhotoID>
            <ShowSafeMode>false</ShowSafeMode>
            <SortNumber>0</SortNumber>
            <UserType>General</UserType>
            <Width>0</Width>
          </MainPhoto>
          <MatchingInterests>0</MatchingInterests>
          <MemberID>0</MemberID>
          <MemberLevel>0</MemberLevel>
          <MemberLevelType>String</MemberLevelType>
          <MemberLevelUserProfile>Guest</MemberLevelUserProfile>
          <MemberType>0</MemberType>
          <MemberTypeTitle>
            <Abbr>String</Abbr>
            <Plural>String</Plural>
            <Singular>String</Singular>
          </MemberTypeTitle>
          <UserName>String</UserName>
          <UserType>General</UserType>
        </d2p1:FriendProfile>
        <d2p1:TotalFriends>0</d2p1:TotalFriends>
      </d2p1:Friends>
      <d2p1:IsOwner>false</d2p1:IsOwner>
      <d2p1:JoinSettings>
        <d2p1:CanJoinStatus>UnMatched</d2p1:CanJoinStatus>
        <d2p1:JoinStatus>Pending</d2p1:JoinStatus>
        <d2p1:PrivacyType>Public</d2p1:PrivacyType>
      </d2p1:JoinSettings>
      <d2p1:Rating>0</d2p1:Rating>
      <d2p1:Tags>
        <d2p1:Tag>
          <d2p1:Keyword>String</d2p1:Keyword>
          <d2p1:TagID>0</d2p1:TagID>
        </d2p1:Tag>
      </d2p1:Tags>
      <d2p1:TotalRateCount>0</d2p1:TotalRateCount>
    </d2p1:ClubGroupSearchItem>
  </Data>
  <Total>0</Total>
</GenericListResponseOfClubGroupSearchItemSjC_PYTVK>