RHP_API

<back to all web services

GetActiveUsers

Requires Authentication
The following routes are available for this service:
All Verbs/Profile/Search/Active
GetActiveUsers Parameters:
NameParameterData TypeRequiredDescription
SeekingTypequeryshortNo
MinAgequeryintNoMinimum age range. Maps to 'Age range' slider
MaxAgequeryintNoMaximum age range. Maps to 'Age range' slider
IsMatchqueryboolNoReturns users where viewer and the profile are matching (not Matched).
GoogleMapPlacequeryGooglePlaceNoGoogleMapPlaces data used for locality based searches.
RadiusqueryshortNoSearch 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 .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.

POST /Profile/Search/Active HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetActiveUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <Page xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Page>
  <Size xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">0</Size>
  <GoogleMapPlace>
    <LocationName>String</LocationName>
    <PlacesId>String</PlacesId>
    <Types xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Types>
  </GoogleMapPlace>
  <IsMatch>false</IsMatch>
  <MaxAge>0</MaxAge>
  <MinAge>0</MinAge>
  <Radius>0</Radius>
  <SeekingType>0</SeekingType>
</GetActiveUsers>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfProfileSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP.ServiceHelper.Model">
  <ProfileSummary>
    <Age1>0</Age1>
    <Age2>0</Age2>
    <AgeTitle>String</AgeTitle>
    <CountryID>0</CountryID>
    <IsAdmin>false</IsAdmin>
    <IsDiamond>false</IsDiamond>
    <IsOnline>false</IsOnline>
    <IsViewable>false</IsViewable>
    <Location>String</Location>
    <MainPhoto>
      <FullUrl>String</FullUrl>
      <ThumbUrl>String</ThumbUrl>
      <Classification>0</Classification>
      <GalleryID>0</GalleryID>
      <Height>0</Height>
      <ImageActionType>ShowImage</ImageActionType>
      <ImageType>None</ImageType>
      <IsAccepted>false</IsAccepted>
      <IsLiked>false</IsLiked>
      <IsPublic>false</IsPublic>
      <MemberLikeCount>0</MemberLikeCount>
      <PhotoID>0</PhotoID>
      <ShowSafeMode>false</ShowSafeMode>
      <SortNumber>0</SortNumber>
      <UserType>General</UserType>
      <Width>0</Width>
    </MainPhoto>
    <MatchingInterests>0</MatchingInterests>
    <MemberID>0</MemberID>
    <MemberLevel>0</MemberLevel>
    <MemberLevelType>String</MemberLevelType>
    <MemberLevelUserProfile>Guest</MemberLevelUserProfile>
    <MemberType>0</MemberType>
    <MemberTypeTitle>
      <Abbr>String</Abbr>
      <Plural>String</Plural>
      <Singular>String</Singular>
    </MemberTypeTitle>
    <UserName>String</UserName>
    <UserType>General</UserType>
  </ProfileSummary>
</ArrayOfProfileSummary>