RHP_API

<back to all web services

GetForumThread

Get forum thread, will return a thread consist of forum topic and its messages

Requires Authentication
The following routes are available for this service:
GET/Forum/Topic/{Id}/Thread
GetForumThread Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
ForumThread Parameters:
NameParameterData TypeRequiredDescription
TopicformForumTopicNo
MessagesformList<ForumMessage>No
PaginationInfoformPaginationInfoNo
PermissionformForumPermissionNo
IsOwnerformboolNo
ForumTopic Parameters:
NameParameterData TypeRequiredDescription
PosterformProfileSummaryNo
IDformintNo
TitleformstringNo
MessageformstringNo
DatePostedformDateTimeNo
ReplyCountformintNo
IsFollowingformboolNo
IsGlobalformboolNo
Keywordsformstring[]No
IsStickyformboolNo
IsClosedformboolNo
SEOUrlformstringNo
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
ForumMessage Parameters:
NameParameterData TypeRequiredDescription
ReplyCountformintNo
ForumMessageBase Parameters:
NameParameterData TypeRequiredDescription
PosterformProfileSummaryNo
IDformintNo
TitleformstringNo
MessageformstringNo
DatePostedformDateTimeNo
QuoteTitleformstringNo
QuoteMsgformstringNo
MessageContentTypeformMessageContentTypeNo
ImageContentformGenericPhotoNo
GiphyImageformGiphyImageNo
GenericPhoto Parameters:
NameParameterData TypeRequiredDescription
ThumbUrlformstringNo
FullUrlformstringNo
HeightformintNo
WidthformintNo
ClassificationformintNo
IsRestrictedformboolNo
ImageActionformImageActionTypeNo
GiphyImage Parameters:
NameParameterData TypeRequiredDescription
GiphyImageIDformstringNo
WidthformintNo
HeightformintNo
PaginationInfo Parameters:
NameParameterData TypeRequiredDescription
TotalItemsformintNo
TotalPagesformintNo
ForumPermission Parameters:
NameParameterData TypeRequiredDescription
CanPostTopicformboolNoDetermines if a user can create a topic on a forum
CanReplyToTopicformboolNoDetermines if a user can reply to topics (either message or comment) on a forum

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /Forum/Topic/{Id}/Thread HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Topic":{"Poster":{"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},"ID":0,"Title":"String","Message":"String","DatePosted":"\/Date(-62135596800000-0000)\/","ReplyCount":0,"IsFollowing":false,"IsGlobal":false,"Keywords":["String"],"IsSticky":false,"IsClosed":false,"SEOUrl":"String","IsLiked":false,"LikeCount":0},"Messages":[{"ReplyCount":0,"Poster":{"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},"ID":0,"Title":"String","Message":"String","DatePosted":"\/Date(-62135596800000-0000)\/","QuoteTitle":"String","QuoteMsg":"String","MessageContentType":"Text","ImageContent":{"ThumbUrl":"String","FullUrl":"String","Height":0,"Width":0,"Classification":0,"IsRestricted":false,"ImageAction":"ShowImage"},"GiphyImage":{"GiphyImageID":"String","Width":0,"Height":0},"IsLiked":false,"LikeCount":0}],"PaginationInfo":{"TotalItems":0,"TotalPages":0,"Size":0,"Page":0},"Permission":{"CanPostTopic":false,"CanReplyToTopic":false},"IsOwner":false}