RHP_API

<back to all web services

GetStoryAuthorDetail

The following routes are available for this service:
GET/Story/Author/{UserID}
GetStoryAuthorDetail Parameters:
NameParameterData TypeRequiredDescription
UserIDpathlongNo
StoryAuthorDetail Parameters:
NameParameterData TypeRequiredDescription
AuthorformProfileSummaryAuthorNo
StoriesformList<StoryDetail>No
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
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

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

<StoryAuthorDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Author>
    <Age1 xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Age1>
    <Age2 xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Age2>
    <AgeTitle xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</AgeTitle>
    <CountryID xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</CountryID>
    <IsAdmin xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsAdmin>
    <IsDiamond xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsDiamond>
    <IsOnline xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsOnline>
    <IsViewable xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsViewable>
    <Location xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</Location>
    <MainPhoto xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <FullUrl>String</FullUrl>
      <ThumbUrl>String</ThumbUrl>
      <Classification>0</Classification>
      <GalleryID>0</GalleryID>
      <Height>0</Height>
      <ImageActionType>ShowImage</ImageActionType>
      <ImageType>None</ImageType>
      <IsAccepted>false</IsAccepted>
      <IsLiked>false</IsLiked>
      <IsPublic>false</IsPublic>
      <MemberLikeCount>0</MemberLikeCount>
      <PhotoID>0</PhotoID>
      <ShowSafeMode>false</ShowSafeMode>
      <SortNumber>0</SortNumber>
      <UserType>General</UserType>
      <Width>0</Width>
    </MainPhoto>
    <MatchingInterests xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MatchingInterests>
    <MemberID xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MemberID>
    <MemberLevel xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MemberLevel>
    <MemberLevelType xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</MemberLevelType>
    <MemberLevelUserProfile xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">Guest</MemberLevelUserProfile>
    <MemberType xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MemberType>
    <MemberTypeTitle xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
      <Abbr>String</Abbr>
      <Plural>String</Plural>
      <Singular>String</Singular>
    </MemberTypeTitle>
    <UserName xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</UserName>
    <UserType xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">General</UserType>
    <StoryCount>0</StoryCount>
  </Author>
  <Stories>
    <StoryDetail>
      <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>
      <Author>
        <Age1 xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Age1>
        <Age2 xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Age2>
        <AgeTitle xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</AgeTitle>
        <CountryID xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</CountryID>
        <IsAdmin xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsAdmin>
        <IsDiamond xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsDiamond>
        <IsOnline xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsOnline>
        <IsViewable xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">false</IsViewable>
        <Location xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</Location>
        <MainPhoto xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
          <FullUrl>String</FullUrl>
          <ThumbUrl>String</ThumbUrl>
          <Classification>0</Classification>
          <GalleryID>0</GalleryID>
          <Height>0</Height>
          <ImageActionType>ShowImage</ImageActionType>
          <ImageType>None</ImageType>
          <IsAccepted>false</IsAccepted>
          <IsLiked>false</IsLiked>
          <IsPublic>false</IsPublic>
          <MemberLikeCount>0</MemberLikeCount>
          <PhotoID>0</PhotoID>
          <ShowSafeMode>false</ShowSafeMode>
          <SortNumber>0</SortNumber>
          <UserType>General</UserType>
          <Width>0</Width>
        </MainPhoto>
        <MatchingInterests xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MatchingInterests>
        <MemberID xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MemberID>
        <MemberLevel xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MemberLevel>
        <MemberLevelType xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</MemberLevelType>
        <MemberLevelUserProfile xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">Guest</MemberLevelUserProfile>
        <MemberType xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</MemberType>
        <MemberTypeTitle xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
          <Abbr>String</Abbr>
          <Plural>String</Plural>
          <Singular>String</Singular>
        </MemberTypeTitle>
        <UserName xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">String</UserName>
        <UserType xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">General</UserType>
        <StoryCount>0</StoryCount>
      </Author>
      <Categories>0</Categories>
      <CategoriesValues xmlns:d4p1="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
        <d4p1:LookupItem>
          <d4p1:ItemID>0</d4p1:ItemID>
          <d4p1:ItemName>String</d4p1:ItemName>
          <d4p1:ListID>0</d4p1:ListID>
        </d4p1:LookupItem>
      </CategoriesValues>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <SEOUrl>String</SEOUrl>
      <StoryID>0</StoryID>
      <Summary>String</Summary>
      <Title>String</Title>
      <Content>String</Content>
      <IsOwner>false</IsOwner>
    </StoryDetail>
  </Stories>
</StoryAuthorDetail>