Gimmal Physical REST Services Technical Guide

void SetHeaders(HttpWebRequest webRequest, string method, string body)
{
  webRequest.Method = method;
  webRequest.Credentials = new NetworkCredential("[USERNAME] ", "[PASSWORD]");
  webRequest.PreAuthenticate = true;
  webRequest.AllowWriteStreamBuffering = true;
  if (method == "POST" || method == "PUT")
  {
    webRequest.ContentType = "application/json";
    webRequest.ContentLength = body.Length; 
    try
    {
      StreamWriter sw = new StreamWriter(webRequest.GetRequestStream());
      sw.Write(body);
      sw.Close();
    }
    catch (Exception ex){}
  }
}

public partial class IRAction 
{
  public virtual String Action { get; set; }
  public virtual String Caption { get; set; }
  public virtual String UrlCommand { get; set; }
  public virtual String PostObject { get; set; }
  public virtual Int32 AssociatedTabId { get; set; }
  public virtual String AssociatedTabName { get; set; }
  public virtual String AssociatedColumnName { get; set; }
} 

public IEnumerable<IRAction> GetActions() 
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Action/201");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRAction> objActions = JsonConvert.DeserializeObject<IEnumerable<IRAction>>(sr.ReadToEnd()); 
  sr.Close();
  webResponse.Close();
  return objActions;
}

public partial class IRDictionarySearch
{
  public virtual Int32 TabId { get; set; }
  public virtual String SpecialSearch { get; set; }
}

public partial class IRDictionary
{
  public virtual String Caption { get; set; }
  public virtual String ColumnName { get; set; }
}

public IEnumerable<IRDictionary> GetIRDictionary()
{
  // w is a string containing the http://[Servername]:[Port ID] part of the URL
  IRDictionarySearch Srch = new IRDictionarySearch();
  Srch.TabId = 201;
  Srch.SpecialSearch = "quicksearch";
  string body = JsonConvert.SerializeObject(Srch);
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Dictionary");
  SetHeaders(webRequest, "POST", body);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRDictionary> objDictionary = JsonConvert.DeserializeObject<IEnumerable<IRDictionary>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  webResponse = null;
  return objDictionary;  
}

// ******************************************
// * Item - Create/Update an Item
// ******************************************

public partial class IRItem
{
  public virtual List<IRColumn> columns { get; set; }
  public virtual String TabSingularName { get; set; }
  public virtual String EdocFile { get; set; }
  public virtual String ContentType { get; set; }
  public virtual Int32 Id { get; set; }
  public virtual String QuickDescription { get; set; }
  public virtual String Barcode { get; set; }
  public virtual Int32 TabId { get; set; }
}

public partial class IRColumn 
{
  public virtual String ColumnName { get; set; }
  public virtual String Caption { get; set; }
  public virtual String Value { get; set; }
  public virtual String Type { get; set; }
}

public partial class IRItemResultList 
{
  public virtual String Message { get; set; }
  public virtual bool Result { get; set; }
  public virtual IRItemResult[] ItemResults { get; set; }
} 

