/// <summary>
/// This API end point will update a candidate based on the record num passed in the call. Pass a JSON object containing the variables you wish to update.
/// </summary>
/// <param name="num">Numeric ID of the candidate to update</param>
/// <param name="data">You do not need to update all the variables, only pass those you wish to update.</param>
/// <returns></returns>
public GetCandidatesResponseData UpdateCandidate(long num, PutCandidateParameter data)
{
var url = $"candidate/{num}";
var json = HttpHelpers.HttpPut(url, data);
var retVal = JsonConvert.DeserializeObject <GetCandidatesResponseData>(json);
return(retVal);
}
/// <summary>
/// This API endpoint will return a json object containing a single candidate, based on the num provided in the API call.
/// </summary>
/// <param name="num">Numeric ID of the candidate to retrieve</param>
/// <returns></returns>
public GetCandidatesResponseData RetrieveCandidate(long num)
{
var url = $"candidate/{num}";
var json = HttpHelpers.HttpGet(url);
var retVal = JsonConvert.DeserializeObject <GetCandidatesResponseData>(json);
return(retVal);
}
/// <summary>
/// This endpoint will create a candidate and add them to Referoo. If you want the candidate to be emailed right away requesting referee's, ensure the variable one_click_reference is set to 1.
/// </summary>
/// <param name="data">Data of candidate to create</param>
/// <returns></returns>
public GetCandidatesResponseData CreateCandidate(PostCandidateParameter data)
{
var url = $"candidate";
var json = HttpHelpers.HttpPost(url, data);
var retVal = JsonConvert.DeserializeObject <GetCandidatesResponseData>(json);
return(retVal);
}
/// <summary>
/// This endpoint will create a new candidate and create a new referee for them with one call. You can add up to 5 referee's per candidate. The referee will also be sent a reference request email.
/// </summary>
/// <param name="data">Data of candidate and referees to be created</param>
/// <returns></returns>
public GetCandidateWithRefereesResponse CreateCandidateWithReferees(PostCandidateWithRefereesParameter data)
{
var url = $"referee/quick";
var json = HttpHelpers.HttpPost(url, data);
var retVal = JsonConvert.DeserializeObject <GetCandidateWithRefereesResponse>(json);
return(retVal);
}
/// <summary>
/// This endpoint will create a new referee under the candidate num that was passed in the URL.
/// </summary>
/// <param name="num">Numeric ID of the candidate to link the referee to</param>
/// <param name="data">Data of referee to create</param>
/// <returns></returns>
public GetRefereesResponse CreateReferee(long num, PostRefereeParameter data)
{
var url = $"candidate/{num}/referee";
var json = HttpHelpers.HttpPost(url, data);
var retVal = JsonConvert.DeserializeObject <GetRefereesResponse>(json);
return(retVal);
}
/// <summary>
/// This API end point will update a candidate based on the ID passed in the call. Pass a JSON object containing the variables you wish to update.
/// </summary>
/// <param name="num">Numeric ID of the referee to update</param>
/// <param name="data">Data of referee to update</param>
/// <returns></returns>
public GetRefereesResponse UpdateReferee(long num, PutRefereeParameter data)
{
var url = $"referee/{num}";
var json = HttpHelpers.HttpPut(url, data);
var retVal = JsonConvert.DeserializeObject <GetRefereesResponse>(json);
return(retVal);
}
/// <summary>
/// This API endpoint will return a json object containing a single candidate, based on the ID provided in the API call.
/// </summary>
/// <param name="num">Numeric ID of the referee to retrieve</param>
/// <returns></returns>
public GetRefereesResponse RetrieveSingleReferee(long num)
{
var url = $"referee/{num}";
var json = HttpHelpers.HttpGet(url);
var retVal = JsonConvert.DeserializeObject <GetRefereesResponse>(json);
return(retVal);
}
/// <summary>
/// Returns the details of of the user who is currently connected to the API
/// </summary>
/// <returns></returns>
public GetAccountsResponseData GetMyAccount()
{
var url = "me";
var json = HttpHelpers.HttpGet(url);
var retVal = JsonConvert.DeserializeObject <GetAccountsResponseData>(json);
return(retVal);
}
/// <summary>
/// This API end point will update a child account based on the ID passed in the call. Pass a JSON object containing the variables you wish to update.
/// </summary>
/// <param name="num">Numeric ID of the account to update</param>
/// <param name="data">Data of account to update</param>
/// <returns></returns>
public PutAccountResponse UpdateChildAccount(long num, PostAccountParameter data)
{
var url = $"account/{num}";
var json = HttpHelpers.HttpPut(url, data);
var retVal = JsonConvert.DeserializeObject <PutAccountResponse>(json);
return(retVal);
}
/// <summary>
/// This API endpoint will return a json object containing a single account based on the ID provided in the API call
/// </summary>
/// <param name="num">Numeric ID of the account to retrieve</param>
/// <returns></returns>
public GetAccountsResponse RetrieveSingleChildAccount(long num)
{
var url = $"account/{num}";
var json = HttpHelpers.HttpGet(url);
var retVal = JsonConvert.DeserializeObject <GetAccountsResponse>(json);
return(retVal);
}
public GetBrandsResponse GetBrands()
{
var url = "brands";
var json = HttpHelpers.HttpGet(url);
var retVal = JsonConvert.DeserializeObject <GetBrandsResponse>(json);
return(retVal);
}
/// <summary>
/// This API endpoint will return a json object containing all of the referees a candidate has based on the record num provided in the API call.
/// </summary>
/// <param name="num">Numeric ID of the candidates referee's to retrieve</param>
/// <returns></returns>
public GetRefereesResponse RetrieveCandidatesReferees(long num)
{
var url = $"candidate/{num}/referees";
var json = HttpHelpers.HttpGet(url);
var retVal = new GetRefereesResponse();
retVal.Data = JsonConvert.DeserializeObject <GetRefereesResponseData[]>(json);
return(retVal);
}
/// <summary>
/// This endpoint will return an array of questionnaires linked to this account in order of creation date. Only public or published questionaires will be returned. Draft items are not accessible.
/// </summary>
/// <param name="offset">The number of items to skip before starting to collect the result set</param>
/// <param name="limit">The numbers of items to return. Up to 50 items can be returned at a time</param>
/// <returns></returns>
public List <GetQuestionnairesResponse> ListQuestionnaires(long offset = 0, long limit = 50)
{
var url = $"questionnaires?";
url = HttpHelpers.OffSetsandLimits(url, offset, limit);
var json = HttpHelpers.HttpGet(url);
var retVal = JsonConvert.DeserializeObject <List <GetQuestionnairesResponse> >(json);
return(retVal);
}
/// <summary>
/// This endpoint will return a list of referee's linked to your account in order of creation date.
/// </summary>
/// <param name="offset">The number of items to skip before starting to collect the result set</param>
/// <param name="limit">The numbers of items to return. Up to 50 items can be returned at a time.</param>
/// <returns></returns>
public GetRefereesResponse ListReferees(long offset = 0, long limit = 50)
{
var url = $"referees?";
url = HttpHelpers.OffSetsandLimits(url, offset, limit);
var json = HttpHelpers.HttpGet(url);
var retVal = JsonConvert.DeserializeObject <GetRefereesResponse>(json);
return(retVal);
}