RHP_API

<back to all web services

GetOnTheGroundListItems

The following routes are available for this service:
GET/OnTheGround
GetOnTheGroundListItems Parameters:
NameParameterData TypeRequiredDescription
CategoryqueryOnTheGroundLookupTypeNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo

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 HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfOnTheGroundListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <OnTheGroundListItem>
    <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>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <Description>String</Description>
    <ID>0</ID>
    <ImageUrl>String</ImageUrl>
    <Owner />
    <OwnerType>None</OwnerType>
    <PhotoCount>0</PhotoCount>
    <PhotoUrls>
      <OnTheGroundPhotoUrl>
        <FullUrl>String</FullUrl>
        <ThumbUrl>String</ThumbUrl>
      </OnTheGroundPhotoUrl>
    </PhotoUrls>
    <SEOUrl>String</SEOUrl>
    <Title>String</Title>
    <Type>String</Type>
    <VideoCode>String</VideoCode>
    <VideoType>NA</VideoType>
    <VideoUrl>String</VideoUrl>
  </OnTheGroundListItem>
</ArrayOfOnTheGroundListItem>