RHP_API

<back to all web services

UserTravelSearch

Requires Authentication
The following routes are available for this service:
POST/UserTravel/Search
UserTravelSearch Parameters:
NameParameterData TypeRequiredDescription
MemberTypebodyshortNoDetermines the returned member type.
MinAgebodyintNoMinimum age range. Maps to 'Age range' slider
MaxAgebodyintNoMaximum age range. Maps to 'Age range' slider
GoogleMapPlacebodyGooglePlaceNoGoogleMapPlaces data used for locality based searches.
SearchRadiusbodyshortNoSearch radius, maps to 'Proximity
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.

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 /UserTravel/Search HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"MemberType":0,"MinAge":0,"MaxAge":0,"GoogleMapPlace":{"PlacesId":"String","Types":["String"],"LocationName":"String"},"SearchRadius":0,"Size":0,"Page":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"TravelProfile":{"DateArrived":"\/Date(-62135596800000-0000)\/","DateDeparture":"\/Date(-62135596800000-0000)\/","ShowSimpleDates":false,"Description":"String","Destination":"String"},"Profile":{"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}}]