RHP_API

<back to all web services

GetUserClubAlbum

Get Club details

Requires Authentication
The following routes are available for this service:
GET/User/Club/Album/{AlbumID}
GetUserClubAlbum Parameters:
NameParameterData TypeRequiredDescription
AlbumIDpathintNo
ClubAlbumDetail Parameters:
NameParameterData TypeRequiredDescription
ClubAlbumIDformintNo
TitleformstringNo
DateCreatedformDateTimeNo
MediaCountformintNo
CommunityActionformCommunityActionNo
ApprovalStateformGenericStatus?No
PosterformClubSummaryNo
SEOUrlformstringNo
CommunityAction Parameters:
NameParameterData TypeRequiredDescription
CommentCountformintNo
CommunityLikeAction Parameters:
NameParameterData TypeRequiredDescription
IsLikedformboolNo
LikeCountformintNo
ClubSummary Parameters:
NameParameterData TypeRequiredDescription
IsOwnerformboolNo
ClubIDformintNo
NameformstringNo
ClubBannerPhotoformClubBannerPhotoNo
MemberCountformint?No
PrivacyTypeformClubPrivacyTypeNo
ClubBannerPhoto Parameters:
NameParameterData TypeRequiredDescription
FullUrlformstringNo
WidthformintNo
HeightformintNo
ApprovalStateformGenericStatusNo

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 /User/Club/Album/{AlbumID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClubAlbumDetail 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>
  <CommunityAction 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>
  </CommunityAction>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <MediaCount>0</MediaCount>
  <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>
  <Title>String</Title>
</ClubAlbumDetail>