RHP_API

<back to all web services

GetClubAlbumMediaList

Get all club media item in an album

Requires Authentication
The following routes are available for this service:
GET/Club/Album/{AlbumID}/Media
GetClubAlbumMediaList Parameters:
NameParameterData TypeRequiredDescription
AlbumIDpathintNo
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 .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 /Club/Album/{AlbumID}/Media HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			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
	}
}