RHP_API

<back to all web services

GetClubVoteComments

Get all VoteComments for a club (Club Reviews)

Requires Authentication
The following routes are available for this service:
GET/Club/{ID}/VoteComment
GetClubVoteComments Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
VoteCommentList Parameters:
NameParameterData TypeRequiredDescription
CommentsformList<CommentVotes>No
PaginationInfo Parameters:
NameParameterData TypeRequiredDescription
TotalItemsformintNo
TotalPagesformintNo
CommentVotes Parameters:
NameParameterData TypeRequiredDescription
CommentformCommentNo
VoteformVoteNo
Comment Parameters:
NameParameterData TypeRequiredDescription
CommentIDformintNo
CommentParentIDformintNo
SubjectformstringNo
MessageformstringNo
DateCreatedformDateTimeNo
ProfileformProfileSummaryNo
ReplyCountformintNo
MessageContentTypeformMessageContentTypeNo
ImageContentformGenericPhotoNo
GiphyImageformGiphyImageNo
CommunityAction Parameters:
NameParameterData TypeRequiredDescription
CommentCountformintNo
CommunityLikeAction Parameters:
NameParameterData TypeRequiredDescription
IsLikedformboolNo
LikeCountformintNo
ProfileSummary Parameters:
NameParameterData TypeRequiredDescription
MemberIDformlongNo
UserNameformstringNo
MemberTypeformshortNo
MemberTypeTitleformProfileMemberTypeNo
Age1formintNo
Age2formintNo
AgeTitleformstringNo
LocationformstringNo
MatchingInterestsformintNo
MainPhotoformProfilePhotoNo
IsOnlineformboolNo
MemberLevelformintNo
IsDiamondformboolNo
CountryIDformintNo
UserTypeformLoginUserTypeNo
MemberLevelTypeformstringNo
IsAdminformboolNo
MemberLevelUserProfileformMemberLevelUserProfileNo
IsViewableformboolNo
ProfileMemberType Parameters:
NameParameterData TypeRequiredDescription
AbbrformstringNo
SingularformstringNo
PluralformstringNo
ProfilePhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDformintNo
HeightformintNo
WidthformintNo
ImageTypeformProfileImageTypeNo
IsPublicformboolNo
ClassificationformintNo
UserTypeformLoginUserType?No
ShowSafeModeformboolNo
ImageActionTypeformImageActionTypeNo
GalleryIDformintNo
IsAcceptedformbool?No
MemberLikeCountformintNo
IsLikedformboolNo
SortNumberformintNo
ProfilePhotoUrl Parameters:
NameParameterData TypeRequiredDescription
ThumbUrlformstringNo
FullUrlformstringNo
GenericPhoto Parameters:
NameParameterData TypeRequiredDescription
ThumbUrlformstringNo
FullUrlformstringNo
HeightformintNo
WidthformintNo
ClassificationformintNo
IsRestrictedformboolNo
ImageActionformImageActionTypeNo
GiphyImage Parameters:
NameParameterData TypeRequiredDescription
GiphyImageIDformstringNo
WidthformintNo
HeightformintNo
Vote Parameters:
NameParameterData TypeRequiredDescription
VoteIDformintNo
UserIDformlongNo
DateCreatedformDateTimeNo
ScoreformintNo

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

HTTP + XML

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

GET /Club/{ID}/VoteComment HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VoteCommentList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Page xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Page>
  <Size xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Size>
  <TotalItems xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</TotalItems>
  <Comments>
    <CommentVotes>
      <Comment>
        <IsLiked xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsLiked>
        <LikeCount xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</LikeCount>
        <CommentCount xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</CommentCount>
        <CommentID>0</CommentID>
        <CommentParentID>0</CommentParentID>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <GiphyImage xmlns:d5p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
          <d5p1:GiphyImageID>String</d5p1:GiphyImageID>
          <d5p1:Height>0</d5p1:Height>
          <d5p1:Width>0</d5p1:Width>
        </GiphyImage>
        <ImageContent xmlns:d5p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
          <d5p1:Classification>0</d5p1:Classification>
          <d5p1:FullUrl>String</d5p1:FullUrl>
          <d5p1:Height>0</d5p1:Height>
          <d5p1:ImageAction>ShowImage</d5p1:ImageAction>
          <d5p1:IsRestricted>false</d5p1:IsRestricted>
          <d5p1:ThumbUrl>String</d5p1:ThumbUrl>
          <d5p1:Width>0</d5p1:Width>
        </ImageContent>
        <Message>String</Message>
        <MessageContentType>Text</MessageContentType>
        <Profile xmlns:d5p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
          <d5p1:Age1>0</d5p1:Age1>
          <d5p1:Age2>0</d5p1:Age2>
          <d5p1:AgeTitle>String</d5p1:AgeTitle>
          <d5p1:CountryID>0</d5p1:CountryID>
          <d5p1:IsAdmin>false</d5p1:IsAdmin>
          <d5p1:IsDiamond>false</d5p1:IsDiamond>
          <d5p1:IsOnline>false</d5p1:IsOnline>
          <d5p1:IsViewable>false</d5p1:IsViewable>
          <d5p1:Location>String</d5p1:Location>
          <d5p1:MainPhoto>
            <d5p1:FullUrl>String</d5p1:FullUrl>
            <d5p1:ThumbUrl>String</d5p1:ThumbUrl>
            <d5p1:Classification>0</d5p1:Classification>
            <d5p1:GalleryID>0</d5p1:GalleryID>
            <d5p1:Height>0</d5p1:Height>
            <d5p1:ImageActionType>ShowImage</d5p1:ImageActionType>
            <d5p1:ImageType>None</d5p1:ImageType>
            <d5p1:IsAccepted>false</d5p1:IsAccepted>
            <d5p1:IsLiked>false</d5p1:IsLiked>
            <d5p1:IsPublic>false</d5p1:IsPublic>
            <d5p1:MemberLikeCount>0</d5p1:MemberLikeCount>
            <d5p1:PhotoID>0</d5p1:PhotoID>
            <d5p1:ShowSafeMode>false</d5p1:ShowSafeMode>
            <d5p1:SortNumber>0</d5p1:SortNumber>
            <d5p1:UserType>General</d5p1:UserType>
            <d5p1:Width>0</d5p1:Width>
          </d5p1:MainPhoto>
          <d5p1:MatchingInterests>0</d5p1:MatchingInterests>
          <d5p1:MemberID>0</d5p1:MemberID>
          <d5p1:MemberLevel>0</d5p1:MemberLevel>
          <d5p1:MemberLevelType>String</d5p1:MemberLevelType>
          <d5p1:MemberLevelUserProfile>Guest</d5p1:MemberLevelUserProfile>
          <d5p1:MemberType>0</d5p1:MemberType>
          <d5p1:MemberTypeTitle>
            <d5p1:Abbr>String</d5p1:Abbr>
            <d5p1:Plural>String</d5p1:Plural>
            <d5p1:Singular>String</d5p1:Singular>
          </d5p1:MemberTypeTitle>
          <d5p1:UserName>String</d5p1:UserName>
          <d5p1:UserType>General</d5p1:UserType>
        </Profile>
        <ReplyCount>0</ReplyCount>
        <Subject>String</Subject>
      </Comment>
      <Vote>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <Score>0</Score>
        <UserID>0</UserID>
        <VoteID>0</VoteID>
      </Vote>
    </CommentVotes>
  </Comments>
</VoteCommentList>