RHP_API

<back to all web services

GetArticles

The following routes are available for this service:
GET/Article
GetArticles Parameters:
NameParameterData TypeRequiredDescription
CategoryqueryintNo
ArticleAuthorIDqueryintNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo

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

[
	{
		ArticleID: 0,
		Title: String,
		ShortTitle: String,
		Summary: String,
		ImageUrl: String,
		Categories: 0,
		DatePublished: 0001-01-01,
		Author: 
		{
			ArticleAuthorID: 0,
			Name: String,
			ImageUrl: String,
			Width: 0,
			Height: 0,
			Description: String,
			FacebookLink: String,
			TwitterLink: String,
			InstagramLink: String,
			YouTubeLink: String,
			ArticleCount: 0
		},
		SEOUrl: String,
		CommentCount: 0,
		IsLiked: False,
		LikeCount: 0
	}
]