RHP_API

<back to all web services

SearchClubGroup

Search for groups/clubs based on location (googleMapPlaceID), search radius, and/or categories

Requires Authentication
The following routes are available for this service:
POST/Club/SearchGroup
SearchClubBasedCriteria Parameters:
NameParameterData TypeRequiredDescription
GoogleMapPlaceIDformstringNoGoogleMapPlacesId used for locality based searches.
SearchRadiusformshortNoSearch radius, maps to 'Proximity
TagsformTag[]NoSearch by tags, empty array means all, maps to 'Advanced Search'
CategoryIDformintNoLegacy Search by Category
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
Tag Parameters:
NameParameterData TypeRequiredDescription
TagIDformintNo
KeywordformstringNo
GenericListResponse<T> Parameters:
NameParameterData TypeRequiredDescription
DataformList<T>No
TotalformintNo

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

HTTP + CSV

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

POST /Club/SearchGroup HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"GoogleMapPlaceID":"String","SearchRadius":0,"Tags":[{"TagID":0,"Keyword":"String"}],"CategoryID":0,"Size":0,"Page":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":[{"Tags":[{"TagID":0,"Keyword":"String"}],"ClubID":0,"ClubName":"String","ClubMemberCount":0,"IsOwner":false,"JoinSettings":{"JoinStatus":"Pending","CanJoinStatus":"UnMatched","PrivacyType":"Public"},"Banner":{"FullUrl":"String","Width":0,"Height":0,"ApprovalState":"Pending"},"Friends":{"TotalFriends":0,"FriendProfile":{"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}},"Rating":0,"TotalRateCount":0,"ApprovalState":"Pending"}],"Total":0}