RHP_API

<back to all web services

GetProfileSummary

Requires Authentication
The following routes are available for this service:
GET/Profile/{Id}/Summary
GET/Profiles/{Id}/Summary
GetProfileSummary Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
ProfileSummaryFull Parameters:
NameParameterData TypeRequiredDescription
IsMatchformboolNo
IsFavouriteformbool?No
XMPPIDformstringNo
IntersectionformProfileSummaryIntersectionNo
ProfileSettingsformProfileClientSettingsNo
IsVerifiedformboolNo
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
ProfileSummaryIntersection Parameters:
NameParameterData TypeRequiredDescription
IsMatchingformboolNoThe viewer and the profile are matching.
HasFavouritedformboolNoThe viewer has favourited the profile.
HasLikedformboolNoThe viewer has liked the profile.
IsLikeMutualformboolNoThe users are a like match.
IsFavouriteMutualformboolNoThe users are a favourite match.
HasMessagesformboolNoThe view and the profile have exchange a message.
DealBreakerConflictformLookupValue[]NoDeal beakers that the viewed profile has with the current user(viewer).
DealBreakerConflictViewerformLookupValue[]NoDeal breakers that the current user(viewer) has with the viewed profile.
LookupValue Parameters:
NameParameterData TypeRequiredDescription
IsMatchformboolNo
LookupValueBase Parameters:
NameParameterData TypeRequiredDescription
ValueformintNo
TextformstringNo
TextAbbrformstringNo
ListIDformint?No
ProfileClientSettings Parameters:
NameParameterData TypeRequiredDescription
ChatroomWhisperPermissionformChatroomMessageReceivePermissionNo
IsProfileVisibleformboolNo

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

{
	IsMatch: False,
	IsFavourite: False,
	XMPPID: String,
	Intersection: 
	{
		IsMatching: False,
		HasFavourited: False,
		HasLiked: False,
		IsLikeMutual: False,
		IsFavouriteMutual: False,
		HasMessages: False,
		DealBreakerConflict: 
		[
			{
				IsMatch: False,
				Value: 0,
				Text: String,
				TextAbbr: String,
				ListID: 0
			}
		],
		DealBreakerConflictViewer: 
		[
			{
				IsMatch: False,
				Value: 0,
				Text: String,
				TextAbbr: String,
				ListID: 0
			}
		]
	},
	ProfileSettings: 
	{
		ChatroomWhisperPermission: Anyone,
		IsProfileVisible: False
	},
	IsVerified: False,
	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
}