public partial class IRItemResult 
{
  public virtual String LocationBarcode { get; set; }
  public virtual String LocationDescription { get; set; }
  public virtual Int32 ItemId { get; set; }
  public virtual String ItemBarcode { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual Int32 RequestId { get; set; }
  public virtual bool Result { get; set; }
  public virtual Int32 Reason { get; set; }
  public virtual String Message { get; set; }
}

public IRItemResultList CreateUpdateItem() 
{
  // w is a string containing the http://[Servername]:[Port ID] part of the URL
  // IRColumns -- To create a new Item, you must provide at a minimum an IRColumn
  
  object
  // for each of that Item's requred fields for that Gimmal implementation,
  // though additional Item fields are allowed. The following three fields were
  
  required for
  // the Gimmal implementation that was used to create the sample code;
  // the fields required for your implementation will be different
  
  IRColumn IRC0 = new IRColumn();
  IRC0.ColumnName = "FK_ITEM_ORGANIZATION_ID";
  // IRC.Caption = "";
  IRC0.Value = "501";
  // IRC.Type = "";
  IRColumn IRC1 = new IRColumn();
  IRC1.ColumnName = "CONTENTS_RANGE___DATE";
  IRC1.Value = "1/1/2014-2/2/2015";
  IRColumn IRC2 = new IRColumn();
  IRC2.ColumnName = "I_IT_ID";
  IRC2.Value = "202";
  
  // Updating an existing Item requires adding the following 3 lines substituting the Item's ID for the "303" value 
  // Failure to specify an Item ID will result in the creation of a new Item
  // IRColumn IRC3 = new IRColumn();
  // IRC3.ColumnName = "I_ID";
  // IRC3.Value = "303";
  
  IRItem IRI = new IRItem(); 
  IRI.columns = new List<IRColumn> { }
  IRI.columns.Add(IRC0);
  IRI.columns.Add(IRC1);
  IRI.columns.Add(IRC2);
  
  // IRI.columns.Add(IRC3);
  // Alternative shorthand method:
  // IRI.columns = new List<IRColumn> {
  // new IRColumn { ColumnName="FK_ITEM_ORGANIZATION_ID", Value="302"},
  // new IRColumn { ColumnName="CONTENTS_RANGE___DATE", Value="1/1/2014-1/1/2015"}, 
  // new IRColumn { ColumnName="I_IT_ID", Value="202"}
  // }; 

  List<IRItem> iList = new List<IRItem>();
  iList.Add(IRI);
  string body = JsonConvert.SerializeObject(iList);
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Item");
  SetHeaders(webRequest, "POST", body);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRItemResultList objNewItem = JsonConvert.DeserializeObject<IRItemResultList>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  webResponse = null;
  return objNewItem;
}

// **************************************************************
// * Item - Delete an Item
// * Sets column I_Deleted to true in the Item’s database table
// ************************************************************** 

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 1203 is the ID of the Box to be deleted
// objItemResult.Result will be true if successful

public partial class IRItemResult
{
  public virtual String LocationBarcode { get; set; }
  public virtual String LocationDescription { get; set; }
  public virtual Int32 ItemId { get; set; }
  public virtual String ItemBarcode { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual Int32 RequestId { get; set; }
  public virtual bool Result { get; set; }
  public virtual Int32 Reason { get; set; }
  public virtual String Message { get; set; }
}

public IRItemResult DeleteItem()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Item/1203");
  SetHeaders(webRequest, "DELETE", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRItemResult objItemResult = JsonConvert.DeserializeObject<IRItemResult>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objItemResult;
}

// ****************************************************************************
// * Item - Get a single Item by its ID
// ****************************************************************************

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 303 is the ID of the Box being retrieved
// objItem will contain the Item if the get is successful

public partial class IRItem
{
  public virtual List<IRColumn> columns { get; set; 
  public virtual String TabSingularName { get; set; }
  public virtual String EdocFile { get; set; }
  public virtual String ContentType { get; set; }
  public virtual Int32 Id { get; set; }
  public virtual String QuickDescription { get; set; }
  public virtual String Barcode { get; set; }
  public virtual Int32 TabId { get; set; }
}

public partial class IRColumn
{
  public virtual String ColumnName { get; set; }
  public virtual String Caption { get; set; }
  public virtual String Value { get; set; }
  public virtual String Type { get; set; }
}

public IRItem GetItemByID()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Item/303");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRItem objItem = JsonConvert.DeserializeObject<IRItem>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objItem;
}

// ****************************************************************************
// * Item - Advance Search for Items
// ****************************************************************************

public partial class IRItem
{
  public virtual List<IRColumn> columns { get; set; }
  public virtual String TabSingularName { get; set; }
  public virtual String EdocFile { get; set; }
  public virtual String ContentType { get; set; }
  public virtual Int32 Id { get; set; }
  public virtual String QuickDescription { get; set; }
  public virtual String Barcode { get; set; }
  public virtual Int32 TabId { get; set; }
}

public partial class IRColumn
{
  public virtual String ColumnName { get; set; }
  public virtual String Caption { get; set; }
  public virtual String Value { get; set; }
  public virtual String Type { get; set; }
]

public partial class IRItemSearch
{
  public virtual String SpecialSearch { get; set; }
  public virtual String LastSyncDate { get; set; }
  public virtual int TabId { get; set; }
  public virtual String Barcode { get; set; }
  public virtual Dictionary<String, object> SearchTerms { get; set; }
  public virtual bool IncludeEdocFile { get; set; }
  public virtual bool ViewDisplay { get; set; }
  public virtual bool GetForeignKeyDesc { get; set; }
  public virtual String CrudXML { get; set; }
}

public IEnumerable<IRItem> ItemSearch()
{
  // w is a string containing the http://[Servername]:[Port ID] part of the URL
  IRItemSearch IRIS = new IRItemSearch();
  IRIS.TabId = 202; // Box Item Type
  IRIS.SearchTerms = new Dictionary<String, object>();
  
  // Search the "Box_Description" database column for rows with value "Little Box":
  IRIS.SearchTerms.Add("BOX_DESCRIPTION", "Little Box");
  // Search for Missing Boxes
  //IRIS.SpecialSearch = "missing";
  string body = JsonConvert.SerializeObject(IRIS);
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/ItemSearch");
  SetHeaders(webRequest, "POST", body)
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRItem> objFoundItems = JsonConvert.DeserializeObject<IEnumerable<IRItem>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  webResponse = null;
  return objFoundItems;
}

// ****************************************************************************
// * Item - Get the URL for a single Item by its ID
// ****************************************************************************

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 303 is the ID of the Box whose URL we want

public String GetURLByID()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/viewurl/303");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  String strURL = JsonConvert.DeserializeObject<String>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return strURL;
}

// ****************************************************************************
// * Label - Get Label Queues for a given Tab (Item Type)
// ****************************************************************************

public partial class IRLabelProfile
{
  public virtual String Name { get; set; }
  public virtual int Id { get; set; }
  public virtual int VendorId { get; set; }
}

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 202 is the Item Type ID

public IEnumerable<IRLabelProfile> GetLabelQueues()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/labelprofiles/202");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRLabelProfile> objQueues = JsonConvert.DeserializeObject<IEnumerable<IRLabelProfile>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objQueues;
}

