RHP_API

<back to all web services

GetOnTheGroundVideo

The following routes are available for this service:
GET/OnTheGround/Video/{ID}
GetOnTheGroundVideo Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
OnTheGroundVideoDetail Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
VideoUrlformstringNo
VideoCodeformstringNo
VideoTypeformVideoTypeNo
OwnerformObjectNo
OwnerTypeformOnTheGroundOwnerTypeNo
SEOUrlformstringNo
OnTheGroundListItemBase Parameters:
NameParameterData TypeRequiredDescription
DateCreatedformDateTimeNo
TitleformstringNo
OnTheGroundItemBase Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
ImageUrlformstringNo
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 .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 /OnTheGround/Video/{ID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Description: String,
	VideoUrl: String,
	VideoCode: String,
	VideoType: NA,
	Owner: {},
	OwnerType: None,
	SEOUrl: String,
	DateCreated: 0001-01-01,
	Title: String,
	ID: 0,
	ImageUrl: String,
	CommentCount: 0,
	IsLiked: False,
	LikeCount: 0
}