RHP_API

GetForumComments

Get comments to a forum message

The following routes are available for this service:
GET	/Forum/Message/{Id}/Comments

**GetForumComments** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No

**Pagination** Parameters:
Name	Parameter	Data Type	Required	Description
Size	form	int	No
Page	form	int	No

**ForumComments** Parameters:
Name	Parameter	Data Type	Required
PaginationInfo	form	PaginationInfo	No
Permission	form	ForumPermission	No
Comments	form	List<ForumComment>	No

**PaginationInfo** Parameters:
Name	Parameter	Data Type	Required	Description
TotalItems	form	int	No
TotalPages	form	int	No

**ForumPermission** Parameters:
Name	Parameter	Data Type	Required	Description
CanPostTopic	form	bool	No	Determines if a user can create a topic on a forum
CanReplyToTopic	form	bool	No	Determines if a user can reply to topics (either message or comment) on a forum

**ForumComment** Parameters:
Name	Parameter	Data Type	Required	Description
ParentID	form	int	No

**ForumMessageBase** Parameters:
Name	Parameter	Data Type	Required
Poster	form	ProfileSummary	No
ID	form	int	No
Title	form	string	No
Message	form	string	No
DatePosted	form	DateTime	No
QuoteTitle	form	string	No
QuoteMsg	form	string	No
MessageContentType	form	MessageContentType	No
ImageContent	form	GenericPhoto	No
GiphyImage	form	GiphyImage	No

**CommunityLikeAction** Parameters:
Name	Parameter	Data Type	Required	Description
IsLiked	form	bool	No
LikeCount	form	int	No

**ProfileSummary** Parameters:
Name	Parameter	Data Type	Required
MemberID	form	long	No
UserName	form	string	No
MemberType	form	short	No
MemberTypeTitle	form	ProfileMemberType	No
Age1	form	int	No
Age2	form	int	No
AgeTitle	form	string	No
Location	form	string	No
MatchingInterests	form	int	No
MainPhoto	form	ProfilePhoto	No
IsOnline	form	bool	No
MemberLevel	form	int	No
IsDiamond	form	bool	No
CountryID	form	int	No
UserType	form	LoginUserType	No
MemberLevelType	form	string	No
IsAdmin	form	bool	No
MemberLevelUserProfile	form	MemberLevelUserProfile	No
IsViewable	form	bool	No

**ProfileMemberType** Parameters:
Name	Parameter	Data Type	Required
Abbr	form	string	No
Singular	form	string	No
Plural	form	string	No

**ProfilePhoto** Parameters:
Name	Parameter	Data Type	Required
PhotoID	form	int	No
Height	form	int	No
Width	form	int	No
ImageType	form	ProfileImageType	No
IsPublic	form	bool	No
Classification	form	int	No
UserType	form	LoginUserType?	No
ShowSafeMode	form	bool	No
ImageActionType	form	ImageActionType	No
GalleryID	form	int	No
IsAccepted	form	bool?	No
MemberLikeCount	form	int	No
IsLiked	form	bool	No
SortNumber	form	int	No

**ProfilePhotoUrl** Parameters:
Name	Parameter	Data Type	Required	Description
ThumbUrl	form	string	No
FullUrl	form	string	No

**GenericPhoto** Parameters:
Name	Parameter	Data Type	Required
ThumbUrl	form	string	No
FullUrl	form	string	No
Height	form	int	No
Width	form	int	No
Classification	form	int	No
IsRestricted	form	bool	No
ImageAction	form	ImageActionType	No

**GiphyImage** Parameters:
Name	Parameter	Data Type	Required
GiphyImageID	form	string	No
Width	form	int	No
Height	form	int	No

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 /Forum/Message/{Id}/Comments HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

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

