RHP_API

<back to all web services

GetClubPost

Get club post.

Requires Authentication
The following routes are available for this service:
GET/Club/Post/{PostID}
GetClubPost 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 .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 /Club/Post/{PostID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClubPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <ApprovalState>Pending</ApprovalState>
  <ClubAlbumID>0</ClubAlbumID>
  <ClubPostID>0</ClubPostID>
  <CommunityData xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:IsLiked>false</d2p1:IsLiked>
    <d2p1:LikeCount>0</d2p1:LikeCount>
    <d2p1:CommentCount>0</d2p1:CommentCount>
  </CommunityData>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <EventSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.Model">
    <d2p1:Banner>String</d2p1:Banner>
    <d2p1:BannerLocked>false</d2p1:BannerLocked>
    <d2p1:Categories>0</d2p1:Categories>
    <d2p1:City>String</d2p1:City>
    <d2p1:ClubName>String</d2p1:ClubName>
    <d2p1:CountryName>String</d2p1:CountryName>
    <d2p1:DateHeld>0001-01-01T00:00:00</d2p1:DateHeld>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:EventBannerName>String</d2p1:EventBannerName>
    <d2p1:EventID>0</d2p1:EventID>
    <d2p1:Handle>String</d2p1:Handle>
    <d2p1:MemberID>0</d2p1:MemberID>
    <d2p1:MemberType>0</d2p1:MemberType>
    <d2p1:ParentType>0</d2p1:ParentType>
    <d2p1:StateID>0</d2p1:StateID>
    <d2p1:StateName>String</d2p1:StateName>
    <d2p1:TimeZoneInfoID>String</d2p1:TimeZoneInfoID>
    <d2p1:Title>String</d2p1:Title>
  </EventSummary>
  <Media xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:MediaItem>
      <d2p1:ApprovalStatus>Pending</d2p1:ApprovalStatus>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:Photo>
        <d2p1:ApprovalStatus>Approved</d2p1:ApprovalStatus>
        <d2p1:Classification>0</d2p1:Classification>
        <d2p1:FullUrl>String</d2p1:FullUrl>
        <d2p1:Gallery>
          <d2p1:ExpiryDateUTC>0001-01-01T00:00:00</d2p1:ExpiryDateUTC>
          <d2p1:GalleryID>0</d2p1:GalleryID>
          <d2p1:ImageCount>0</d2p1:ImageCount>
          <d2p1:IsPublic>false</d2p1:IsPublic>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Status>Pending</d2p1:Status>
        </d2p1:Gallery>
        <d2p1:Height>0</d2p1:Height>
        <d2p1:IsUserImage>false</d2p1:IsUserImage>
        <d2p1:MainPhoto>false</d2p1:MainPhoto>
        <d2p1:PhotoID>0</d2p1:PhotoID>
        <d2p1:PrivateGalleryOnly>false</d2p1:PrivateGalleryOnly>
        <d2p1:SortOrder>0</d2p1:SortOrder>
        <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
        <d2p1:Width>0</d2p1:Width>
      </d2p1:Photo>
      <d2p1:SEOUrl>String</d2p1:SEOUrl>
      <d2p1:Type>Undefined</d2p1:Type>
      <d2p1:Video>
        <d2p1:Classification>Undefined</d2p1:Classification>
        <d2p1:ContentLength>0</d2p1:ContentLength>
        <d2p1:ContentType>String</d2p1:ContentType>
        <d2p1:Duration>0</d2p1:Duration>
        <d2p1:HSLVideoUrl>String</d2p1:HSLVideoUrl>
        <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
        <d2p1:VideoCode>String</d2p1:VideoCode>
        <d2p1:VideoID>0</d2p1:VideoID>
        <d2p1:VideoUrl>String</d2p1:VideoUrl>
      </d2p1:Video>
    </d2p1:MediaItem>
  </Media>
  <MediaCount>0</MediaCount>
  <Message>String</Message>
  <Poster>
    <ClubBannerPhoto xmlns:d3p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <d3p1:ApprovalState>Pending</d3p1:ApprovalState>
      <d3p1:FullUrl>String</d3p1:FullUrl>
      <d3p1:Height>0</d3p1:Height>
      <d3p1:Width>0</d3p1:Width>
    </ClubBannerPhoto>
    <ClubID>0</ClubID>
    <IsOwner>false</IsOwner>
    <MemberCount>0</MemberCount>
    <Name>String</Name>
    <PrivacyType>Public</PrivacyType>
  </Poster>
  <SEOUrl>String</SEOUrl>
  <User xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:Age1>0</d2p1:Age1>
    <d2p1:Age2>0</d2p1:Age2>
    <d2p1:AgeTitle>String</d2p1:AgeTitle>
    <d2p1:CountryID>0</d2p1:CountryID>
    <d2p1:IsAdmin>false</d2p1:IsAdmin>
    <d2p1:IsDiamond>false</d2p1:IsDiamond>
    <d2p1:IsOnline>false</d2p1:IsOnline>
    <d2p1:IsViewable>false</d2p1:IsViewable>
    <d2p1:Location>String</d2p1:Location>
    <d2p1:MainPhoto>
      <d2p1:FullUrl>String</d2p1:FullUrl>
      <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
      <d2p1:Classification>0</d2p1:Classification>
      <d2p1:GalleryID>0</d2p1:GalleryID>
      <d2p1:Height>0</d2p1:Height>
      <d2p1:ImageActionType>ShowImage</d2p1:ImageActionType>
      <d2p1:ImageType>None</d2p1:ImageType>
      <d2p1:IsAccepted>false</d2p1:IsAccepted>
      <d2p1:IsLiked>false</d2p1:IsLiked>
      <d2p1:IsPublic>false</d2p1:IsPublic>
      <d2p1:MemberLikeCount>0</d2p1:MemberLikeCount>
      <d2p1:PhotoID>0</d2p1:PhotoID>
      <d2p1:ShowSafeMode>false</d2p1:ShowSafeMode>
      <d2p1:SortNumber>0</d2p1:SortNumber>
      <d2p1:UserType>General</d2p1:UserType>
      <d2p1:Width>0</d2p1:Width>
    </d2p1:MainPhoto>
    <d2p1:MatchingInterests>0</d2p1:MatchingInterests>
    <d2p1:MemberID>0</d2p1:MemberID>
    <d2p1:MemberLevel>0</d2p1:MemberLevel>
    <d2p1:MemberLevelType>String</d2p1:MemberLevelType>
    <d2p1:MemberLevelUserProfile>Guest</d2p1:MemberLevelUserProfile>
    <d2p1:MemberType>0</d2p1:MemberType>
    <d2p1:MemberTypeTitle>
      <d2p1:Abbr>String</d2p1:Abbr>
      <d2p1:Plural>String</d2p1:Plural>
      <d2p1:Singular>String</d2p1:Singular>
    </d2p1:MemberTypeTitle>
    <d2p1:UserName>String</d2p1:UserName>
    <d2p1:UserType>General</d2p1:UserType>
  </User>
</ClubPostResponse>