RHP_API

<back to all web services

GetStory

The following routes are available for this service:
GET/Story/{ID}
GetStory Parameters:
NameParameterData TypeRequiredDescription
IDpathintNo
StoryDetail Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
IsOwnerformboolNo
StoryListItem Parameters:
NameParameterData TypeRequiredDescription
SEOUrlformstringNo
StoryIDformintNo
TitleformstringNo
SummaryformstringNo
CategoriesformintNo
CategoriesValuesformList<LookupItem>No
DateCreatedformDateTimeNo
AuthorformProfileSummaryAuthorNo
CommunityAction Parameters:
NameParameterData TypeRequiredDescription
CommentCountformintNo
CommunityLikeAction Parameters:
NameParameterData TypeRequiredDescription
IsLikedformboolNo
LikeCountformintNo
LookupItem Parameters:
NameParameterData TypeRequiredDescription
ItemIDformintNo
ItemNameformstringNo
ListIDformintNo
ProfileSummaryAuthor Parameters:
NameParameterData TypeRequiredDescription
StoryCountformintNo
ProfileSummary Parameters:
NameParameterData TypeRequiredDescription
MemberIDformlongNo
UserNameformstringNo
MemberTypeformshortNo
MemberTypeTitleformProfileMemberTypeNo
Age1formintNo
Age2formintNo
AgeTitleformstringNo
LocationformstringNo
MatchingInterestsformintNo
MainPhotoformProfilePhotoNo
IsOnlineformboolNo
MemberLevelformintNo
IsDiamondformboolNo
CountryIDformintNo
UserTypeformLoginUserTypeNo
MemberLevelTypeformstringNo
IsAdminformboolNo
MemberLevelUserProfileformMemberLevelUserProfileNo
IsViewableformboolNo
ProfileMemberType Parameters:
NameParameterData TypeRequiredDescription
AbbrformstringNo
SingularformstringNo
PluralformstringNo
ProfilePhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDformintNo
HeightformintNo
WidthformintNo
ImageTypeformProfileImageTypeNo
IsPublicformboolNo
ClassificationformintNo
UserTypeformLoginUserType?No
ShowSafeModeformboolNo
ImageActionTypeformImageActionTypeNo
GalleryIDformintNo
IsAcceptedformbool?No
MemberLikeCountformintNo
IsLikedformboolNo
SortNumberformintNo
ProfilePhotoUrl Parameters:
NameParameterData TypeRequiredDescription
ThumbUrlformstringNo
FullUrlformstringNo

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

{
	Content: String,
	IsOwner: False,
	SEOUrl: String,
	StoryID: 0,
	Title: String,
	Summary: String,
	Categories: 0,
	CategoriesValues: 
	[
		{
			ItemID: 0,
			ItemName: String,
			ListID: 0
		}
	],
	DateCreated: 0001-01-01,
	Author: 
	{
		StoryCount: 0,
		MemberID: 0,
		UserName: String,
		MemberType: 0,
		MemberTypeTitle: 
		{
			Abbr: String,
			Singular: String,
			Plural: String
		},
		Age1: 0,
		Age2: 0,
		AgeTitle: String,
		Location: String,
		MatchingInterests: 0,
		MainPhoto: 
		{
			PhotoID: 0,
			Height: 0,
			Width: 0,
			ImageType: None,
			IsPublic: False,
			Classification: 0,
			UserType: General,
			ShowSafeMode: False,
			ImageActionType: ShowImage,
			GalleryID: 0,
			IsAccepted: False,
			MemberLikeCount: 0,
			IsLiked: False,
			SortNumber: 0,
			ThumbUrl: String,
			FullUrl: String
		},
		IsOnline: False,
		MemberLevel: 0,
		IsDiamond: False,
		CountryID: 0,
		UserType: General,
		MemberLevelType: String,
		IsAdmin: False,
		MemberLevelUserProfile: Guest,
		IsViewable: False
	},
	CommentCount: 0,
	IsLiked: False,
	LikeCount: 0
}