// ****************************************************************************
// * Picklist - Gets picklist rows for a given Tab (Item Type)
// ****************************************************************************

public partial class IRPicklistItem
{
  public virtual Dictionary<String, object> Columns { get; set; }
  public virtual String QuickDescription { get; set; }
  public virtual int Id { get; set; }
  public virtual int TabId { get; set; }
} 

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 202 is the integer TabID (Item Type ID)

public IEnumerable<IRPicklistItem> GetPicklistByTab()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/picklist/202");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRPicklistItem> objItems = JsonConvert.DeserializeObject<IEnumerable<IRPicklistItem>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objItems;
}

// ****************************************************************************
// * Request - Gets all checkout Requests in Gimmal
// ****************************************************************************

public partial class IRRequest
{
  public virtual int Id { get; set; }
  public virtual int ItemId { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual int DestinationItemId { get; set; }
  public virtual String DestinationDescription { get; set; }
  public virtual bool Waitlist { get; set; }
  public virtual String CreateDate { get; set; }
  public virtual String RequestorName { get; set; }
  public virtual String RequestorDesc { get; set; }
  public virtual int Status { get; set; }
  public virtual String StatusDescription { get; set; }
  public virtual int BatchNumber { get; set; }
  public virtual int FulfillmentMethod { get; set; }
  public virtual int RequestType { get; set; }
  public virtual String Comment { get; set; }
}

// w is a string containing the http://[Servername]:[Port ID] part of the URL

public IEnumerable<IRRequest> GetAllRequests()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Request");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRRequest> objRequests = JsonConvert.DeserializeObject<IEnumerable<IRRequest>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objRequests;
}

// ****************************************************************************
// * Request - Create a new Item checkout Request
// ****************************************************************************

