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

<ProfileSummaryFull xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <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>
  <Intersection>
    <DealBreakerConflict>
      <LookupValue>
        <ListID>0</ListID>
        <Text>String</Text>
        <TextAbbr>String</TextAbbr>
        <Value>0</Value>
        <IsMatch>false</IsMatch>
      </LookupValue>
    </DealBreakerConflict>
    <DealBreakerConflictViewer>
      <LookupValue>
        <ListID>0</ListID>
        <Text>String</Text>
        <TextAbbr>String</TextAbbr>
        <Value>0</Value>
        <IsMatch>false</IsMatch>
      </LookupValue>
    </DealBreakerConflictViewer>
    <HasFavourited>false</HasFavourited>
    <HasLiked>false</HasLiked>
    <HasMessages>false</HasMessages>
    <IsFavouriteMutual>false</IsFavouriteMutual>
    <IsLikeMutual>false</IsLikeMutual>
    <IsMatching>false</IsMatching>
  </Intersection>
  <IsFavourite>false</IsFavourite>
  <IsMatch>false</IsMatch>
  <IsVerified>false</IsVerified>
  <ProfileSettings>
    <ChatroomWhisperPermission>Anyone</ChatroomWhisperPermission>
    <IsProfileVisible>false</IsProfileVisible>
  </ProfileSettings>
  <XMPPID>String</XMPPID>
</ProfileSummaryFull>