RHP_API

<back to all web services

PatchFriendsList

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

Requires Authentication
The following routes are available for this service:
PATCH/User/Friends
GET/User/Friends
PatchFriendsList Parameters:
NameParameterData TypeRequiredDescription
ActionqueryListActionNoType must be 'Approve' or 'Delete'
Profilesquerylong[]NoList of UserID to delete the friend or friend request from
GetFriendsList Parameters:
NameParameterData TypeRequiredDescription
TypeformFriendTypeNoFriends - returns confirmed Friends, Pending - returns Friends Requests.
DemoModeformboolNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
GenericListResponse<T> Parameters:
NameParameterData TypeRequiredDescription
DataformList<T>No
TotalformintNo

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.

PATCH /User/Friends HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Action: Approve,
	Profiles: 
	[
		0
	],
	Type: Friends,
	DemoMode: False,
	Size: 0,
	Page: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			Rank: 0,
			DateCreated: 0001-01-01,
			ListID: 0,
			User: 
			{
				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
			}
		}
	],
	Total: 0
}