RHP_API

<back to all web services

GetSpotlightFeatured

Returns a list of profiles based on the provided criteria

Requires Authentication
The following routes are available for this service:
GET, POST/Profile/Search/Spotlight/Featured
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
MemberSearchProfileSummaries Parameters:
NameParameterData TypeRequiredDescription
SearchGuidformstringNo
ProfileSummariesformList<ViewingProfile>No
PageNumberformintNo
PageSizeformintNo
TypeformProfileSearchTypeNo
SortingformMemberSearchOrderByTypeNo
SearchRequestformGetProfileSearchResultNo
MoreResultsformboolNo
ViewingProfile Parameters:
NameParameterData TypeRequiredDescription
DetailformProfileDetailNo
SeekingformProfileSeekingNo
IntersectionformProfileIntersectionNo
MainPhotoformProfilePhotoNo
ProfileDetail Parameters:
NameParameterData TypeRequiredDescription
ShareProfileCodeformstringNo
UserIDformlongNo
UsernameformstringNo
MemberTypeformshortNo
MemberTypeTitleformProfileMemberTypeNo
Age1formintNo
Age2formintNo
AgeTitleformstringNo
LocationformstringNo
StateNameformstringNo
CountryNameformstringNo
UserCountryformCountryNo
IsOnlineformboolNo
MemberLevelformintNo
MemberLevelValueformLookupValueNo
IsDiamondformboolNo
IsVerifiedformboolNo
IntroBodyformstringNo
IntroTitleformstringNo
PhoneNumberformstringNo
PhoneNumberShowUpgradeformboolNo
IsPhoneVerifiedformboolNo
IsSmsOnlyformboolNo
IsAdminformboolNo
IsViewableformboolNo
RelationshipStatusformLookupValueNo
RelationshipStatus2formLookupValueNo
LevelOfParticipationformLookupValueNo
LevelOfParticipation2formLookupValueNo
SexualOrientationformLookupValueNo
SexualOrientation2formLookupValueNo
RaceformLookupValueNo
Race2formLookupValueNo
PersonalityformLookupValueNo
Personality2formLookupValueNo
MyLooksformLookupValueNo
MyLooks2formLookupValueNo
BodyTypeformLookupValueNo
BodyType2formLookupValueNo
HeightformLookupValueNo
Height2formLookupValueNo
EyeColourformLookupValueNo
EyeColour2formLookupValueNo
HairColourformLookupValueNo
HairColour2formLookupValueNo
HairLengthformLookupValueNo
HairLength2formLookupValueNo
DrinkingformLookupValueNo
Drinking2formLookupValueNo
SmokingformLookupValueNo
Smoking2formLookupValueNo
GeneralInterestsformLookupValue[]No
SafeSexformLookupValueNo
SafeSex2formLookupValueNo
BodyHairformLookupValueNo
BodyHair2formLookupValueNo
PubicHairformLookupValueNo
PubicHair2formLookupValueNo
EndowmentLengthformLookupValueNo
EndowmentLength2formLookupValueNo
EndowmentThicknessformLookupValueNo
EndowmentThickness2formLookupValueNo
CupSizeformLookupValueNo
CupSize2formLookupValueNo
IntimatePiercingformLookupValueNo
IntimatePiercing2formLookupValueNo
SexualPersonalityformLookupValueNo
SexualPersonality2formLookupValueNo
SexualInterestsformLookupValue[]No
SexualPreferencesformLookupValue[]No
FetishInterestsformLookupValue[]No
UserTypeformLoginUserTypeNo
ProfileMemberType Parameters:
NameParameterData TypeRequiredDescription
AbbrformstringNo
SingularformstringNo
PluralformstringNo
Country Parameters:
NameParameterData TypeRequiredDescription
CountryIDformintNo
NameformstringNo
CodeformstringNo
GoogleMapPlacesIdformstringNo
LookupValue Parameters:
NameParameterData TypeRequiredDescription
IsMatchformboolNo
LookupValueBase Parameters:
NameParameterData TypeRequiredDescription
ValueformintNo
TextformstringNo
TextAbbrformstringNo
ListIDformint?No
ProfileSeeking Parameters:
NameParameterData TypeRequiredDescription
SeekingBodyformstringNo
StateIDformintNo
StateNameformstringNo
AgeMinformintNo
AgeMaxformintNo
MemberTypesformLookupValue[]No
IntentionformLookupValue[]No
RelationshipStatusformLookupValueNo
DealBreakersformLookupValue[]No
ProfileIntersection Parameters:
NameParameterData TypeRequiredDescription
CanViewProfileformbool?No
CanViewValidationsformboolNo
IsMatchformboolNoThe viewer and the profile are a match.
HasFavouritedformboolNoThe viewer has favourited the profile.
HasFavouritedViewerformbool?NoThe profile has favourited the viewer.
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.
HasFriendRequestformboolNoIf true the current user has sent a friend request to the profile.
HasFriendRequestDeletedformboolNoIf true the current user has sent and deleted a friend request to the profile.
IsFriendformboolNo
HasValidationRequestformboolNo
CanAddValidationformboolNo
HasLikedViewerformbool?NoThe profile has liked the viewer.
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.
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
GetProfileSearchResult Parameters:
NameParameterData TypeRequiredDescription
SearchGuidformstringNoSearch GUID used for accessing cached searches.
TypeformProfileSearchType?NoSearch type, defaults to Advanced
OrderByTypeformMemberSearchOrderByTypeNoDetermines the search result order. Maps to search tabs on desktop and 'Sort' tab on refine.
NicheformNicheTypeNoNichs search, set when a Niche is used.
UserNameformstringNoTo use username search, the Type needs to be set to Username
MemberTypeformshortNoDetermines the returned member. Map to 'Show Me'
SeekingTypeformshortNoMatches the user's seeking type. Maps to 'People looking for'
MinAgeformintNoMinimum age range. Maps to 'Age range' slider
MaxAgeformintNoMaximum age range. Maps to 'Age range' slider
CountryIDformshortNoCountry ID, used for legacy searches
StateIDformshortNoState ID, used for legacy searches
PostCodeAllIDformintNoPost Code All ID, used for legacy searches
GoogleMapPlaceformGooglePlaceNoGoogleMapPlaces data used for locality based searches.
SearchGeoPointformGeoPointNoThe User's current location for use in 'Nearby Search'.
SearchRadiusformshortNoSearch radius, maps to 'Proximity
OnlineNowformboolNoRestricts results to online users. Maps to 'Active Now'
WithPhotosformboolNoRestricts results to users with photos. Maps to 'With Photos'
IsVerifiedformboolNoRestricts results to users who are verified. Maps to 'Verified'
Raceformshort[]NoRestricts results to users that match Race selections. Maps to 'Ethnicity'
BodyTypeformshort[]NoRestricts results to users that match BodyType selections. Maps to 'Body type'
SexualOrientationformshort[]NoRestricts results to users that match SexualOrientation selections. Maps to 'Sexual Orientation'
Participationformshort[]NoRestricts results to users that match Participation selections. Maps to 'Participation level'
SafeSexformshort[]NoRestricts results to users that match SafeSex selections. Maps to 'Safe Sex'
MaritalStatusformshort[]NoRestricts results to users that match MaritalStatus selections. Maps to 'Relationship status'
EndowmentLengthformshort[]NoRestricts results to users that match EndowmentLength selections. Maps to 'Endowment'
Heightformshort[]NoRestricts results to users that match Height selections. Maps to 'Height'
SexualIntererestformint[]NoRestricts results to users that match SexualIntererest selections. Maps to 'Sexual interests', ListID = 71 or ListID = 72
SexualPreferenceformint[]NoRestricts results to users that match SexualPreference selections. Maps to 'Sexual interests', ListID = 70
FetishInterestformint[]NoRestricts results to users that match FetishInterest selections. Maps to 'Fetish interests'
Intentionformint[]NoRestricts results to users that match Intention selections. Maps to 'Intentions'
PubicHairformshort[]NoRestricts results to users that match Pubic hair selections.
CupSizeformshort[]NoRestricts results to users that match Cup Size selections.
Smokingformshort[]NoRestricts results to users that match Smoking selections.
HasValidationsformboolNoReturns only profiles that have Validations
GooglePlace Parameters:
NameParameterData TypeRequiredDescription
PlacesIdformstringNoGoogleMapPlacesId used for locality based searches. Maps to 'place_id' google autocomplete.
Typesformstring[]NoGoogleMapPlacesId types array used for locality based searches. Maps to 'types' array google autocomplete.
LocationNameformstringNoThis field will return the name of the location, no needed in the request.
GeoPoint Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdecimalNo
LongitudeformdecimalNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Profile/Search/Spotlight/Featured HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Size":0,"Page":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"SearchGuid":"String","ProfileSummaries":[{"Detail":{"ShareProfileCode":"String","UserID":0,"Username":"String","MemberType":0,"MemberTypeTitle":{"Abbr":"String","Singular":"String","Plural":"String"},"Age1":0,"Age2":0,"AgeTitle":"String","Location":"String","StateName":"String","CountryName":"String","UserCountry":{"CountryID":0,"Name":"String","Code":"String","GoogleMapPlacesId":"String"},"IsOnline":false,"MemberLevel":0,"MemberLevelValue":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"IsDiamond":false,"IsVerified":false,"IntroBody":"String","IntroTitle":"String","PhoneNumber":"String","PhoneNumberShowUpgrade":false,"IsPhoneVerified":false,"IsSmsOnly":false,"IsAdmin":false,"IsViewable":false,"RelationshipStatus":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"RelationshipStatus2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"LevelOfParticipation":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"LevelOfParticipation2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"SexualOrientation":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"SexualOrientation2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Race":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Race2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Personality":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Personality2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"MyLooks":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"MyLooks2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"BodyType":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"BodyType2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Height":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Height2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"EyeColour":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"EyeColour2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"HairColour":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"HairColour2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"HairLength":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"HairLength2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Drinking":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Drinking2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Smoking":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"Smoking2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"GeneralInterests":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"SafeSex":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"SafeSex2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"BodyHair":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"BodyHair2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"PubicHair":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"PubicHair2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"EndowmentLength":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"EndowmentLength2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"EndowmentThickness":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"EndowmentThickness2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"CupSize":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"CupSize2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"IntimatePiercing":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"IntimatePiercing2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"SexualPersonality":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"SexualPersonality2":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"SexualInterests":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"SexualPreferences":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"FetishInterests":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"UserType":"General"},"Seeking":{"SeekingBody":"String","StateID":0,"StateName":"String","AgeMin":0,"AgeMax":0,"MemberTypes":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"Intention":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"RelationshipStatus":{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0},"DealBreakers":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}]},"Intersection":{"CanViewProfile":false,"CanViewValidations":false,"IsMatch":false,"HasFavourited":false,"HasFavouritedViewer":false,"HasLiked":false,"IsLikeMutual":false,"IsFavouriteMutual":false,"HasMessages":false,"HasFriendRequest":false,"HasFriendRequestDeleted":false,"IsFriend":false,"HasValidationRequest":false,"CanAddValidation":false,"HasLikedViewer":false,"DealBreakerConflict":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":0}],"DealBreakerConflictViewer":[{"IsMatch":false,"Value":0,"Text":"String","TextAbbr":"String","ListID":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"}}],"PageNumber":0,"PageSize":0,"Type":"QuickSearch","Sorting":"MemberLevel","SearchRequest":{"SearchGuid":"String","Type":"QuickSearch","OrderByType":"MemberLevel","Niche":"None","UserName":"String","MemberType":0,"SeekingType":0,"MinAge":0,"MaxAge":0,"CountryID":0,"StateID":0,"PostCodeAllID":0,"GoogleMapPlace":{"PlacesId":"String","Types":["String"],"LocationName":"String"},"SearchGeoPoint":{"Latitude":0,"Longitude":0},"SearchRadius":0,"OnlineNow":false,"WithPhotos":false,"IsVerified":false,"Race":[0],"BodyType":[0],"SexualOrientation":[0],"Participation":[0],"SafeSex":[0],"MaritalStatus":[0],"EndowmentLength":[0],"Height":[0],"SexualIntererest":[0],"SexualPreference":[0],"FetishInterest":[0],"Intention":[0],"PubicHair":[0],"CupSize":[0],"Smoking":[0],"HasValidations":false,"Size":0,"Page":0},"MoreResults":false}