RHP_API

<back to all web services

CreateUserSavedSearch

Save's a search with a title.

Requires Authentication
The following routes are available for this service:
POST/User/Search/Saved
CreateUserSavedSearch Parameters:
NameParameterData TypeRequiredDescription
TitlebodystringNoSearch save title
ConfigbodyGetProfileSearchResultNoSearch config object, same as would be submitted for a search
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
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
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
UserSavedSearch Parameters:
NameParameterData TypeRequiredDescription
SavedSearchIDformintNo
TitleformstringNo
ConfigformGetProfileSearchResultNo
DateCreatedformDateTimeNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /User/Search/Saved HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Title":"String","Config":{"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}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SavedSearchID":0,"Title":"String","Config":{"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},"DateCreated":"\/Date(-62135596800000-0000)\/"}