RHP_API

<back to all web services

SearchForumByTitle

Get list of topics based on keyword in topic title

Requires Authentication
The following routes are available for this service:
GET/Forum/Search/Title
SearchForumByTitle Parameters:
NameParameterData TypeRequiredDescription
TermquerystringNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
ForumTopicList Parameters:
NameParameterData TypeRequiredDescription
TopicsformList<ForumTopicListItem>No
PaginationInfoformPaginationInfoNo
ForumTopicListItem Parameters:
NameParameterData TypeRequiredDescription
TopicformForumTopicNo
LastMessageItemformLastMessageItemNo
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
LastMessageItem Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
ForumMessageSummaryListItem Parameters:
NameParameterData TypeRequiredDescription
PosterformProfileSummaryNo
DatePostedformDateTimeNo
PaginationInfo Parameters:
NameParameterData TypeRequiredDescription
TotalItemsformintNo
TotalPagesformintNo

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/Search/Title HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ForumTopicList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <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>
  <Topics>
    <ForumTopicListItem>
      <LastMessageItem>
        <DatePosted>0001-01-01T00:00:00</DatePosted>
        <Poster 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>
        </Poster>
        <Message>String</Message>
      </LastMessageItem>
      <Topic>
        <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>
        <ID>0</ID>
        <IsClosed>false</IsClosed>
        <IsFollowing>false</IsFollowing>
        <IsGlobal>false</IsGlobal>
        <IsSticky>false</IsSticky>
        <Keywords xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Keywords>
        <Message>String</Message>
        <Poster 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>
        </Poster>
        <ReplyCount>0</ReplyCount>
        <SEOUrl>String</SEOUrl>
        <Title>String</Title>
      </Topic>
    </ForumTopicListItem>
  </Topics>
</ForumTopicList>