RHP_API

<back to all web services

GetQandAList

The following routes are available for this service:
GET/QandA
GetQandAList Parameters:
NameParameterData TypeRequiredDescription
CategoryIDqueryintNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
QandAList Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<QandAListItem>No
PaginationInfoformPaginationInfoNo
QandAListItem Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TitleformstringNo
QuestionformstringNo
CategoriesValueformintNo
CategoriesformList<LookupItem>No
DateAnsweredformDateTimeNo
CommunityAction Parameters:
NameParameterData TypeRequiredDescription
CommentCountformintNo
CommunityLikeAction Parameters:
NameParameterData TypeRequiredDescription
IsLikedformboolNo
LikeCountformintNo
LookupItem Parameters:
NameParameterData TypeRequiredDescription
ItemIDformintNo
ItemNameformstringNo
ListIDformintNo
PaginationInfo Parameters:
NameParameterData TypeRequiredDescription
TotalItemsformintNo
TotalPagesformintNo

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

{
	Items: 
	[
		{
			ID: 0,
			Title: String,
			Question: String,
			CategoriesValue: 0,
			Categories: 
			[
				{
					ItemID: 0,
					ItemName: String,
					ListID: 0
				}
			],
			DateAnswered: 0001-01-01,
			CommentCount: 0,
			IsLiked: False,
			LikeCount: 0
		}
	],
	PaginationInfo: 
	{
		TotalItems: 0,
		TotalPages: 0,
		Size: 0,
		Page: 0
	}
}