/// <summary>
 /// Clock out a single employee using timeclock.clockout
 /// </summary>
 /// <param name="id">ShiftPlanning ID of the employee to clock out</param>
 /// <returns>API response data for timeclock.clockout</returns>
 public APIResponse clockOutEmployee(int id)
 {
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "timeclock.clockout");
     requestFields.Add("method", "GET");
     requestFields.Add("employee", id);
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse createAdminBackup(RequestFields details)
 {
     // create new admin file
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "admin.backup");
     requestFields.Add("method", "CREATE");
     //append details
     foreach (KeyValuePair<string, object> fld in details)
         requestFields.Add(fld.Key, fld.Value);
     //append filedetails
     RequestFields file_details = getFileData(details["filename"].ToString());
     foreach (KeyValuePair<string, object> fld in file_details)
         requestFields.Add(fld.Key, fld.Value);
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getStaffSkills()
 {
     // get a list of staff skills
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "staff.skills");
     requestFields.Add("method", "GET");
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse deleteVacationSchedule(int id)
 {
     // delete a VacationSchedule by id
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "schedule.vacation");
     requestFields.Add("method", "DELETE");
     requestFields.Add("id", id);
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getStaffSkillDetails(int id)
 {
     // get skill detail by id
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "staff.skill");
     requestFields.Add("method", "GET");
     requestFields.Add("id", id);
     this.setRequest(requestFields);
     return response;
 }

    public APIResponse updateVacationSchedule(RequestFields vacation_details)
    {
        // update VacationSchedule
        RequestFields requestFields = new RequestFields();
        requestFields.Add("module", "schedule.vacation");
        requestFields.Add("method", "UPDATE");
        //append fields
        foreach (KeyValuePair<string, object> fld in vacation_details)
            requestFields.Add(fld.Key, fld.Value);

        this.setRequest(requestFields);
        return response;
    }

    private RequestFields getFileData(string filename)
    {
        // get file details, (data, length, mimetype)
        try
        {
            RequestFields file_data = new RequestFields();
            if (File.Exists(filename))
            {// file found
                byte[] file_content = File.ReadAllBytes(filename);
                file_data.Add("filepath", filename);
                file_data.Add("filelength", file_content.Length);
                string extension = filename.Substring(filename.LastIndexOf(".") + 1);
                file_data.Add("mimetype", getFileMimeType(extension));

                return file_data;
            }
            else
            {// file not found
                throw new Exception(this.internal_errors(8));
            }
        }
        catch (Exception e)
        {// any error
            throw e;
        }
    }

 public APIResponse getWallMessages()
 {
     // get messages for the currently logged in user
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "messaging.wall");
     requestFields.Add("method", "GET");
     this.setRequest(requestFields);
     return response;
 }

 /*
  * User Authentication Methods
  *
  */
 public APIResponse doLogin(RequestFields login_details)
 {
     // perform a login api call
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "staff.login");
     requestFields.Add("method", "GET");
     //append message fields
     foreach (KeyValuePair<string, object> fld in login_details)
         requestFields.Add(fld.Key, fld.Value);
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getEmployeeDetails(int id)
 {
     // get employee details by id
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "staff.employee");
     requestFields.Add("method", "GET");
     requestFields.Add("id", id);
     this.setRequest(requestFields);
     return response;
 }

 /*
  * Staff Methods
  *
  */
 public APIResponse getEmployees()
 {
     // get a list of employees
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "staff.employees");
     requestFields.Add("method", "GET");
     this.setRequest(requestFields);
     return response;
 }

 /*
  * API Methods
  *
  */
 public APIResponse getAPIConfig()
 {
     // get API config
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "api.config");
     requestFields.Add("method", "GET");
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getAPIMethods()
 {
     // get API methods
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "api.methods");
     requestFields.Add("method", "GET");
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getAdminSettings()
 {
     // get admin settings
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "admin.settings");
     requestFields.Add("method", "GET");
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getAdminFileDetails(int id)
 {
     // get admin file details
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "admin.file");
     requestFields.Add("method", "GET");
     requestFields.Add("id", id);
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getAdminBackups()
 {
     // get admin files
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "admin.backups");
     requestFields.Add("method", "GET");
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getVacationScheduleDetails(int id)
 {
     // get VacationSchedule detail by id
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "schedule.vacation");
     requestFields.Add("method", "GET");
     requestFields.Add("id", id);
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse updateAdminFile(RequestFields details)
 {
     // update admin file details
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "admin.file");
     requestFields.Add("method", "UPDATE");
     //append employee details fields
     foreach (KeyValuePair<string, object> fld in details)
         requestFields.Add(fld.Key, fld.Value);
     this.setRequest(requestFields);
     return response;
 }

 public APIResponse getVacationSchedules(RequestFields time_period)
 {
     // get schedule vacations, pass start and end params to get vacations within a certian time-period
     RequestFields requestFields = new RequestFields();
     requestFields.Add("module", "schedule.vacations");
     requestFields.Add("method", "GET");
     //append fields
     foreach (KeyValuePair<string, object> fld in time_period)
         requestFields.Add(fld.Key, fld.Value);
     this.setRequest(requestFields);
     return response;
 }

    public APIResponse updateShift(RequestFields shift_details)
    {
        // update shift
        RequestFields requestFields = new RequestFields();
        requestFields.Add("module", "schedule.shift");
        requestFields.Add("method", "UPDATE");
        //append fields
        foreach (KeyValuePair<string, object> fld in shift_details)
            requestFields.Add(fld.Key, fld.Value);

        this.setRequest(requestFields);
        return response;
    }