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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Comments: 
	[
		{
			Comment: 
			{
				CommentID: 0,
				CommentParentID: 0,
				Subject: String,
				Message: String,
				DateCreated: 0001-01-01,
				Profile: 
				{
					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
				},
				ReplyCount: 0,
				MessageContentType: Text,
				ImageContent: 
				{
					ThumbUrl: String,
					FullUrl: String,
					Height: 0,
					Width: 0,
					Classification: 0,
					IsRestricted: False,
					ImageAction: ShowImage
				},
				GiphyImage: 
				{
					GiphyImageID: String,
					Width: 0,
					Height: 0
				},
				CommentCount: 0,
				IsLiked: False,
				LikeCount: 0
			},
			Vote: 
			{
				VoteID: 0,
				UserID: 0,
				DateCreated: 0001-01-01,
				Score: 0
			}
		}
	],
	TotalItems: 0,
	TotalPages: 0,
	Size: 0,
	Page: 0
}