GET | /Club/{ID} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | path | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Detail | form | ClubItem | No | |
IsOwner | form | bool | No | |
JoinSettings | form | ClubJoinSettings | No | |
Banner | form | ClubBannerPhoto | No | |
AccessibilitySettings | form | ClubAccessibilitySettings | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SeekingAgeRange | form | AgeRange | No | |
SeekingLocation | form | string | No | |
SeekingTypes | form | LookupValue[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AgeFrom | form | int | No | |
AgeTo | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsMatch | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | int | No | |
Text | form | string | No | |
TextAbbr | form | string | No | |
ListID | form | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
City | form | string | No | |
State | form | string | No | |
StateAbbr | form | string | No | |
Country | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TagID | form | int | No | |
Keyword | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
JoinStatus | form | GenericJoinStatus | No | |
CanJoinStatus | form | UserClubCanJoinStatus | No | |
PrivacyType | form | ClubPrivacyType | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FullUrl | form | string | No | |
Width | form | int | No | |
Height | form | int | No | |
ApprovalState | form | GenericStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VisibilityType | form | ClubVisibilityType | No | |
AccessibilityStatus | form | ClubAccessibilityStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Current | form | int | No | |
Past | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Abbr | form | string | No | |
Singular | form | string | No | |
Plural | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ThumbUrl | form | string | No | |
FullUrl | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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"}}