RHP_API

<back to all web services

GetArticleComments

The following routes are available for this service:
GET/Article/{ID}/Comment
GetArticleComments Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
CommentList Parameters:
NameParameterData TypeRequiredDescription
CommentsformList<Comment>No
PaginationInfo Parameters:
NameParameterData TypeRequiredDescription
TotalItemsformintNo
TotalPagesformintNo
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

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 /Article/{ID}/Comment HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommentList 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>
    <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: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>
      <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>
      <Profile 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>
      </Profile>
      <ReplyCount>0</ReplyCount>
      <Subject>String</Subject>
    </Comment>
  </Comments>
</CommentList>