profileSearchService

Provides the ability to search users.

Method	Description
getSimilarUserResults	Returns the the first 5 users that are similar to the specified user.
isSearchEnabled	Returns true if the profile search feature is turned on.
search	Returns the users that correspond to the search query.
searchBounded	Returns the users that correspond to the search query beginning at startIndex and until the number results equals numResults.

getSimilarUserResults

Returns the the first 5 users that are similar to the specified user. This method only checks profile data, and does not use username, name, or email address as a means of determining similarity.

GET http://domain:port/application_context/rpc/rest/profileSearchService/similarUsers/{targetUserID}

Arguments

Name	Type	Description
groupID	xs:long	the user ID that other user records will be similar to

Arguments Template

<getSimilarUserResults> 
    <groupID>xs:long</groupID>
</getSimilarUserResults>

Response

Type	Description
List of User	the 5 users that are similar to the specified user

Response Template

<getSimilarUserResultsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of User -->
    <return>
</getSimilarUserResultsResponse>

isSearchEnabled

Returns true if the profile search feature is turned on. When profile search is disabled, other methods serve as no-ops.

GET http://domain:port/application_context/rpc/rest/profileSearchService/isSearchEnabled

Response

Type	Description
xs:boolean	true if the search is enabled.

Response Template

<isSearchEnabledResponse> 
    <return>xs:boolean</return>
</isSearchEnabledResponse>

search

Returns the users that correspond to the search query.

POST http://domain:port/application_context/rpc/rest/profileSearchService/searchProfile

Arguments

Name	Type	Description
query	Contents of ProfileSearchQuery	the profile search query

Arguments Template

<search> 
    <query>
        <!-- Contents of ProfileSearchQuery -->
    <query>
</search>

Response

Type	Description
List of User	the users that match the search criteria.

Response Template

<searchResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of User -->
    <return>
</searchResponse>

Errors

Error	When Returned
CommunityNotFound	if the community in the query could no be found.
Unauthorized	if the user is not authorized to perform the query.

searchBounded

Returns the users that correspond to the search query beginning at startIndex and until the number results equals numResults.

POST http://domain:port/application_context/rpc/rest/profileSearchService/searchProfileBounded

Arguments

Name	Type	Description
query	Contents of ProfileSearchQuery	the profile search query
startIndex	xs:int	the starting index in the search result to return.
numResults	xs:int	the number of users to return in the search result.

Arguments Template

<searchBounded> 
    <query>
        <!-- Contents of ProfileSearchQuery -->
    <query>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</searchBounded>

Response

Type	Description
List of User	the users that match the search criteria.

Response Template

<searchBoundedResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of User -->
    <return>
</searchBoundedResponse>

Errors

Error	When Returned
CommunityNotFound	if the community in the query could no be found.
Unauthorized	if the user is not authorized to perform the query.