RHP_API

GetSubForumSummary

Get sub-forum summaries

The following routes are available for this service:
GET	/Forum/Summary/{Id}/SubForum

**GetSubForumSummary** Parameters:
Name	Parameter	Data Type	Required
Id	path	int	No
StateID	query	int	No
IncludeTopicData	query	bool	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/Summary/{Id}/SubForum HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

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

<ArrayOfForumSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <ForumSummary>
    <Description>String</Description>
    <ForumID>0</ForumID>
    <ForumName>String</ForumName>
    <Permission>
      <CanPostTopic>false</CanPostTopic>
      <CanReplyToTopic>false</CanReplyToTopic>
    </Permission>
    <SortNumber>0</SortNumber>
    <PostCount>0</PostCount>
    <TopicCount>0</TopicCount>
    <TopicSummaryItems>
      <ForumTopicSummaryItem>
        <LastMessageItem>
          <DatePosted>0001-01-01T00:00:00</DatePosted>
          <Poster xmlns:d6p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
            <d6p1:Age1>0</d6p1:Age1>
            <d6p1:Age2>0</d6p1:Age2>
            <d6p1:AgeTitle>String</d6p1:AgeTitle>
            <d6p1:CountryID>0</d6p1:CountryID>
            <d6p1:IsAdmin>false</d6p1:IsAdmin>
            <d6p1:IsDiamond>false</d6p1:IsDiamond>
            <d6p1:IsOnline>false</d6p1:IsOnline>
            <d6p1:IsViewable>false</d6p1:IsViewable>
            <d6p1:Location>String</d6p1:Location>
            <d6p1:MainPhoto>
              <d6p1:FullUrl>String</d6p1:FullUrl>
              <d6p1:ThumbUrl>String</d6p1:ThumbUrl>
              <d6p1:Classification>0</d6p1:Classification>
              <d6p1:GalleryID>0</d6p1:GalleryID>
              <d6p1:Height>0</d6p1:Height>
              <d6p1:ImageActionType>ShowImage</d6p1:ImageActionType>
              <d6p1:ImageType>None</d6p1:ImageType>
              <d6p1:IsAccepted>false</d6p1:IsAccepted>
              <d6p1:IsLiked>false</d6p1:IsLiked>
              <d6p1:IsPublic>false</d6p1:IsPublic>
              <d6p1:MemberLikeCount>0</d6p1:MemberLikeCount>
              <d6p1:PhotoID>0</d6p1:PhotoID>
              <d6p1:ShowSafeMode>false</d6p1:ShowSafeMode>
              <d6p1:SortNumber>0</d6p1:SortNumber>
              <d6p1:UserType>General</d6p1:UserType>
              <d6p1:Width>0</d6p1:Width>
            </d6p1:MainPhoto>
            <d6p1:MatchingInterests>0</d6p1:MatchingInterests>
            <d6p1:MemberID>0</d6p1:MemberID>
            <d6p1:MemberLevel>0</d6p1:MemberLevel>
            <d6p1:MemberLevelType>String</d6p1:MemberLevelType>
            <d6p1:MemberLevelUserProfile>Guest</d6p1:MemberLevelUserProfile>
            <d6p1:MemberType>0</d6p1:MemberType>
            <d6p1:MemberTypeTitle>
              <d6p1:Abbr>String</d6p1:Abbr>
              <d6p1:Plural>String</d6p1:Plural>
              <d6p1:Singular>String</d6p1:Singular>
            </d6p1:MemberTypeTitle>
            <d6p1:UserName>String</d6p1:UserName>
            <d6p1:UserType>General</d6p1:UserType>
          </Poster>
        </LastMessageItem>
        <TopicItem>
          <DatePosted>0001-01-01T00:00:00</DatePosted>
          <ID>0</ID>
          <LikeCount>0</LikeCount>
          <Message>String</Message>
          <Poster xmlns:d6p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
            <d6p1:Age1>0</d6p1:Age1>
            <d6p1:Age2>0</d6p1:Age2>
            <d6p1:AgeTitle>String</d6p1:AgeTitle>
            <d6p1:CountryID>0</d6p1:CountryID>
            <d6p1:IsAdmin>false</d6p1:IsAdmin>
            <d6p1:IsDiamond>false</d6p1:IsDiamond>
            <d6p1:IsOnline>false</d6p1:IsOnline>
            <d6p1:IsViewable>false</d6p1:IsViewable>
            <d6p1:Location>String</d6p1:Location>
            <d6p1:MainPhoto>
              <d6p1:FullUrl>String</d6p1:FullUrl>
              <d6p1:ThumbUrl>String</d6p1:ThumbUrl>
              <d6p1:Classification>0</d6p1:Classification>
              <d6p1:GalleryID>0</d6p1:GalleryID>
              <d6p1:Height>0</d6p1:Height>
              <d6p1:ImageActionType>ShowImage</d6p1:ImageActionType>
              <d6p1:ImageType>None</d6p1:ImageType>
              <d6p1:IsAccepted>false</d6p1:IsAccepted>
              <d6p1:IsLiked>false</d6p1:IsLiked>
              <d6p1:IsPublic>false</d6p1:IsPublic>
              <d6p1:MemberLikeCount>0</d6p1:MemberLikeCount>
              <d6p1:PhotoID>0</d6p1:PhotoID>
              <d6p1:ShowSafeMode>false</d6p1:ShowSafeMode>
              <d6p1:SortNumber>0</d6p1:SortNumber>
              <d6p1:UserType>General</d6p1:UserType>
              <d6p1:Width>0</d6p1:Width>
            </d6p1:MainPhoto>
            <d6p1:MatchingInterests>0</d6p1:MatchingInterests>
            <d6p1:MemberID>0</d6p1:MemberID>
            <d6p1:MemberLevel>0</d6p1:MemberLevel>
            <d6p1:MemberLevelType>String</d6p1:MemberLevelType>
            <d6p1:MemberLevelUserProfile>Guest</d6p1:MemberLevelUserProfile>
            <d6p1:MemberType>0</d6p1:MemberType>
            <d6p1:MemberTypeTitle>
              <d6p1:Abbr>String</d6p1:Abbr>
              <d6p1:Plural>String</d6p1:Plural>
              <d6p1:Singular>String</d6p1:Singular>
            </d6p1:MemberTypeTitle>
            <d6p1:UserName>String</d6p1:UserName>
            <d6p1:UserType>General</d6p1:UserType>
          </Poster>
          <ReplyCount>0</ReplyCount>
          <Title>String</Title>
        </TopicItem>
      </ForumTopicSummaryItem>
    </TopicSummaryItems>
  </ForumSummary>
</ArrayOfForumSummary>