com.dice
Interface CandidateSearchService

public interface CandidateSearchService

The Candidate Search Service is a SOAP based web service to search and view the Dice Career Solutions candidate data base. It is implemented using the Apache Axis2 SOAP engine version 1.5.1. The WSDL for the service can be obtained here.

Note: this documentation is prepared in the POJO's from which the service is generated, names were changed by the code generator in some cases.

$RCSfile: CandidateSearchService.html,v $
$Author: duket $
$Date: 2010/12/14 16:48:42 $

Original Author: duke _DOT_ takle _AT_ dice _DOT_ com
Date: February, 2010

Method Summary

AuthenticateAnswer	authenticate(java.lang.String username, java.lang.String password) The service requires the user to authenticate with credentials assigned to customers.
java.lang.String	getRandomThought() Return a random thought
LimitDataAnswer	getViewLimitData(java.lang.String authToken) Query the current account status with respect to view quotas
QueryAnswer	queryCandidates(DiceQuery query, java.lang.String authToken) The candidate database is searched with this method.
ViewAnswer	viewDiceCandidate(java.lang.String dockey, java.lang.String authToken) View the details about a selected candidate including the HTML resume

Method Detail

authenticate

AuthenticateAnswer authenticate(java.lang.String username,
                                java.lang.String password)

The service requires the user to authenticate with credentials assigned to customers.

Parameters:

username - User name

password - Password

Returns:

an instance of com.dice.AuthenticationAnswer

queryCandidates

QueryAnswer queryCandidates(DiceQuery query,
                            java.lang.String authToken)

The candidate database is searched with this method.

Parameters:

query - the data for the query including requested result count and offset into the complete result set.

authToken - Authentication token obtained from the call to authenticate()

Returns:

an instance of com.dice.QueryAnswer

viewDiceCandidate

ViewAnswer viewDiceCandidate(java.lang.String dockey,
                             java.lang.String authToken)

View the details about a selected candidate including the HTML resume

Parameters:

dockey - the key provided with the candidate object returned in the array of results

authToken - cation token obtained from the call to authenticate()

Returns:

an instance of ViewAnswer

getViewLimitData

LimitDataAnswer getViewLimitData(java.lang.String authToken)

Query the current account status with respect to view quotas

Parameters:

authToken - authentication token obtained from the call to authenticate()

Returns:

an instance of LimitDataAnswer

getRandomThought

java.lang.String getRandomThought()

Return a random thought

Returns:

wisdom