public partial class IRRequest
{
  public virtual int Id { get; set; }
  public virtual int ItemId { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual int DestinationItemId { get; set; }
  public virtual String DestinationDescription { get; set; }
  public virtual bool Waitlist { get; set; }
  public virtual String CreateDate { get; set; }
  public virtual String RequestorName { get; set; }
  public virtual String RequestorDesc { get; set; }
  public virtual int Status { get; set; }
  public virtual String StatusDescription { get; set; }
  public virtual int BatchNumber { get; set; }
  public virtual int FulfillmentMethod { get; set; }
  public virtual int RequestType { get; set; }
  public virtual String Comment { get; set; }
}

public partial class IRRequestResult
{
  public virtual IRRequest Request { get; set; }
  public virtual String ItemBarcode { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual String Message { get; set; }
  public virtual bool Result { get; set; }
}

public IRRequestResult CreateRequest()
{
  // w is a string containing the http://[Servername]:[Port ID] part of the URL
  IRRequest Request = new IRRequest();
  Request.ItemId = 40000; // Required; ID of the Item being checked out
  Request.RequestType = 1; // Required; 1=Delivery; 2=Pickup; 4=Renew
  Request.DestinationItemId = 201; // ID of the user to check the Item out to
  string body = JsonConvert.SerializeObject(Request);
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Request");
  SetHeaders(webRequest, "POST", body);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRRequestResult objResult = JsonConvert.DeserializeObject<IRRequestResult>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  webResponse = null;
  return objResult;
}

// *******************************************************************
// * Request - Delete an Item checkout Request
// *******************************************************************

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 217 is the ID of the Request to be deleted
// If successful, webResponse.StatusCode will be "OK"

public HttpStatusCode DeleteRequest()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Request/217");
  SetHeaders(webRequest, "DELETE", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  return webResponse.StatusCode;
}

// ****************************************************************************
// * Request - Gets checkout Request by Request ID
// ****************************************************************************

public partial class IRRequest
{
  public virtual int Id { get; set; }
  public virtual int ItemId { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual int DestinationItemId { get; set; }
  public virtual String DestinationDescription { get; set; }
  public virtual bool Waitlist { get; set; }
  public virtual String CreateDate { get; set; }
  public virtual String RequestorName { get; set; }
  public virtual String RequestorDesc { get; set; }
  public virtual int Status { get; set; }
  public virtual String StatusDescription { get; set; }
  public virtual int BatchNumber { get; set; }
  public virtual int FulfillmentMethod { get; set; }
  public virtual int RequestType { get; set; 
  public virtual String Comment { get; set; }
}

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 215 is the ID of the checkout Request to get

public IRRequest GetRequestByID()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Request/215");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRRequest objRequest = JsonConvert.DeserializeObject<IRRequest>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objRequest;
}

// ****************************************************************************
// * Request - Update an existing checkout Request
// ****************************************************************************

public partial class IRRequest
{
  public virtual int Id { get; set; }
  public virtual int ItemId { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual int DestinationItemId { get; set; }
  public virtual String DestinationDescription { get; set; }
  public virtual bool Waitlist { get; set; }
  public virtual String CreateDate { get; set; }
  public virtual String RequestorName { get; set; }
  public virtual String RequestorDesc { get; set; }
  public virtual int Status { get; set; }
  public virtual String StatusDescription { get; set; }
  public virtual int BatchNumber { get; set; }
  public virtual int FulfillmentMethod { get; set; }
  public virtual int RequestType { get; set; }
  public virtual String Comment { get; set; }
}

public partial class IRRequestResult
{
  public virtual IRRequest Request { get; set; }
  public virtual String ItemBarcode { get; set; 
  public virtual String ItemDescription { get; set; }
  public virtual String Message { get; set; }
  public virtual bool Result { get; set; }
} 

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 215 is the ID of the Request you're updating

public IRRequestResult UpdateRequest()
{
  IRRequest Request = new IRRequest();
  Request.Status = 2; //Possible Status Values: 1 = Approved; 2 = Fulfilled; 3 = Rejected; 5 = Deleted 
  Request.DestinationItemId = 201; // ID of the user to check the Item out to
  string body = JsonConvert.SerializeObject(Request);
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Request/215");
  SetHeaders(webRequest, "PUT", body);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRRequestResult objResult = JsonConvert.DeserializeObject<IRRequestResult>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  webResponse = null;
  return objResult;
}

// ****************************************************************************
// * Request - Find Item checkout Requests
// ****************************************************************************

public partial class IRRequestSearch
{
  public virtual bool OnlyMine { get; set; }
  public virtual int Report { get; set; }
  public virtual int TabId { get; set; }
  public virtual bool GetDescriptions { get; set; }
}

public partial class IRRequest
{
  public virtual int Id { get; set; }
  public virtual int ItemId { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual int DestinationItemId { get; set; }
  public virtual String DestinationDescription { get; set; }
  public virtual bool Waitlist { get; set; }
  public virtual String CreateDate { get; set; }
  public virtual String RequestorName { get; set; }
  public virtual String RequestorDesc { get; set; }
  public virtual int Status { get; set; }
  public virtual String StatusDescription { get; set; }
  public virtual int BatchNumber { get; set; }
  public virtual int FulfillmentMethod { get; set; }
  public virtual int RequestType { get; set; }
  public virtual String Comment { get; set; }
}

public IEnumerable<IRRequest> FindRequest()
{
  // w is a string containing the http://[Servername]:[Port ID] part of the URL
  IRRequestSearch RequestSearch = new IRRequestSearch();
  string body = JsonConvert.SerializeObject(RequestSearch);
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/requestsearch");
  SetHeaders(webRequest, "POST", body);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRRequest> objResult = JsonConvert.DeserializeObject<IEnumerable<IRRequest>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  webResponse = null;
  return objResult;
}

// ****************************************************************************
// * ServerTime - Get the UTC time from the Gimmal Web Server
// ****************************************************************************

// w is a string containing the http://[Servername]:[Port ID] part of the URL

public DateTime GetDateTime()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/servertime");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  // Converting the string response to a DateTime object
  DateTime objItems = JsonConvert.DeserializeObject<DateTime>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objItems;
}

// ****************************************************************************
// * Tab - Get all Tabs
// ****************************************************************************

public partial class IRTab
{
  public virtual Int32 Id { get; set; }
  public virtual String SingularName { get; set; }
  public virtual String PluralName { get; set; }
  public virtual Boolean IsMoveable { get; set; }
  public virtual Boolean IsRequestable { get; set; }
  public virtual Boolean AutoGenerateBarcode { get; set; }
  public virtual Boolean IsBarcodeRequired { get; set; }
  public virtual String BarcodePrefix { get; set; }
  public virtual Int32 BarcodeLength { get; set; }
  public virtual Boolean IsEdoc { get; set; }
  public virtual Int32 DisplayOrder { get; set; }
  public virtual Boolean IsRetentionEnabled { get; set; }
  public virtual Int32 SpecialType { get; set; }
}

public IEnumerable<IRTab> GetAllTabs()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Tab");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRTab> objItems = JsonConvert.DeserializeObject<IEnumerable<IRTab>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objItems;
}

// ****************************************************************************
// * Tab - Get filtered Tabs
// ****************************************************************************

public partial class IRTab
{
  public virtual Int32 Id { get; set; }
  public virtual String SingularName { get; set; }
  public virtual String PluralName { get; set; }
  public virtual Boolean IsMoveable { get; set; }
  public virtual Boolean IsRequestable { get; set; }
  public virtual Boolean AutoGenerateBarcode { get; set; }
  public virtual Boolean IsBarcodeRequired { get; set; }
  public virtual String BarcodePrefix { get; set; }
  public virtual Int32 BarcodeLength { get; set; }
  public virtual Boolean IsEdoc { get; set; }
  public virtual Int32 DisplayOrder { get; set; }
  public virtual Boolean IsRetentionEnabled { get; set; }
  public virtual Int32 SpecialType { get; set; }
}

// w is a string containing the http://[Servername]:[Port ID] part of the URL

public IEnumerable<IRTab> GetFilteredTabs()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/tab?itemtypefilter=topshelfuser");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IEnumerable<IRTab> objTabs = JsonConvert.DeserializeObject<IEnumerable<IRTab>>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objTabs;
}

// ****************************************************************************
// * Tab - Get a single Tab by its ID
// ****************************************************************************

public partial class IRTab
{
  public virtual Int32 Id { get; set; }
  public virtual String SingularName { get; set; }
  public virtual String PluralName { get; set; }
  public virtual Boolean IsMoveable { get; set; }
  public virtual Boolean IsRequestable { get; set; }
  public virtual Boolean AutoGenerateBarcode { get; set; }
  public virtual Boolean IsBarcodeRequired { get; set; }
  public virtual String BarcodePrefix { get; set; }
  public virtual Int32 BarcodeLength { get; set; }
  public virtual Boolean IsEdoc { get; set; }
  public virtual Int32 DisplayOrder { get; set; }
  public virtual Boolean IsRetentionEnabled { get; set; }
  public virtual Int32 SpecialType { get; set; }
}

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 201 is the ID for a particular Tab

public IRTab GetTab()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/tab/201");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRTab objTab = JsonConvert.DeserializeObject<IRTab>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return objTab;
}

// *******************************************************************************
// * Test - Test connection with Gimmal Physical Web Services. Authentication not needed.
// *******************************************************************************

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// A successful test returns string "Successfully connected to InfolinxRest"

public string Test()
{
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/Test");
  SetHeaders(webRequest, "GET", null);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  string testResponse = JsonConvert.DeserializeObject<string>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  return testResponse;
}

// *******************************************************************************
// * Transfer - Transfer Items to a new containing Item (location)
// *******************************************************************************

public partial class IRTransfer
{
  public virtual String Location { get; set; }
  public virtual String[] Items { get; set; }
}

public partial class IRItemResultList
{
  public virtual String Message { get; set; }
  public virtual bool Result { get; set; }
  public virtual IRItemResult[] ItemResults { get; set; }
}

public partial class IRItemResult
{
  public virtual String LocationBarcode { get; set; }
  public virtual String LocationDescription { get; set; }
  public virtual Int32 ItemId { get; set; }
  public virtual String ItemBarcode { get; set; }
  public virtual String ItemDescription { get; set; }
  public virtual Int32 RequestId { get; set; }
  public virtual bool Result { get; set; }
  public virtual Int32 Reason { get; set; }
  public virtual String Message { get; set; }
} 

// w is a string containing the http://[Servername]:[Port ID] part of the URL
// 0000010265 is the barcode of the user to whom the Items are being transferred
// 0000011667 and 0000017757 are the barcodes of the items being transferred

public IRItemResultList doTransfer()
{
  IRTransfer t = new IRTransfer();
  t.Location = "0000010265"; // Barcode of Location or User to which Items should be transfered
  t.Items = new string[] {"0000011667", "0000017757"}; // Array of Barcodes of Items to be transfered
  string body = JsonConvert.SerializeObject(t);
  var webRequest = (HttpWebRequest)WebRequest.Create(w + "/api/transfer");
  SetHeaders(webRequest, "POST", body);
  var webResponse = (HttpWebResponse)webRequest.GetResponse();
  StreamReader sr = new StreamReader(webResponse.GetResponseStream());
  IRItemResultList objItems =
  JsonConvert.DeserializeObject<IRItemResultList>(sr.ReadToEnd());
  sr.Close();
  webResponse.Close();
  webResponse = null;
  return objItems;
}

public class IRIO 
{
  public string Results { get; set; }
  public string FileName { get; set; }
  public string Extension { get; set; }
  public int Position { get; set; }
  public int CountOfBytesReceived { get; set; }
  public long TotalFileLength { get; set; }
  public bool NewFile { get; set; }
  public FileLocation FileLocationType { get; set; }
  public enum FileLocation
  {
    Edoc = 1,
    Interchange = 2,
    Label = 3,
    Report = 4
  }
  public long MaxFileTransferSize { get; set; }
  public string FilePath { get; set; }
  public bool Complete { get; set; }
  public byte[] buffer { get; set; }
}

public static async Task<IRIO> GetFileInChunks(IRIO objIO)
{
  var handler = new HttpClientHandler
  {
    Proxy = WebRequest.GetSystemWebProxy(),
    UseProxy = true
  };
  using (var client = new IRIOClient(handler,InfolinxRestBaseAddress))
  {
    SetupHttpClient(client.HttpClient, UserName, Password); 
    var response = await client.GetAsyncInChunks(objIO);
    response.EnsureSuccessStatusCode();
    IRIO results = await response.Content.ReadAsAsync<IRIO>().ConfigureAwait(true);
    return results;
  }
} 

IO.MaxFileTransferSize = this._FileSizeToTransfer != 0 ? Convert.ToInt64(this._FileSizeToTransfer) : 2097152; //default to 2MB if no size given
IO.FileName = strFileName;
IO.Extension = strExtension;
IO.CountOfBytesReceived = 0
IRIO Ret = await InfolinxRestProxy.GetFileInChunks(IO);
if (Ret.FileName.Length > 0)
{
  long lngReturnedLength = Convert.ToInt64(Ret.buffer.Length);
  IO.CountOfBytesReceived = Ret.CountOfBytesReceived;
  while (Ret.TotalFileLength >= lngReturnedLength)
  {
    Stream stream = new MemoryStream(Ret.buffer);
    using (System.IO.FileStream output = new System.IO.FileStream(processedFilesDir + Ret.FileName, FileMode.Append))
    {
      stream.CopyTo(output);
    }
    if (Ret.TotalFileLength > lngReturnedLength)
    {
      Ret = await InfolinxRestProxy.GetFileInChunks(IO);
      IO.CountOfBytesReceived += Ret.CountOfBytesReceived;
      lngReturnedLength += Convert.ToInt64(Ret.buffer.Length);
    }
    else
    {
      this.LogAndErrorFileRetrieved = true;
      break;
    }
  }
}

public async static Task<IRIO> PostAsyncInChuncks(IRIO objIO)
{
  var handler = new HttpClientHandler
  {
    Proxy = WebRequest.GetSystemWebProxy(),
    UseProxy = true
  };
  using (var client = new IRIOClient(handler,InfolinxRestBaseAddress))
  {
    SetupHttpClient(client.HttpClient,UserName,Password);
    var response = await client.PostAsyncInChuncks(objIO);
    response.EnsureSuccessStatusCode();
    return await response.Content.ReadAsAsync<IRIO>();
  }
}

public async Task<HttpResponseMessage> PostAsyncInChuncks(IRIO objIO)
{
  return await HttpClient.PostAsJsonAsync<IRIO>("api/sendChunks", objIO).ConfigureAwait(false);
}

public async Task<string> TextFileUpload()
{
  FileStream fs = null;
  string uploadedFileName = "";
  try
  {
    fs = File.OpenRead(this._fileNameAndPath);
    long lngTransferSize = fs.Length
    fs.Close();
    fs.Dispose();
    long maxTransferSize = 2097152; //2 MB
    if (this._FileSizeToTransfer > 0)
    {
      maxTransferSize = this._FileSizeToTransfer;
    }
    if (maxTransferSize > lngTransferSize)
    {
      maxTransferSize = lngTransferSize;
    }
    byte[] buffer = new byte[maxTransferSize];
    int len;
    InfolinxRestProxy.InfolinxRestBaseAddress = this._InfolinxRestBaseAddress;
    InfolinxRestProxy.UserName = this._UserName;
    InfolinxRestProxy.Password = this._Password;
    IRIO IO = new IRIO();
    IO.FileName = this._fileName;
    IO.buffer = buffer;
    IO.FileLocationType = IRIO.FileLocation.Interchange;
    IO.Position = 0;
    IO.NewFile = true;
    int Offset = 0;
    using (FileStream f = new FileStream(this._fileNameAndPath, FileMode.Open, FileAccess.Read))
    {
      try
      {
        f.Position = Offset;
        int BytesRead = 0;
        while (Offset != f.Length)
        {
          BytesRead = f.Read(buffer, 0, buffer.Length);
          if (BytesRead != buffer.Length)
          {
            maxTransferSize = BytesRead;
            byte[] TrimmedBuffer = new byte[BytesRead];
            Array.Copy(buffer, TrimmedBuffer, BytesRead);
            buffer = TrimmedBuffer;
            IO.buffer = buffer;
          }
          IRIO Ret = await InfolinxRestProxy.PostFileInChuncks(IO);
          IO.FileName = Ret.FileName;
          IO.NewFile = false;
          Offset += BytesRead;
        }
      }
      catch (Exception ex)
      {
        Notifications.NotificationService.WriteToEventLog("Error uploading import file " + ex.ToString(), EventLogEntryType.Error, this._session);
      }
    }
    uploadedFileName = IO.FileName;
  }
  catch (Exception EX)
  {
    this.OnExceptionOccurred(EX);
    return EX.ToString();
  }
  finally
  {
    if (fs != null)
    {
      fs.Dispose();
    }
  }
  return uploadedFileName;
}