RHP_API

<back to all web services

GetUserClubPost

Get Club post

Requires Authentication
The following routes are available for this service:
GET/User/Club/Post/{PostID}
GetUserClubPost Parameters:
NameParameterData TypeRequiredDescription
PostIDpathintNo
ClubPostResponse Parameters:
NameParameterData TypeRequiredDescription
PosterformClubSummaryNo
ClubPostIDformintNo
ClubAlbumIDformintNo
MessageformstringNo
MediaformList<MediaItem>No
EventSummaryformEventSummaryNo
CommunityDataformCommunityActionNo
MediaCountformintNo
DateCreatedformDateTimeNo
UserformProfileSummaryNo
ApprovalStateformGenericStatusNo
SEOUrlformstringNo
ClubSummary Parameters:
NameParameterData TypeRequiredDescription
IsOwnerformboolNo
ClubIDformintNo
NameformstringNo
ClubBannerPhotoformClubBannerPhotoNo
MemberCountformint?No
PrivacyTypeformClubPrivacyTypeNo
ClubBannerPhoto Parameters:
NameParameterData TypeRequiredDescription
FullUrlformstringNo
WidthformintNo
HeightformintNo
ApprovalStateformGenericStatusNo
MediaItem Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TypeformMediaTypeNo
PhotoformUserPhotoNo
VideoformUserVideoNo
SEOUrlformstringNo
ApprovalStatusformGenericStatusNo
UserPhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDformintNo
MemberIDformlongNo
MainPhotoformboolNo
LockedformboolNo
RejectedformboolNo
FileNameformstringNo
ClassificationformintNo
WidthformintNo
HeightformintNo
ProfileTypeformboolNo
IsReferformboolNo
PhotoFolderIDformintNo
FeaturedformboolNo
DateCreatedformDateTimeNo
IsAutoReviewformboolNo
SortNumberformintNo
MemberLikeCountformintNo
UserVideo Parameters:
NameParameterData TypeRequiredDescription
ClassificationformPhotoClassificationNo
VideoIDformintNo
VideoUrlformstringNo
ThumbUrlformstringNo
DurationformintNo
ContentTypeformstringNo
ContentLengthformlongNo
HSLVideoUrlformstringNo
VideoCodeformstringNo
EventSummary Parameters:
NameParameterData TypeRequiredDescription
EventIDformintNo
TitleformstringNo
DateHeldformDateTimeNo
DescriptionformstringNo
BannerformstringNo
BannerLockedformboolNo
TimeZoneInfoIDformstringNo
ClubNameformstringNo
EventBannerNameformstringNo
HandleformstringNo
MemberIDformlongNo
ParentTypeformintNo
MemberTypeformshortNo
CategoriesformintNo
StateIDformintNo
StateNameformstringNo
CityformstringNo
CountryNameformstringNo
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

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 /User/Club/Post/{PostID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Poster: 
	{
		IsOwner: False,
		ClubID: 0,
		Name: String,
		ClubBannerPhoto: 
		{
			FullUrl: String,
			Width: 0,
			Height: 0,
			ApprovalState: Pending
		},
		MemberCount: 0,
		PrivacyType: Public
	},
	ClubPostID: 0,
	ClubAlbumID: 0,
	Message: String,
	Media: 
	[
		{
			ID: 0,
			Type: Undefined,
			Photo: 
			{
				PhotoID: 0,
				Gallery: 
				{
					GalleryID: 0,
					Name: String,
					IsPublic: False,
					ImageCount: 0,
					Status: Pending,
					ExpiryDateUTC: 0001-01-01
				},
				ThumbUrl: String,
				FullUrl: String,
				ApprovalStatus: Approved,
				MainPhoto: False,
				Height: 0,
				Width: 0,
				IsUserImage: False,
				Classification: 0,
				PrivateGalleryOnly: False,
				SortOrder: 0
			},
			Video: 
			{
				Classification: Undefined,
				VideoID: 0,
				VideoUrl: String,
				ThumbUrl: String,
				Duration: 0,
				ContentType: String,
				ContentLength: 0,
				HSLVideoUrl: String,
				VideoCode: String
			},
			SEOUrl: String,
			ApprovalStatus: Pending
		}
	],
	EventSummary: 
	{
		EventID: 0,
		Title: String,
		DateHeld: 0001-01-01,
		Description: String,
		Banner: String,
		BannerLocked: False,
		TimeZoneInfoID: String,
		ClubName: String,
		EventBannerName: String,
		Handle: String,
		MemberID: 0,
		ParentType: 0,
		MemberType: 0,
		Categories: 0,
		StateID: 0,
		StateName: String,
		City: String,
		CountryName: String
	},
	CommunityData: 
	{
		CommentCount: 0,
		IsLiked: False,
		LikeCount: 0
	},
	MediaCount: 0,
	DateCreated: 0001-01-01,
	User: 
	{
		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
	},
	ApprovalState: Pending,
	SEOUrl: String
}