RHP_API

<back to all web services

UpdateUserClubAlbum

Update Club album details (Title)

Requires Authentication
The following routes are available for this service:
PATCH/User/Club/Album/{AlbumID}
UpdateUserClubAlbum Parameters:
NameParameterData TypeRequiredDescription
AlbumIDpathintNo
UserClubAlbumForm Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PATCH /User/Club/Album/{AlbumID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AlbumID":0,"Title":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}