RHP_API

GetFriendsList

Returns user friend list. The contents of the returned list is controlled by Type.

The following routes are available for this service:
GET	/User/Friends

**GetFriendsList** Parameters:
Name	Parameter	Data Type	Required	Description
Type	query	FriendType	No	Friends - returns confirmed Friends, Pending - returns Friends Requests.
DemoMode	query	bool	No

**Pagination** Parameters:
Name	Parameter	Data Type	Required	Description
Size	form	int	No
Page	form	int	No

**GenericListResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<T>	No
Total	form	int	No

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 /User/Friends HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenericListResponseOfListFriendSjC_PYTVK xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
    <d2p1:ListFriend>
      <d2p1:ListID>0</d2p1:ListID>
      <d2p1:User>
        <Age1>0</Age1>
        <Age2>0</Age2>
        <AgeTitle>String</AgeTitle>
        <CountryID>0</CountryID>
        <IsAdmin>false</IsAdmin>
        <IsDiamond>false</IsDiamond>
        <IsOnline>false</IsOnline>
        <IsViewable>false</IsViewable>
        <Location>String</Location>
        <MainPhoto>
          <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>0</MatchingInterests>
        <MemberID>0</MemberID>
        <MemberLevel>0</MemberLevel>
        <MemberLevelType>String</MemberLevelType>
        <MemberLevelUserProfile>Guest</MemberLevelUserProfile>
        <MemberType>0</MemberType>
        <MemberTypeTitle>
          <Abbr>String</Abbr>
          <Plural>String</Plural>
          <Singular>String</Singular>
        </MemberTypeTitle>
        <UserName>String</UserName>
        <UserType>General</UserType>
      </d2p1:User>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:Rank>0</d2p1:Rank>
    </d2p1:ListFriend>
  </Data>
  <Total>0</Total>
</GenericListResponseOfListFriendSjC_PYTVK>