RHP_API

GetArticle

The following routes are available for this service:
GET	/Article/{ID}

**GetArticle** Parameters:
Name	Parameter	Data Type	Required	Description
ID	path	int	No
Preview	query	string	No

**ArticleDetail** Parameters:
Name	Parameter	Data Type	Required
Body	form	string	No
Keywords	form	string	No
ReferenceText	form	string	No
ReferenceUrl	form	string	No
Tags	form	string	No
CategoriesValues	form	List<LookupItem>	No
Competition	form	Competition	No
CommentsDisabled	form	bool	No

**ArticleListItem** Parameters:
Name	Parameter	Data Type	Required
ArticleID	form	int	No
Title	form	string	No
ShortTitle	form	string	No
Summary	form	string	No
ImageUrl	form	string	No
Categories	form	int	No
DatePublished	form	DateTime	No
Author	form	ArticleAuthor	No
SEOUrl	form	string	No

**CommunityAction** Parameters:
Name	Parameter	Data Type	Required	Description
CommentCount	form	int	No

**CommunityLikeAction** Parameters:
Name	Parameter	Data Type	Required	Description
IsLiked	form	bool	No
LikeCount	form	int	No

**ArticleAuthor** Parameters:
Name	Parameter	Data Type	Required
ArticleAuthorID	form	int	No
Name	form	string	No
ImageUrl	form	string	No
Width	form	int	No
Height	form	int	No
Description	form	string	No
FacebookLink	form	string	No
TwitterLink	form	string	No
InstagramLink	form	string	No
YouTubeLink	form	string	No
ArticleCount	form	int	No

**LookupItem** Parameters:
Name	Parameter	Data Type	Required
ItemID	form	int	No
ItemName	form	string	No
ListID	form	int	No

**Competition** Parameters:
Name	Parameter	Data Type	Required	Description
CompetitionID	form	int	No
Prize	form	string	No	Prize description
QuestionBlurb	form	string	No	Question Title
Question	form	string	No	Question Text
TermsCondition	form	string	No	Terms and Conditions text
StartDate	form	DateTime	No	Cometition Start Date
EndDate	form	DateTime	No	Cometition End Date
IsNameRequired	form	bool	No	Determines if the Name field should be displayed
IsEmailRequired	form	bool	No	Determines if the Email field should be displayed
IsPhoneRequired	form	bool	No	Determines if the Phone field should be displayed
IsAddressRequired	form	bool	No	Determines if the Address field should be displayed

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 /Article/{ID} HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArticleDetail 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>
  <ArticleID>0</ArticleID>
  <Author>
    <ArticleAuthorID>0</ArticleAuthorID>
    <ArticleCount>0</ArticleCount>
    <Description>String</Description>
    <FacebookLink>String</FacebookLink>
    <Height>0</Height>
    <ImageUrl>String</ImageUrl>
    <InstagramLink>String</InstagramLink>
    <Name>String</Name>
    <TwitterLink>String</TwitterLink>
    <Width>0</Width>
    <YouTubeLink>String</YouTubeLink>
  </Author>
  <Categories>0</Categories>
  <DatePublished>0001-01-01T00:00:00</DatePublished>
  <ImageUrl>String</ImageUrl>
  <SEOUrl>String</SEOUrl>
  <ShortTitle>String</ShortTitle>
  <Summary>String</Summary>
  <Title>String</Title>
  <Body>String</Body>
  <CategoriesValues xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
    <d2p1:LookupItem>
      <d2p1:ItemID>0</d2p1:ItemID>
      <d2p1:ItemName>String</d2p1:ItemName>
      <d2p1:ListID>0</d2p1:ListID>
    </d2p1:LookupItem>
  </CategoriesValues>
  <CommentsDisabled>false</CommentsDisabled>
  <Competition>
    <CompetitionID>0</CompetitionID>
    <EndDate>0001-01-01T00:00:00</EndDate>
    <IsAddressRequired>false</IsAddressRequired>
    <IsEmailRequired>false</IsEmailRequired>
    <IsNameRequired>false</IsNameRequired>
    <IsPhoneRequired>false</IsPhoneRequired>
    <Prize>String</Prize>
    <Question>String</Question>
    <QuestionBlurb>String</QuestionBlurb>
    <StartDate>0001-01-01T00:00:00</StartDate>
    <TermsCondition>String</TermsCondition>
  </Competition>
  <Keywords>String</Keywords>
  <ReferenceText>String</ReferenceText>
  <ReferenceUrl>String</ReferenceUrl>
  <Tags>String</Tags>
</ArticleDetail>