RHP_API

<back to all web services

GetClubAlbums

Get all Album for a Club

Requires Authentication
The following routes are available for this service:
GET/Club/{ClubID}/Album/
GetClubAlbums 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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Club/{ClubID}/Album/ HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":[{"Album":{"ClubAlbumID":0,"Title":"String","DateCreated":"\/Date(-62135596800000-0000)\/","MediaCount":0,"CommunityAction":{"CommentCount":0,"IsLiked":false,"LikeCount":0},"ApprovalState":"Pending","Poster":{"IsOwner":false,"ClubID":0,"Name":"String","ClubBannerPhoto":{"FullUrl":"String","Width":0,"Height":0,"ApprovalState":"Pending"},"MemberCount":0,"PrivacyType":"Public"},"SEOUrl":"String"},"Media":[{"MediaID":0,"ParentID":0,"ParentType":"Undefined","MediaType":"Undefined","Photo":{"ID":0,"FullUrl":"String","Width":0,"Height":0,"ApprovalState":"Pending","ImageType":"None","ImageActionType":"ShowImage","ShowSafeMode":false,"ThumbUrl":"String"},"Video":{"ApprovalState":"Pending","ImageType":"None","ImageActionType":"ShowImage","ShowSafeMode":false,"Classification":"Undefined","VideoID":0,"VideoUrl":"String","ThumbUrl":"String","Duration":0,"ContentType":"String","ContentLength":0,"HSLVideoUrl":"String","VideoCode":"String"},"CommunityAction":{"CommentCount":0,"IsLiked":false,"LikeCount":0},"SEOUrl":"String"}]}],"PaginationInfo":{"TotalItems":0,"TotalPages":0,"Size":0,"Page":0}}