RHP_API

<back to all web services

GetClubMediaVideoUploadProgress

Returns video processing progress data

Requires Authentication
The following routes are available for this service:
GET/User/Club/Media/Video/UploadProgress
GetClubMediaVideoUploadProgress Parameters:
NameParameterData TypeRequiredDescription
ParentIDqueryintNo
ParentTypequeryClubMediaParentTypeNo
UserUploadVideoProgress Parameters:
NameParameterData TypeRequiredDescription
StatusformUserUploadVideoProgressStatusNo
ResponseformCreateUserVideoResponseItemNo
CreateUserVideoResponseItem Parameters:
NameParameterData TypeRequiredDescription
OriginalFileNameformstringNo
IsUploadSuccessformboolNo
MessageformstringNo
VideoformUserVideoNo
ErrorCodeformstringNo
UserVideo Parameters:
NameParameterData TypeRequiredDescription
ClassificationformPhotoClassificationNo
VideoIDformintNo
VideoUrlformstringNo
ThumbUrlformstringNo
DurationformintNo
ContentTypeformstringNo
ContentLengthformlongNo
HSLVideoUrlformstringNo
VideoCodeformstringNo

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/Media/Video/UploadProgress HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Status: InProgress,
	Response: 
	{
		OriginalFileName: String,
		IsUploadSuccess: False,
		Message: String,
		Video: 
		{
			Classification: Undefined,
			VideoID: 0,
			VideoUrl: String,
			ThumbUrl: String,
			Duration: 0,
			ContentType: String,
			ContentLength: 0,
			HSLVideoUrl: String,
			VideoCode: String
		},
		ErrorCode: String
	}
}