RHP_API

<back to all web services

GetClubSearch

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

Requires Authentication
The following routes are available for this service:
GET/Club/Search
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /Club/Search HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Data":[{"CommentCount":0,"ClubMemberCount":0,"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"}],"Total":0}