/// <summary>
/// Use this call to retrieve a list of rules of a given type
/// </summary>
/// <param name="type">The rule type.</param>
/// <returns>A list of rules of the requested type</returns>
public List <RuleHeaderBasic> GetRulesByType(RuleSetType type)
{
var response = GetResponse("RulesEngine/GetRulesByType", "type=" + type.ToString() + "", "POST");
return(JsonFormatter.ConvertFromJson <List <RuleHeaderBasic> >(response));
}
/// <summary>
/// Use this call to get a list of valid options for a given field (and, if relevant, key).
/// </summary>
/// <param name="fieldName">The field name.</param>
/// <param name="type">The rule type.</param>
/// <param name="key">The key (optional).</param>
/// <returns>Returns a list of options.</returns>
public List <String> GetOptions(String fieldName, RuleSetType type, String key)
{
var response = GetResponse("RulesEngine/GetOptions", "fieldName=" + System.Net.WebUtility.UrlEncode(fieldName) + "&type=" + type.ToString() + "&key=" + System.Net.WebUtility.UrlEncode(key) + "", "POST");
return(JsonFormatter.ConvertFromJson <List <String> >(response));
}
/// <summary>
/// Use this call to get a list of fields and keys used by a given rule type
/// </summary>
/// <param name="type">The rule type.</param>
/// <returns>A object containing a list of fields for enabled rules</returns>
public RulesFields GetRequiredFieldsByType(RuleSetType type)
{
var response = GetResponse("RulesEngine/GetRequiredFieldsByType", "type=" + type.ToString() + "", "POST");
return(JsonFormatter.ConvertFromJson <RulesFields>(response));
}
/// <summary>
/// Use this call to get a list of valid options for a given set of fields (and, if relevant, keys).
/// </summary>
/// <param name="type">The rule type.</param>
/// <param name="fieldKeys">A list of fields and optionally keys.</param>
/// <returns>A list of valid options grouped by Field/Key</returns>
public List <MultiOptionResponse> GetMultiOptions(RuleSetType type, List <FieldKeys> fieldKeys)
{
var response = GetResponse("RulesEngine/GetMultiOptions", "type=" + type.ToString() + "&fieldKeys=" + System.Net.WebUtility.UrlEncode(JsonFormatter.ConvertToJson(fieldKeys)) + "", "POST");
return(JsonFormatter.ConvertFromJson <List <MultiOptionResponse> >(response));
}
/// <summary>
/// Use this call to get a list of valid evaluation fields for a given rule type.
/// </summary>
/// <param name="type">The rule type.</param>
/// <returns>Returns a list of evaluation available fields.</returns>
public List <FieldDescriptor> GetEvaluationFields(RuleSetType type)
{
var response = GetResponse("RulesEngine/GetEvaluationFields", "type=" + type.ToString() + "", "POST");
return(JsonFormatter.ConvertFromJson <List <FieldDescriptor> >(response));
}
/// <summary>
/// Use this call to create a new draft rule of a specified type.
/// </summary>
/// <param name="ruleName">The name for the new draft.</param>
/// <param name="type">The rule type.</param>
/// <returns>The rule header.</returns>
public RuleHeaderBasic CreateNewDraft(String ruleName, RuleSetType type)
{
var response = GetResponse("RulesEngine/CreateNewDraft", "ruleName=" + System.Net.WebUtility.UrlEncode(ruleName) + "&type=" + type.ToString() + "", "POST");
return(JsonFormatter.ConvertFromJson <RuleHeaderBasic>(response));
}
/// <summary>
/// Use this call to retrieve a list of valid action types for the rule type
/// </summary>
/// <param name="type">The rule type.</param>
/// <returns>Valid action types</returns>
public List <ActionTypeDescriptor> GetActionTypes(RuleSetType type)
{
var response = GetResponse("RulesEngine/GetActionTypes", "type=" + type.ToString() + "");
return(JsonFormatter.ConvertFromJson <List <ActionTypeDescriptor> >(response));
}
/// <summary>
/// Use this call to get a list of valid options for a given set of fields (and, if relevant, keys).
/// </summary>
/// <param name="type">The rule type.</param>
/// <param name="fieldKeys">A list of fields and optionally keys.</param>
/// <returns>A list of valid options grouped by Field/Key</returns>
public List <MultiOptionResponse> GetMultiOptions(RuleSetType type, List <FieldKeys> fieldKeys)
{
var response = GetResponse("RulesEngine/GetMultiOptions", "type=" + type.ToString() + "&fieldKeys=" + JsonFormatter.ConvertToJson(fieldKeys) + "");
return(JsonFormatter.ConvertFromJson <List <MultiOptionResponse> >(response));
}
