RHP_API

<back to all web services

GetClubDetail

Get group/club detail.

Requires Authentication
The following routes are available for this service:
GET/Club/{ID}
GetClubDetail Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
ClubDetail Parameters:
NameParameterData TypeRequiredDescription
HasRatedformboolNo
RateScoreformintNo
HasCommentedformboolNo
EventsformEventCountNo
TotalRateCountformintNo
OwnerformProfileSummaryNo
StatsformClubStatsNo
ClubDetailItem Parameters:
NameParameterData TypeRequiredDescription
DetailformClubItemNo
IsOwnerformboolNo
JoinSettingsformClubJoinSettingsNo
BannerformClubBannerPhotoNo
AccessibilitySettingsformClubAccessibilitySettingsNo
ClubItem Parameters:
NameParameterData TypeRequiredDescription
SeekingInfoformSeekingInfoNo
ClubIDformintNo
ClubNameformstringNo
LocationformLocationNo
CategoriesformLookupValue[]No
RatingformintNo
MainPhotoformClubProfilePhotoNo
IsFeaturedformboolNo
IsSponsoredformboolNo
TagsformList<Tag>No
KeyWordsformstringNo
SEOUrlformstringNo
DateCreatedformDateTimeNo
DisplayEmailformstringNo
WebsiteformstringNo
DescriptionformstringNo
RulesformstringNo
SeekingInfo Parameters:
NameParameterData TypeRequiredDescription
SeekingAgeRangeformAgeRangeNo
SeekingLocationformstringNo
SeekingTypesformLookupValue[]No
AgeRange Parameters:
NameParameterData TypeRequiredDescription
AgeFromformintNo
AgeToformintNo
LookupValue Parameters:
NameParameterData TypeRequiredDescription
IsMatchformboolNo
LookupValueBase Parameters:
NameParameterData TypeRequiredDescription
ValueformintNo
TextformstringNo
TextAbbrformstringNo
ListIDformint?No
Location Parameters:
NameParameterData TypeRequiredDescription
CityformstringNo
StateformstringNo
StateAbbrformstringNo
CountryformstringNo
ClubProfilePhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDformintNo
ThumbUrlformstringNo
FullUrlformstringNo
WidthformintNo
HeightformintNo
IsMainformboolNo
SortNumberformintNo
Tag Parameters:
NameParameterData TypeRequiredDescription
TagIDformintNo
KeywordformstringNo
ClubJoinSettings Parameters:
NameParameterData TypeRequiredDescription
JoinStatusformGenericJoinStatusNo
CanJoinStatusformUserClubCanJoinStatusNo
PrivacyTypeformClubPrivacyTypeNo
ClubBannerPhoto Parameters:
NameParameterData TypeRequiredDescription
FullUrlformstringNo
WidthformintNo
HeightformintNo
ApprovalStateformGenericStatusNo
ClubAccessibilitySettings Parameters:
NameParameterData TypeRequiredDescription
VisibilityTypeformClubVisibilityTypeNo
AccessibilityStatusformClubAccessibilityStatusNo
EventCount Parameters:
NameParameterData TypeRequiredDescription
CurrentformintNo
PastformintNo
ProfileSummary Parameters:
NameParameterData TypeRequiredDescription
MemberIDformlongNo
UserNameformstringNo
MemberTypeformshortNo
MemberTypeTitleformProfileMemberTypeNo
Age1formintNo
Age2formintNo
AgeTitleformstringNo
LocationformstringNo
MatchingInterestsformintNo
MainPhotoformProfilePhotoNo
IsOnlineformboolNo
MemberLevelformintNo
IsDiamondformboolNo
CountryIDformintNo
UserTypeformLoginUserTypeNo
MemberLevelTypeformstringNo
IsAdminformboolNo
MemberLevelUserProfileformMemberLevelUserProfileNo
IsViewableformboolNo
ProfileMemberType Parameters:
NameParameterData TypeRequiredDescription
AbbrformstringNo
SingularformstringNo
PluralformstringNo
ProfilePhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDformintNo
HeightformintNo
WidthformintNo
ImageTypeformProfileImageTypeNo
IsPublicformboolNo
ClassificationformintNo
UserTypeformLoginUserType?No
ShowSafeModeformboolNo
ImageActionTypeformImageActionTypeNo
GalleryIDformintNo
IsAcceptedformbool?No
MemberLikeCountformintNo
IsLikedformboolNo
SortNumberformintNo
ProfilePhotoUrl Parameters:
NameParameterData TypeRequiredDescription
ThumbUrlformstringNo
FullUrlformstringNo
ClubStats Parameters:
NameParameterData TypeRequiredDescription
PostsformintNo
AlbumsformintNo
EventsformintNo
PhotosformintNo
VideosformintNo
EventsPastformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"HasRated":false,"RateScore":0,"HasCommented":false,"Events":{"Current":0,"Past":0},"TotalRateCount":0,"Owner":{"MemberID":0,"UserName":"String","MemberType":0,"MemberTypeTitle":{"Abbr":"String","Singular":"String","Plural":"String"},"Age1":0,"Age2":0,"AgeTitle":"String","Location":"String","MatchingInterests":0,"MainPhoto":{"PhotoID":0,"Height":0,"Width":0,"ImageType":"None","IsPublic":false,"Classification":0,"UserType":"General","ShowSafeMode":false,"ImageActionType":"ShowImage","GalleryID":0,"IsAccepted":false,"MemberLikeCount":0,"IsLiked":false,"SortNumber":0,"ThumbUrl":"String","FullUrl":"String"},"IsOnline":false,"MemberLevel":0,"IsDiamond":false,"CountryID":0,"UserType":"General","MemberLevelType":"String","IsAdmin":false,"MemberLevelUserProfile":"Guest","IsViewable":false},"Stats":{"Posts":0,"Albums":0,"Events":0,"Photos":0,"Videos":0,"EventsPast":0},"Detail":{"SeekingInfo":{"SeekingAgeRange":{"AgeFrom":0,"AgeTo":0},"SeekingLocation":"String","SeekingTypes":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}]},"ClubID":0,"ClubName":"String","Location":{"City":"String","State":"String","StateAbbr":"String","Country":"String"},"Categories":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"Rating":0,"MainPhoto":{"PhotoID":0,"ThumbUrl":"String","FullUrl":"String","Width":0,"Height":0,"IsMain":false,"SortNumber":0},"IsFeatured":false,"IsSponsored":false,"Tags":[{"TagID":0,"Keyword":"String"}],"KeyWords":"String","SEOUrl":"String","DateCreated":"\/Date(-62135596800000-0000)\/","DisplayEmail":"String","Website":"String","Description":"String","Rules":"String"},"IsOwner":false,"JoinSettings":{"JoinStatus":"Pending","CanJoinStatus":"UnMatched","PrivacyType":"Public"},"Banner":{"FullUrl":"String","Width":0,"Height":0,"ApprovalState":"Pending"},"AccessibilitySettings":{"VisibilityType":"NotSpecified","AccessibilityStatus":"Visible"}}