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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserSearchSetting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <AgeMax>0</AgeMax>
  <AgeMin>0</AgeMin>
  <Location>
    <CountryCode>String</CountryCode>
    <CountryID>0</CountryID>
    <CountryName>String</CountryName>
    <GoogleMapPlacesId>String</GoogleMapPlacesId>
    <PostCode>String</PostCode>
    <PostCodeAllID>0</PostCodeAllID>
    <StateID>0</StateID>
    <StateName>String</StateName>
    <StateNameAbbr>String</StateNameAbbr>
    <Suburb>String</Suburb>
    <Type>String</Type>
  </Location>
  <MemberType>0</MemberType>
  <SearchRadius>0</SearchRadius>
  <SeekingMemberType>0</SeekingMemberType>
</UserSearchSetting>