GET | /Article/{ID} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | path | int | No | |
Preview | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CommentCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
IsLiked | form | bool | No | |
LikeCount | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ItemID | form | int | No | |
ItemName | form | string | No | |
ListID | form | int | No |
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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Body":"String","Keywords":"String","ReferenceText":"String","ReferenceUrl":"String","Tags":"String","CategoriesValues":[{"ItemID":0,"ItemName":"String","ListID":0}],"Competition":{"CompetitionID":0,"Prize":"String","QuestionBlurb":"String","Question":"String","TermsCondition":"String","StartDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","IsNameRequired":false,"IsEmailRequired":false,"IsPhoneRequired":false,"IsAddressRequired":false},"CommentsDisabled":false,"ArticleID":0,"Title":"String","ShortTitle":"String","Summary":"String","ImageUrl":"String","Categories":0,"DatePublished":"\/Date(-62135596800000-0000)\/","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}