RHP_API

GetUserClubDetail

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

**GetUserClubDetail** Parameters:
Name	Parameter	Data Type	Required	Description
ClubID	path	int	No

**UserClubDetail** Parameters:
Name	Parameter	Data Type	Required
ClubID	form	int	No
ApprovalState	form	ApprovalStatus	No
ProfileDetail	form	UserClubProfileDetail	No
MemberSetting	form	UserClubMember	No
Banner	form	ClubBannerPhoto	No
TempInfo	form	ClubTempInfo	No
Stats	form	ClubStats	No

**UserClubProfileDetail** Parameters:
Name	Parameter	Data Type	Required	Description
Tags	form	Tag[]	No	Tag keywords. Maps to Category
Keywords	form	string[]	No

**UserClubProfileDetailBase** Parameters:
Name	Parameter	Data Type	Required	Description
ClubName	form	string	No	Name of group/club. Maps to Group name
GoogleMapPlace	form	GooglePlace	No	GoogleMapPlaces data could be Country or State or Suburb. Maps to Location
PrivacyType	form	ClubPrivacyType	No	Privacy type setting (Public or Private). Maps to Privacy
VisibilityType	form	ClubVisibilityType	No	Visibility type setting (All or Members only). Maps to Visibility
Description	form	string	No	Description of the group/club. Maps to Description
Phone	form	string	No	Phone of the group/clubs organiser, needs to be verified. Maps to Phone
DisplayEmail	form	string	No	Email of the group/clubs organiser. Maps to Email
Website	form	string	No	Description of the group/club. Maps to Website
Rules	form	string	No	Rules of the group/club. Maps to Rules

**GooglePlace** Parameters:
Name	Parameter	Data Type	Required	Description
PlacesId	form	string	No	GoogleMapPlacesId used for locality based searches. Maps to 'place_id' google autocomplete.
Types	form	string[]	No	GoogleMapPlacesId types array used for locality based searches. Maps to 'types' array google autocomplete.
LocationName	form	string	No	This field will return the name of the location, no needed in the request.

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

**UserClubMember** Parameters:
Name	Parameter	Data Type	Required	Description
MemberType	form	short	No	Maps to 'Who can join my group'
MinAge	form	int	No	Minimum age range. Maps to 'Age range' slider
MaxAge	form	int	No	Maximum age range. Maps to 'Age range' slider
GoogleMapPlace	form	GooglePlace	No	GoogleMapPlaces data used for state / country based searches.

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

**ClubTempInfo** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
IsNameRejected	form	bool	No
Description	form	string	No
IsDescriptionRejected	form	bool	No
Rules	form	string	No
IsRulesRejected	form	bool	No
IsProcessed	form	bool	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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /User/Club/{ClubID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClubID: 0,
	ApprovalState: Approved,
	ProfileDetail: 
	{
		Tags: 
		[
			{
				TagID: 0,
				Keyword: String
			}
		],
		Keywords: 
		[
			String
		],
		ClubName: String,
		GoogleMapPlace: 
		{
			PlacesId: String,
			Types: 
			[
				String
			],
			LocationName: String
		},
		PrivacyType: Public,
		VisibilityType: NotSpecified,
		Description: String,
		Phone: String,
		DisplayEmail: String,
		Website: String,
		Rules: String
	},
	MemberSetting: 
	{
		MemberType: 0,
		MinAge: 0,
		MaxAge: 0,
		GoogleMapPlace: 
		{
			PlacesId: String,
			Types: 
			[
				String
			],
			LocationName: String
		}
	},
	Banner: 
	{
		FullUrl: String,
		Width: 0,
		Height: 0,
		ApprovalState: Pending
	},
	TempInfo: 
	{
		Name: String,
		IsNameRejected: False,
		Description: String,
		IsDescriptionRejected: False,
		Rules: String,
		IsRulesRejected: False,
		IsProcessed: False
	},
	Stats: 
	{
		Posts: 0,
		Albums: 0,
		Events: 0,
		Photos: 0,
		Videos: 0,
		EventsPast: 0
	}
}