RHP_API

<back to all web services

DateFinderSearch

Returns all user dates that have interests. When first called the user's current location (GoogleMapPlaceID) should be supplied for local results. If called with no parameters the User's default parameters will be used.

Requires Authentication
The following routes are available for this service:
POST/DateFinder/
DateFinderSearch Parameters:
NameParameterData TypeRequiredDescription
SearchCriteriabodyDateFinderSearchCriteriaNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
SizeformintNo
PageformintNo
DateFinderSearchCriteria Parameters:
NameParameterData TypeRequiredDescription
SeekingTypesformshortNoSum of selected seeking types, API will return Dates from selected types only, if left blank or -1 all User types will be returned.
AgeMinformintNoMinimum age, defaults to User's min seeking age
AgeMaxformintNoMaximum age, defaults to user's max seeking age
GoogleMapPlaceIDformstringNoGoogle location place ID, defaults to User's profile location
SearchRadiusformshortNoSearch radius, defaults to 50km
StartDateformDateTime?NoStart date for date range search.
EndDateformDateTime?NoEnd date for date range search.
CustomDateformDateTime?NoCustom date will return dates starting from specified date, and will supersede Date Range.
MeetingTypesformintNoWill return dates that match the selected meeting types.
WithPhotoformboolNoWill return only users that have photos.
CanHostformboolNo
DateFinderSearchResult Parameters:
NameParameterData TypeRequiredDescription
SearchSummaryformDateFinderSearchResultSummaryNo
CountSummaryformDateFinderCountSummaryNo
SearchCriteriaformDateFinderSearchCriteriaReturnNo
DateFinderSearchResultSummary Parameters:
NameParameterData TypeRequiredDescription
DatesformList<DateFinderDisplayItem>No
TotalSearchCountformintNo
DateFinderDisplayItem Parameters:
NameParameterData TypeRequiredDescription
ProfileformProfileSummaryNo
HasExpressedInterestformboolNo
ProfileDateFinder Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
DateHeldformDateTimeNo
DateHeldUtcIsoformstringNo
CommentformstringNo
ShortCommentformstringNo
LocationformstringNo
CityformstringNo
StateNameformstringNo
StateNameAbbrformstringNo
CountryNameformstringNo
AgeMinformintNo
AgeMaxformintNo
SeekingTypesformshortNo
OpenForListformList<string>No
OpenForTypesformintNo
SeekingTypeListformLookupValue[]No
CanHostformboolNo
DisplayDateformstringNo
LookupValue Parameters:
NameParameterData TypeRequiredDescription
IsMatchformboolNo
LookupValueBase Parameters:
NameParameterData TypeRequiredDescription
ValueformintNo
TextformstringNo
TextAbbrformstringNo
ListIDformint?No
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
DateFinderCountSummary Parameters:
NameParameterData TypeRequiredDescription
TotalDateMatchingCountformintNo
TotalDatesformintNo
DateFinderSearchCriteriaReturn Parameters:
NameParameterData TypeRequiredDescription
SuburbItemformSuburbItemNo
SuburbItem Parameters:
NameParameterData TypeRequiredDescription
PostCodeAllIDformintNo
SuburbformstringNo
PostCodeformstringNo
StateIDformintNo
StateNameformstringNo
StateNameAbbrformstringNo
CountryIDformintNo
CountryNameformstringNo
CountryCodeformstringNo
GoogleMapPlacesIdformstringNo
TypeformstringNo

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.

POST /DateFinder/ HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SearchCriteria: 
	{
		SeekingTypes: 0,
		AgeMin: 0,
		AgeMax: 0,
		GoogleMapPlaceID: String,
		SearchRadius: 0,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		CustomDate: 0001-01-01,
		MeetingTypes: 0,
		WithPhoto: False,
		CanHost: False
	},
	Size: 0,
	Page: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SearchSummary: 
	{
		Dates: 
		[
			{
				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
				},
				HasExpressedInterest: False,
				ID: 0,
				DateHeld: 0001-01-01,
				DateHeldUtcIso: String,
				Comment: String,
				ShortComment: String,
				Location: String,
				City: String,
				StateName: String,
				StateNameAbbr: String,
				CountryName: String,
				AgeMin: 0,
				AgeMax: 0,
				SeekingTypes: 0,
				OpenForList: 
				[
					String
				],
				OpenForTypes: 0,
				SeekingTypeList: 
				[
					{
						IsMatch: False,
						Value: 0,
						Text: String,
						TextAbbr: String,
						ListID: 0
					}
				],
				CanHost: False,
				DisplayDate: String
			}
		],
		TotalSearchCount: 0
	},
	CountSummary: 
	{
		TotalDateMatchingCount: 0,
		TotalDates: 0
	},
	SearchCriteria: 
	{
		SuburbItem: 
		{
			PostCodeAllID: 0,
			Suburb: String,
			PostCode: String,
			StateID: 0,
			StateName: String,
			StateNameAbbr: String,
			CountryID: 0,
			CountryName: String,
			CountryCode: String,
			GoogleMapPlacesId: String,
			Type: String
		},
		SeekingTypes: 0,
		AgeMin: 0,
		AgeMax: 0,
		GoogleMapPlaceID: String,
		SearchRadius: 0,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		CustomDate: 0001-01-01,
		MeetingTypes: 0,
		WithPhoto: False,
		CanHost: False
	}
}