RHP_API

GetClubDetail

Get group/club detail.

The following routes are available for this service:
GET	/Club/{ID}

**GetClubDetail** Parameters:
Name	Parameter	Data Type	Required	Description
ID	path	int	No

**ClubDetail** Parameters:
Name	Parameter	Data Type	Required
HasRated	form	bool	No
RateScore	form	int	No
HasCommented	form	bool	No
Events	form	EventCount	No
TotalRateCount	form	int	No
Owner	form	ProfileSummary	No
Stats	form	ClubStats	No

**ClubDetailItem** Parameters:
Name	Parameter	Data Type	Required
Detail	form	ClubItem	No
IsOwner	form	bool	No
JoinSettings	form	ClubJoinSettings	No
Banner	form	ClubBannerPhoto	No
AccessibilitySettings	form	ClubAccessibilitySettings	No

**ClubItem** Parameters:
Name	Parameter	Data Type	Required
SeekingInfo	form	SeekingInfo	No
ClubID	form	int	No
ClubName	form	string	No
Location	form	Location	No
Categories	form	LookupValue[]	No
Rating	form	int	No
MainPhoto	form	ClubProfilePhoto	No
IsFeatured	form	bool	No
IsSponsored	form	bool	No
Tags	form	List<Tag>	No
KeyWords	form	string	No
SEOUrl	form	string	No
DateCreated	form	DateTime	No
DisplayEmail	form	string	No
Website	form	string	No
Description	form	string	No
Rules	form	string	No

**SeekingInfo** Parameters:
Name	Parameter	Data Type	Required
SeekingAgeRange	form	AgeRange	No
SeekingLocation	form	string	No
SeekingTypes	form	LookupValue[]	No

**AgeRange** Parameters:
Name	Parameter	Data Type	Required	Description
AgeFrom	form	int	No
AgeTo	form	int	No

**LookupValue** Parameters:
Name	Parameter	Data Type	Required	Description
IsMatch	form	bool	No

**LookupValueBase** Parameters:
Name	Parameter	Data Type	Required
Value	form	int	No
Text	form	string	No
TextAbbr	form	string	No
ListID	form	int?	No

**Location** Parameters:
Name	Parameter	Data Type	Required
City	form	string	No
State	form	string	No
StateAbbr	form	string	No
Country	form	string	No

**ClubProfilePhoto** Parameters:
Name	Parameter	Data Type	Required
PhotoID	form	int	No
ThumbUrl	form	string	No
FullUrl	form	string	No
Width	form	int	No
Height	form	int	No
IsMain	form	bool	No
SortNumber	form	int	No

**Tag** Parameters:
Name	Parameter	Data Type	Required	Description
TagID	form	int	No
Keyword	form	string	No

**ClubJoinSettings** Parameters:
Name	Parameter	Data Type	Required
JoinStatus	form	GenericJoinStatus	No
CanJoinStatus	form	UserClubCanJoinStatus	No
PrivacyType	form	ClubPrivacyType	No

**ClubBannerPhoto** Parameters:
Name	Parameter	Data Type	Required
FullUrl	form	string	No
Width	form	int	No
Height	form	int	No
ApprovalState	form	GenericStatus	No

**ClubAccessibilitySettings** Parameters:
Name	Parameter	Data Type	Required	Description
VisibilityType	form	ClubVisibilityType	No
AccessibilityStatus	form	ClubAccessibilityStatus	No

**EventCount** Parameters:
Name	Parameter	Data Type	Required	Description
Current	form	int	No
Past	form	int	No

**ProfileSummary** Parameters:
Name	Parameter	Data Type	Required
MemberID	form	long	No
UserName	form	string	No
MemberType	form	short	No
MemberTypeTitle	form	ProfileMemberType	No
Age1	form	int	No
Age2	form	int	No
AgeTitle	form	string	No
Location	form	string	No
MatchingInterests	form	int	No
MainPhoto	form	ProfilePhoto	No
IsOnline	form	bool	No
MemberLevel	form	int	No
IsDiamond	form	bool	No
CountryID	form	int	No
UserType	form	LoginUserType	No
MemberLevelType	form	string	No
IsAdmin	form	bool	No
MemberLevelUserProfile	form	MemberLevelUserProfile	No
IsViewable	form	bool	No

**ProfileMemberType** Parameters:
Name	Parameter	Data Type	Required
Abbr	form	string	No
Singular	form	string	No
Plural	form	string	No

**ProfilePhoto** Parameters:
Name	Parameter	Data Type	Required
PhotoID	form	int	No
Height	form	int	No
Width	form	int	No
ImageType	form	ProfileImageType	No
IsPublic	form	bool	No
Classification	form	int	No
UserType	form	LoginUserType?	No
ShowSafeMode	form	bool	No
ImageActionType	form	ImageActionType	No
GalleryID	form	int	No
IsAccepted	form	bool?	No
MemberLikeCount	form	int	No
IsLiked	form	bool	No
SortNumber	form	int	No

**ProfilePhotoUrl** Parameters:
Name	Parameter	Data Type	Required	Description
ThumbUrl	form	string	No
FullUrl	form	string	No

