RHP_API

<back to all web services

SearchClubByName

Get list of groups/clubs based on prefix in group/club name

Requires Authentication
The following routes are available for this service:
GET/Club/Search/Name
SearchClubByName Parameters:
NameParameterData TypeRequiredDescription
PrefixquerystringNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
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.

GET /Club/Search/Name HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv

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}