RHP_API

<back to all web services

GetUserClubAlbums

Get all Club albums

Requires Authentication
The following routes are available for this service:
GET/User/Club/{ClubID}/Album
GetUserClubAlbums Parameters:
NameParameterData TypeRequiredDescription
ClubIDpathintNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
GenericListPaginationInfoResponse<T> Parameters:
NameParameterData TypeRequiredDescription
DataformList<T>No
PaginationInfoformPaginationInfoNo
PaginationInfo Parameters:
NameParameterData TypeRequiredDescription
TotalItemsformintNo
TotalPagesformintNo

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

<GenericListPaginationInfoResponseOfClubAlbumItemSjC_PYTVK xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
    <d2p1:ClubAlbumItem>
      <d2p1:Album>
        <d2p1:ApprovalState>Pending</d2p1:ApprovalState>
        <d2p1:ClubAlbumID>0</d2p1:ClubAlbumID>
        <d2p1:CommunityAction>
          <IsLiked>false</IsLiked>
          <LikeCount>0</LikeCount>
          <CommentCount>0</CommentCount>
        </d2p1:CommunityAction>
        <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
        <d2p1:MediaCount>0</d2p1:MediaCount>
        <d2p1:Poster>
          <d2p1:ClubBannerPhoto>
            <ApprovalState>Pending</ApprovalState>
            <FullUrl>String</FullUrl>
            <Height>0</Height>
            <Width>0</Width>
          </d2p1:ClubBannerPhoto>
          <d2p1:ClubID>0</d2p1:ClubID>
          <d2p1:IsOwner>false</d2p1:IsOwner>
          <d2p1:MemberCount>0</d2p1:MemberCount>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:PrivacyType>Public</d2p1:PrivacyType>
        </d2p1:Poster>
        <d2p1:SEOUrl>String</d2p1:SEOUrl>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:Album>
      <d2p1:Media>
        <d2p1:ClubMediaItem>
          <d2p1:CommunityAction>
            <IsLiked>false</IsLiked>
            <LikeCount>0</LikeCount>
            <CommentCount>0</CommentCount>
          </d2p1:CommunityAction>
          <d2p1:MediaID>0</d2p1:MediaID>
          <d2p1:MediaType>Undefined</d2p1:MediaType>
          <d2p1:ParentID>0</d2p1:ParentID>
          <d2p1:ParentType>Undefined</d2p1:ParentType>
          <d2p1:Photo>
            <ApprovalState>Pending</ApprovalState>
            <FullUrl>String</FullUrl>
            <Height>0</Height>
            <ID>0</ID>
            <ImageActionType>ShowImage</ImageActionType>
            <ImageType>None</ImageType>
            <ShowSafeMode>false</ShowSafeMode>
            <ThumbUrl>String</ThumbUrl>
            <Width>0</Width>
          </d2p1:Photo>
          <d2p1:SEOUrl>String</d2p1:SEOUrl>
          <d2p1:Video>
            <Classification>Undefined</Classification>
            <ContentLength>0</ContentLength>
            <ContentType>String</ContentType>
            <Duration>0</Duration>
            <HSLVideoUrl>String</HSLVideoUrl>
            <ThumbUrl>String</ThumbUrl>
            <VideoCode>String</VideoCode>
            <VideoID>0</VideoID>
            <VideoUrl>String</VideoUrl>
            <ApprovalState>Pending</ApprovalState>
            <ImageActionType>ShowImage</ImageActionType>
            <ImageType>None</ImageType>
            <ShowSafeMode>false</ShowSafeMode>
          </d2p1:Video>
        </d2p1:ClubMediaItem>
      </d2p1:Media>
    </d2p1:ClubAlbumItem>
  </Data>
  <PaginationInfo>
    <Page>0</Page>
    <Size>0</Size>
    <TotalItems>0</TotalItems>
  </PaginationInfo>
</GenericListPaginationInfoResponseOfClubAlbumItemSjC_PYTVK>