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

{
	ClubAlbumID: 0,
	Title: String,
	DateCreated: 0001-01-01,
	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
}