RHP_API

<back to all web services

GetUserSearchSettings

Get the current user's default search settings.

Requires Authentication
The following routes are available for this service:
GET/User/Search/Settings
UserSearchSetting Parameters:
NameParameterData TypeRequiredDescription
MemberTypeformshortNo
AgeMinformintNo
AgeMaxformintNo
LocationformSuburbItemNo
SeekingMemberTypeformshortNo
SearchRadiusformintNo
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.

GET /User/Search/Settings HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MemberType: 0,
	AgeMin: 0,
	AgeMax: 0,
	Location: 
	{
		PostCodeAllID: 0,
		Suburb: String,
		PostCode: String,
		StateID: 0,
		StateName: String,
		StateNameAbbr: String,
		CountryID: 0,
		CountryName: String,
		CountryCode: String,
		GoogleMapPlacesId: String,
		Type: String
	},
	SeekingMemberType: 0,
	SearchRadius: 0
}