RHP_API

<back to all web services

GetSubForumSummary

Get sub-forum summaries

Requires Authentication
The following routes are available for this service:
GET/Forum/Summary/{Id}/SubForum
GetSubForumSummary Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
StateIDqueryintNo
IncludeTopicDataqueryboolNo

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		TopicCount: 0,
		PostCount: 0,
		TopicSummaryItems: 
		[
			{
				TopicItem: 
				{
					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: 0001-01-01,
					ReplyCount: 0,
					LikeCount: 0
				},
				LastMessageItem: 
				{
					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
					},
					DatePosted: 0001-01-01
				}
			}
		],
		Permission: 
		{
			CanPostTopic: False,
			CanReplyToTopic: False
		},
		ForumID: 0,
		ForumName: String,
		Description: String,
		SortNumber: 0
	}
]