<ForumComments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Comments>
    <ForumComment>
      <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>
      <DatePosted>0001-01-01T00:00:00</DatePosted>
      <GiphyImage xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
        <d4p1:GiphyImageID>String</d4p1:GiphyImageID>
        <d4p1:Height>0</d4p1:Height>
        <d4p1:Width>0</d4p1:Width>
      </GiphyImage>
      <ID>0</ID>
      <ImageContent xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
        <d4p1:Classification>0</d4p1:Classification>
        <d4p1:FullUrl>String</d4p1:FullUrl>
        <d4p1:Height>0</d4p1:Height>
        <d4p1:ImageAction>ShowImage</d4p1:ImageAction>
        <d4p1:IsRestricted>false</d4p1:IsRestricted>
        <d4p1:ThumbUrl>String</d4p1:ThumbUrl>
        <d4p1:Width>0</d4p1:Width>
      </ImageContent>
      <Message>String</Message>
      <MessageContentType>Text</MessageContentType>
      <Poster xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
        <d4p1:Age1>0</d4p1:Age1>
        <d4p1:Age2>0</d4p1:Age2>
        <d4p1:AgeTitle>String</d4p1:AgeTitle>
        <d4p1:CountryID>0</d4p1:CountryID>
        <d4p1:IsAdmin>false</d4p1:IsAdmin>
        <d4p1:IsDiamond>false</d4p1:IsDiamond>
        <d4p1:IsOnline>false</d4p1:IsOnline>
        <d4p1:IsViewable>false</d4p1:IsViewable>
        <d4p1:Location>String</d4p1:Location>
        <d4p1:MainPhoto>
          <d4p1:FullUrl>String</d4p1:FullUrl>
          <d4p1:ThumbUrl>String</d4p1:ThumbUrl>
          <d4p1:Classification>0</d4p1:Classification>
          <d4p1:GalleryID>0</d4p1:GalleryID>
          <d4p1:Height>0</d4p1:Height>
          <d4p1:ImageActionType>ShowImage</d4p1:ImageActionType>
          <d4p1:ImageType>None</d4p1:ImageType>
          <d4p1:IsAccepted>false</d4p1:IsAccepted>
          <d4p1:IsLiked>false</d4p1:IsLiked>
          <d4p1:IsPublic>false</d4p1:IsPublic>
          <d4p1:MemberLikeCount>0</d4p1:MemberLikeCount>
          <d4p1:PhotoID>0</d4p1:PhotoID>
          <d4p1:ShowSafeMode>false</d4p1:ShowSafeMode>
          <d4p1:SortNumber>0</d4p1:SortNumber>
          <d4p1:UserType>General</d4p1:UserType>
          <d4p1:Width>0</d4p1:Width>
        </d4p1:MainPhoto>
        <d4p1:MatchingInterests>0</d4p1:MatchingInterests>
        <d4p1:MemberID>0</d4p1:MemberID>
        <d4p1:MemberLevel>0</d4p1:MemberLevel>
        <d4p1:MemberLevelType>String</d4p1:MemberLevelType>
        <d4p1:MemberLevelUserProfile>Guest</d4p1:MemberLevelUserProfile>
        <d4p1:MemberType>0</d4p1:MemberType>
        <d4p1:MemberTypeTitle>
          <d4p1:Abbr>String</d4p1:Abbr>
          <d4p1:Plural>String</d4p1:Plural>
          <d4p1:Singular>String</d4p1:Singular>
        </d4p1:MemberTypeTitle>
        <d4p1:UserName>String</d4p1:UserName>
        <d4p1:UserType>General</d4p1:UserType>
      </Poster>
      <QuoteMsg>String</QuoteMsg>
      <QuoteTitle>String</QuoteTitle>
      <Title>String</Title>
      <ParentID>0</ParentID>
    </ForumComment>
  </Comments>
  <PaginationInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:Page>0</d2p1:Page>
    <d2p1:Size>0</d2p1:Size>
    <d2p1:TotalItems>0</d2p1:TotalItems>
  </PaginationInfo>
  <Permission>
    <CanPostTopic>false</CanPostTopic>
    <CanReplyToTopic>false</CanReplyToTopic>
  </Permission>
</ForumComments>