RHP_API

<back to all web services

UpdateUserClubDetail

Requires Authentication
The following routes are available for this service:
PATCH/User/Club/{ClubID}
UpdateUserClubDetail Parameters:
NameParameterData TypeRequiredDescription
ClubIDpathintNo
ProfileDetailqueryUserClubProfileDetailFormNo
MemberSettingqueryUserClubMemberNo
UserClubProfileDetailForm Parameters:
NameParameterData TypeRequiredDescription
Keywordsformstring[]NoTag keywords. Maps to Category
UserClubProfileDetailBase Parameters:
NameParameterData TypeRequiredDescription
ClubNameformstringNoName of group/club. Maps to Group name
GoogleMapPlaceformGooglePlaceNoGoogleMapPlaces data could be Country or State or Suburb. Maps to Location
PrivacyTypeformClubPrivacyTypeNoPrivacy type setting (Public or Private). Maps to Privacy
VisibilityTypeformClubVisibilityTypeNoVisibility type setting (All or Members only). Maps to Visibility
DescriptionformstringNoDescription of the group/club. Maps to Description
PhoneformstringNoPhone of the group/clubs organiser, needs to be verified. Maps to Phone
DisplayEmailformstringNoEmail of the group/clubs organiser. Maps to Email
WebsiteformstringNoDescription of the group/club. Maps to Website
RulesformstringNoRules of the group/club. Maps to Rules
GooglePlace Parameters:
NameParameterData TypeRequiredDescription
PlacesIdformstringNoGoogleMapPlacesId used for locality based searches. Maps to 'place_id' google autocomplete.
Typesformstring[]NoGoogleMapPlacesId types array used for locality based searches. Maps to 'types' array google autocomplete.
LocationNameformstringNoThis field will return the name of the location, no needed in the request.
UserClubMember Parameters:
NameParameterData TypeRequiredDescription
MemberTypeformshortNoMaps to 'Who can join my group'
MinAgeformintNoMinimum age range. Maps to 'Age range' slider
MaxAgeformintNoMaximum age range. Maps to 'Age range' slider
GoogleMapPlaceformGooglePlaceNoGoogleMapPlaces data used for state / country based searches.
UserClubDetail Parameters:
NameParameterData TypeRequiredDescription
ClubIDformintNo
ApprovalStateformApprovalStatusNo
ProfileDetailformUserClubProfileDetailNo
MemberSettingformUserClubMemberNo
BannerformClubBannerPhotoNo
TempInfoformClubTempInfoNo
StatsformClubStatsNo
UserClubProfileDetail Parameters:
NameParameterData TypeRequiredDescription
TagsformTag[]NoTag keywords. Maps to Category
Keywordsformstring[]No
Tag Parameters:
NameParameterData TypeRequiredDescription
TagIDformintNo
KeywordformstringNo
ClubBannerPhoto Parameters:
NameParameterData TypeRequiredDescription
FullUrlformstringNo
WidthformintNo
HeightformintNo
ApprovalStateformGenericStatusNo
ClubTempInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
IsNameRejectedformboolNo
DescriptionformstringNo
IsDescriptionRejectedformboolNo
RulesformstringNo
IsRulesRejectedformboolNo
IsProcessedformboolNo
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 .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.

PATCH /User/Club/{ClubID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClubID: 0,
	ProfileDetail: 
	{
		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
		}
	}
}
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
	}
}