Field Objects

Field

This object refers to how fields defined in Hawksearch for your account will be returned to or fed to the Hawksearch API.

public class FieldModel {
   public int FieldId { get; set; }
   public Guid SyncGuid { get; set; }
   public string Label { get; set; }
   public string Name { get; set; }
   public bool IsPrimaryKey { get; set; }
   public string Type { get; set; }
   public string FieldType { get; set; }
   public int Boost { get; set; }
   public int FacetHandler { get; set; }
   public bool IsOutput { get; set; }  
   public bool IsShingle { get; set; }
   public bool IsBestFragment { get; set; }
   public bool IsDictionary { get; set; }
   public bool IsSort { get; set; }
   public bool IsPrefix { get; set; } //V9
   public bool IsHidden { get; set; }
   public bool IsCompare { get; set; }
   public int SortOrder { get; set; }   
   public string PartialQuery { get; set; }
   public bool IsKeywordText { get; set; }
   public bool IsQuery { get; set; }
   public bool IsQueryText { get; set; }
   public bool SkipCustom { get; set; }
   public bool StripHtml { get; set; }
   public int MinNGramAnalyzer { get; set; }
   public int MaxNGramAnalyzer { get; set; }
   public int CoordinateType { get; set; }
   public bool OmitNorms { get; set; }
   public string ItemMapping { get; set; }
   public string DefaultValue { get; set; }
   public bool UseForPrediction { get; set; }
   public string CopyTo { get; set; }
   public string Analyzer { get; set; }
   public bool DoNotStore { get; set; }
   public string Tags { get; set; } //V4
   public int[] Iterations  { get; set; } //V8
   public string AnalyzerLanguage { get; set; } //V8
   public string PreviewMapping { get; set; } //V8
   public bool OmitTfAndPos { get; set; } //V8
   public DateTime CreateDate { get; set; } //V8
   public DateTime ModifyDate { get; set; } //V8
   public bool IsChild { get; set; } //V10
   public bool IsHierarchical { get; set; } //V10
}

Field Info

public class FieldInfo 
{
  public int FieldId { get; }
  public string Name { get; }
  public bool IsSort { get; }
}

Field Sort By

This object refers to how FieldSortBy defined in Hawksearch and available for sorting purposes on the landing page will be returned back.

public class FieldSortBy
{
  public int FieldId { get; set; }
  public string Name { get; set; }
  public string Label { get; set; }
}