GET | /User/Club/{ClubID} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClubID | path | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Tags | form | Tag[] | No | Tag keywords. Maps to Category |
Keywords | form | string[] | No |
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 |
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. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TagID | form | int | No | |
Keyword | form | string | No |
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. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FullUrl | form | string | No | |
Width | form | int | No | |
Height | form | int | No | |
ApprovalState | form | GenericStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UserClubDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel"> <ApprovalState>Approved</ApprovalState> <Banner xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model"> <d2p1:ApprovalState>Pending</d2p1:ApprovalState> <d2p1:FullUrl>String</d2p1:FullUrl> <d2p1:Height>0</d2p1:Height> <d2p1:Width>0</d2p1:Width> </Banner> <ClubID>0</ClubID> <MemberSetting> <GoogleMapPlace> <LocationName>String</LocationName> <PlacesId>String</PlacesId> <Types xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </Types> </GoogleMapPlace> <MaxAge>0</MaxAge> <MemberType>0</MemberType> <MinAge>0</MinAge> </MemberSetting> <ProfileDetail> <ClubName>String</ClubName> <Description>String</Description> <DisplayEmail>String</DisplayEmail> <GoogleMapPlace> <LocationName>String</LocationName> <PlacesId>String</PlacesId> <Types xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </Types> </GoogleMapPlace> <Phone>String</Phone> <PrivacyType>Public</PrivacyType> <Rules>String</Rules> <VisibilityType>NotSpecified</VisibilityType> <Website>String</Website> <Keywords xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </Keywords> <Tags> <Tag> <Keyword>String</Keyword> <TagID>0</TagID> </Tag> </Tags> </ProfileDetail> <Stats> <Albums>0</Albums> <Events>0</Events> <EventsPast>0</EventsPast> <Photos>0</Photos> <Posts>0</Posts> <Videos>0</Videos> </Stats> <TempInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model"> <d2p1:Description>String</d2p1:Description> <d2p1:IsDescriptionRejected>false</d2p1:IsDescriptionRejected> <d2p1:IsNameRejected>false</d2p1:IsNameRejected> <d2p1:IsProcessed>false</d2p1:IsProcessed> <d2p1:IsRulesRejected>false</d2p1:IsRulesRejected> <d2p1:Name>String</d2p1:Name> <d2p1:Rules>String</d2p1:Rules> </TempInfo> </UserClubDetail>