**ClubStats** Parameters:
Name	Parameter	Data Type	Required
Posts	form	int	No
Albums	form	int	No
Events	form	int	No
Photos	form	int	No
Videos	form	int	No
EventsPast	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/{ID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

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

<ClubDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <AccessibilitySettings>
    <AccessibilityStatus>Visible</AccessibilityStatus>
    <VisibilityType>NotSpecified</VisibilityType>
  </AccessibilitySettings>
  <Banner xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:ApprovalState>Pending</d2p1:ApprovalState>
    <d2p1:FullUrl>String</d2p1:FullUrl>
    <d2p1:Height>0</d2p1:Height>
    <d2p1:Width>0</d2p1:Width>
  </Banner>
  <Detail>
    <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>
    <ClubID>0</ClubID>
    <ClubName>String</ClubName>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <Description>String</Description>
    <DisplayEmail>String</DisplayEmail>
    <IsFeatured>false</IsFeatured>
    <IsSponsored>false</IsSponsored>
    <Location>
      <City>String</City>
      <Country>String</Country>
      <State>String</State>
      <StateAbbr>String</StateAbbr>
    </Location>
    <MainPhoto xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <d3p1:FullUrl>String</d3p1:FullUrl>
      <d3p1:Height>0</d3p1:Height>
      <d3p1:IsMain>false</d3p1:IsMain>
      <d3p1:PhotoID>0</d3p1:PhotoID>
      <d3p1:SortNumber>0</d3p1:SortNumber>
      <d3p1:ThumbUrl>String</d3p1:ThumbUrl>
      <d3p1:Width>0</d3p1:Width>
    </MainPhoto>
    <Rating>0</Rating>
    <Rules>String</Rules>
    <SEOUrl>String</SEOUrl>
    <SeekingInfo>
      <SeekingAgeRange>
        <AgeFrom>0</AgeFrom>
        <AgeTo>0</AgeTo>
      </SeekingAgeRange>
      <SeekingLocation>String</SeekingLocation>
      <SeekingTypes xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
        <d4p1:LookupValue>
          <d4p1:ListID>0</d4p1:ListID>
          <d4p1:Text>String</d4p1:Text>
          <d4p1:TextAbbr>String</d4p1:TextAbbr>
          <d4p1:Value>0</d4p1:Value>
          <d4p1:IsMatch>false</d4p1:IsMatch>
        </d4p1:LookupValue>
      </SeekingTypes>
    </SeekingInfo>
    <Tags>
      <Tag>
        <Keyword>String</Keyword>
        <TagID>0</TagID>
      </Tag>
    </Tags>
    <Website>String</Website>
  </Detail>
  <IsOwner>false</IsOwner>
  <JoinSettings>
    <CanJoinStatus>UnMatched</CanJoinStatus>
    <JoinStatus>Pending</JoinStatus>
    <PrivacyType>Public</PrivacyType>
  </JoinSettings>
  <Events>
    <Current>0</Current>
    <Past>0</Past>
  </Events>
  <HasCommented>false</HasCommented>
  <Owner xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:Age1>0</d2p1:Age1>
    <d2p1:Age2>0</d2p1:Age2>
    <d2p1:AgeTitle>String</d2p1:AgeTitle>
    <d2p1:CountryID>0</d2p1:CountryID>
    <d2p1:IsAdmin>false</d2p1:IsAdmin>
    <d2p1:IsDiamond>false</d2p1:IsDiamond>
    <d2p1:IsOnline>false</d2p1:IsOnline>
    <d2p1:IsViewable>false</d2p1:IsViewable>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:MainPhoto>
      <d2p1:FullUrl>String</d2p1:FullUrl>
      <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
      <d2p1:Classification>0</d2p1:Classification>
      <d2p1:GalleryID>0</d2p1:GalleryID>
      <d2p1:Height>0</d2p1:Height>
      <d2p1:ImageActionType>ShowImage</d2p1:ImageActionType>
      <d2p1:ImageType>None</d2p1:ImageType>
      <d2p1:IsAccepted>false</d2p1:IsAccepted>
      <d2p1:IsLiked>false</d2p1:IsLiked>
      <d2p1:IsPublic>false</d2p1:IsPublic>
      <d2p1:MemberLikeCount>0</d2p1:MemberLikeCount>
      <d2p1:PhotoID>0</d2p1:PhotoID>
      <d2p1:ShowSafeMode>false</d2p1:ShowSafeMode>
      <d2p1:SortNumber>0</d2p1:SortNumber>
      <d2p1:UserType>General</d2p1:UserType>
      <d2p1:Width>0</d2p1:Width>
    </d2p1:MainPhoto>
    <d2p1:MatchingInterests>0</d2p1:MatchingInterests>
    <d2p1:MemberID>0</d2p1:MemberID>
    <d2p1:MemberLevel>0</d2p1:MemberLevel>
    <d2p1:MemberLevelType>String</d2p1:MemberLevelType>
    <d2p1:MemberLevelUserProfile>Guest</d2p1:MemberLevelUserProfile>
    <d2p1:MemberType>0</d2p1:MemberType>
    <d2p1:MemberTypeTitle>
      <d2p1:Abbr>String</d2p1:Abbr>
      <d2p1:Plural>String</d2p1:Plural>
      <d2p1:Singular>String</d2p1:Singular>
    </d2p1:MemberTypeTitle>
    <d2p1:UserName>String</d2p1:UserName>
    <d2p1:UserType>General</d2p1:UserType>
  </Owner>
  <RateScore>0</RateScore>
  <Stats>
    <Albums>0</Albums>
    <Events>0</Events>
    <EventsPast>0</EventsPast>
    <Photos>0</Photos>
    <Posts>0</Posts>
    <Videos>0</Videos>
  </Stats>
  <TotalRateCount>0</TotalRateCount>
</ClubDetail>