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 .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.

GET /OnTheGround/Video/{ID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OnTheGroundVideoDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <IsLiked xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsLiked>
  <LikeCount xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</LikeCount>
  <CommentCount xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</CommentCount>
  <ID>0</ID>
  <ImageUrl>String</ImageUrl>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <Title>String</Title>
  <Description>String</Description>
  <Owner />
  <OwnerType>None</OwnerType>
  <SEOUrl>String</SEOUrl>
  <VideoCode>String</VideoCode>
  <VideoType>NA</VideoType>
  <VideoUrl>String</VideoUrl>
</OnTheGroundVideoDetail>