RHP_API

<back to all web services

CreateUserClubMediaPhoto

Upload photo for Albums or Posts

Requires Authentication
The following routes are available for this service:
POST/User/Club/Media/Photo
CreateUserClubMediaPhoto Parameters:
NameParameterData TypeRequiredDescription
ParentIDbodyintNo
ParentTypebodyClubMediaParentTypeNo
SortNumberbodyintNo
ClubMediaItem Parameters:
NameParameterData TypeRequiredDescription
MediaIDformintNo
ParentIDformintNo
ParentTypeformClubMediaParentTypeNo
MediaTypeformMediaTypeNo
PhotoformClubMediaPhotoNo
VideoformClubMediaVideoNo
CommunityActionformCommunityActionNo
SEOUrlformstringNo
ClubMediaPhoto Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
FullUrlformstringNo
WidthformintNo
HeightformintNo
ApprovalStateformGenericStatusNo
ImageTypeformProfileImageTypeNo
ImageActionTypeformImageActionTypeNo
ShowSafeModeformboolNo
ThumbUrlformstringNo
ClubMediaVideo Parameters:
NameParameterData TypeRequiredDescription
ApprovalStateformGenericStatusNo
ImageTypeformProfileImageTypeNo
ImageActionTypeformImageActionTypeNo
ShowSafeModeformboolNo
UserVideo Parameters:
NameParameterData TypeRequiredDescription
ClassificationformPhotoClassificationNo
VideoIDformintNo
VideoUrlformstringNo
ThumbUrlformstringNo
DurationformintNo
ContentTypeformstringNo
ContentLengthformlongNo
HSLVideoUrlformstringNo
VideoCodeformstringNo
CommunityAction Parameters:
NameParameterData TypeRequiredDescription
CommentCountformintNo
CommunityLikeAction Parameters:
NameParameterData TypeRequiredDescription
IsLikedformboolNo
LikeCountformintNo

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.

POST /User/Club/Media/Photo HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateUserClubMediaPhoto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <ParentID>0</ParentID>
  <ParentType>Undefined</ParentType>
  <SortNumber>0</SortNumber>
</CreateUserClubMediaPhoto>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClubMediaItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <CommunityAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:IsLiked>false</d2p1:IsLiked>
    <d2p1:LikeCount>0</d2p1:LikeCount>
    <d2p1:CommentCount>0</d2p1:CommentCount>
  </CommunityAction>
  <MediaID>0</MediaID>
  <MediaType>Undefined</MediaType>
  <ParentID>0</ParentID>
  <ParentType>Undefined</ParentType>
  <Photo xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:ApprovalState>Pending</d2p1:ApprovalState>
    <d2p1:FullUrl>String</d2p1:FullUrl>
    <d2p1:Height>0</d2p1:Height>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:ImageActionType>ShowImage</d2p1:ImageActionType>
    <d2p1:ImageType>None</d2p1:ImageType>
    <d2p1:ShowSafeMode>false</d2p1:ShowSafeMode>
    <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
    <d2p1:Width>0</d2p1:Width>
  </Photo>
  <SEOUrl>String</SEOUrl>
  <Video xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:Classification>Undefined</d2p1:Classification>
    <d2p1:ContentLength>0</d2p1:ContentLength>
    <d2p1:ContentType>String</d2p1:ContentType>
    <d2p1:Duration>0</d2p1:Duration>
    <d2p1:HSLVideoUrl>String</d2p1:HSLVideoUrl>
    <d2p1:ThumbUrl>String</d2p1:ThumbUrl>
    <d2p1:VideoCode>String</d2p1:VideoCode>
    <d2p1:VideoID>0</d2p1:VideoID>
    <d2p1:VideoUrl>String</d2p1:VideoUrl>
    <d2p1:ApprovalState>Pending</d2p1:ApprovalState>
    <d2p1:ImageActionType>ShowImage</d2p1:ImageActionType>
    <d2p1:ImageType>None</d2p1:ImageType>
    <d2p1:ShowSafeMode>false</d2p1:ShowSafeMode>
  </Video>
</ClubMediaItem>