FTSoapServer - staffcheck/api GitHub Wiki

FTSoapServer

Properties

$authentication

public mixed $authentication = NULL
  • Visibility: public

$permission_obj

public mixed $permission_obj = NULL
  • Visibility: public

$user_obj

public mixed $user_obj = NULL
  • Visibility: public

$company_obj

public mixed $company_obj = NULL
  • Visibility: public

$schedule_shift_obj

public mixed $schedule_shift_obj = NULL
  • Visibility: public

$shift_obj

public mixed $shift_obj = NULL
  • Visibility: public

$station_type

public mixed $station_type = NULL
  • Visibility: public

$user_id_to_timeclock_user_id_map

protected mixed $user_id_to_timeclock_user_id_map = FALSE
  • Visibility: protected

Methods

__construct

mixed FTSoapServer::__construct()

SoapServer constructor.

  • Visibility: public

getUserObject

boolean|null FTSoapServer::getUserObject()
  • Visibility: public

getUserPreferenceObject

mixed FTSoapServer::getUserPreferenceObject()
  • Visibility: public

getStationObject

object FTSoapServerUnAuthenticated::getStationObject($station_id)

Arguments

  • $station_id mixed

getCompanyObject

object FTSoapServerUnAuthenticated::getCompanyObject()

getScheduleShiftObject

mixed FTSoapServer::getScheduleShiftObject()
  • Visibility: public

getPermissionObject

null|\Permission FTSoapServer::getPermissionObject()
  • Visibility: public

getClientVersion

boolean FTSoapServerUnAuthenticated::getClientVersion()

getUserPreferenceData

array FTSoapServer::getUserPreferenceData()
  • Visibility: public

StationCheckAllowed

boolean FTSoapServer::StationCheckAllowed()
  • Visibility: public

setStation

boolean FTSoapServer::setStation($source, $station, null $description, integer $type)
  • Visibility: public

Arguments

  • $source mixed
  • $station mixed
  • $description null
  • $type integer

getUserFullName

mixed FTSoapServer::getUserFullName()
  • Visibility: public

getEnrollUsers

array|boolean FTSoapServer::getEnrollUsers()
  • Visibility: public

enroll

boolean FTSoapServer::enroll(string $user_id, string $id, string $type, integer $number, null $extra_value)
  • Visibility: public

Arguments

  • $user_id string - UUID
  • $id string - UUID
  • $type string
  • $number integer
  • $extra_value null

getPunchData

mixed FTSoapServer::getPunchData()
  • Visibility: public

setPunchData

string FTSoapServer::setPunchData($data)
  • Visibility: public

Arguments

  • $data mixed

Logout

boolean FTSoapServer::Logout()
  • Visibility: public

addLogEntry

mixed FTSoapServer::addLogEntry(string $object_id, integer $action_id, $description, string $user_id, $table)
  • Visibility: public

Arguments

  • $object_id string - UUID
  • $action_id integer
  • $description mixed
  • $user_id string - UUID
  • $table mixed

__call

boolean FTSoapServerUnAuthenticated::__call($name, $arguments)

Arguments

  • $name mixed
  • $arguments mixed

ping

boolean FTSoapServerUnAuthenticated::ping()

getTime

integer FTSoapServerUnAuthenticated::getTime()

getTimeOffset

integer FTSoapServerUnAuthenticated::getTimeOffset(integer $client_epoch)

Arguments

  • $client_epoch integer - EPOCH

isLoggedIn

boolean FTSoapServerUnAuthenticated::isLoggedIn()

Login

boolean|null FTSoapServerUnAuthenticated::Login($user_name, null $password, null $type)

Arguments

  • $user_name mixed
  • $password null
  • $type null

getLatestVersion

string FTSoapServerUnAuthenticated::getLatestVersion()

isLatestVersion

boolean FTSoapServerUnAuthenticated::isLatestVersion($current_version)

Arguments

  • $current_version mixed

getLatestVersionURL

string FTSoapServerUnAuthenticated::getLatestVersionURL()

getLatestVersionMD5

string FTSoapServerUnAuthenticated::getLatestVersionMD5()

isGoodTimeToUpgrade

integer FTSoapServerUnAuthenticated::isGoodTimeToUpgrade(string $station_id)

Arguments

  • $station_id string - UUID

startingUpgrade

boolean FTSoapServerUnAuthenticated::startingUpgrade(string $station_id)

Arguments

  • $station_id string - UUID

isLatestData

array|boolean FTSoapServerUnAuthenticated::isLatestData(string $station_id, integer $last_check_epoch)

Arguments

  • $station_id string - UUID
  • $last_check_epoch integer - EPOCH

getClientConfig

array FTSoapServerUnAuthenticated::getClientConfig(string $station_id)

Arguments

  • $station_id string - UUID

getUsers

array|boolean FTSoapServerUnAuthenticated::getUsers(string $station_id)

Arguments

  • $station_id string - UUID

getUserIdentifiers

array|boolean FTSoapServerUnAuthenticated::getUserIdentifiers(string $station_id)

Arguments

  • $station_id string - UUID

getBranches

array|boolean FTSoapServerUnAuthenticated::getBranches(string $station_id)

Arguments

  • $station_id string - UUID

getDepartments

array|boolean FTSoapServerUnAuthenticated::getDepartments(string $station_id)

Arguments

  • $station_id string - UUID

getJobs

array|boolean FTSoapServerUnAuthenticated::getJobs(string $station_id)

Arguments

  • $station_id string - UUID

getJobtoUserMap

array|boolean FTSoapServerUnAuthenticated::getJobtoUserMap(string $station_id)

Arguments

  • $station_id string - UUID

getJobItems

array|boolean FTSoapServerUnAuthenticated::getJobItems(string $station_id)

Arguments

  • $station_id string - UUID

getJobtoJobItemMap

array|boolean FTSoapServerUnAuthenticated::getJobtoJobItemMap(string $station_id)

Arguments

  • $station_id string - UUID

getOtherFields

boolean FTSoapServerUnAuthenticated::getOtherFields(string $station_id)

Arguments

  • $station_id string - UUID

setClientLog

boolean FTSoapServerUnAuthenticated::setClientLog($data)

Arguments

  • $data mixed

setOfflinePunch

boolean FTSoapServerUnAuthenticated::setOfflinePunch($data)

Arguments

  • $data mixed

getNextTimeClockUserId

boolean|integer FTSoapServerUnAuthenticated::getNextTimeClockUserId()

setTimeClockUserIdForUser

boolean FTSoapServerUnAuthenticated::setTimeClockUserIdForUser(string $user_id)

Arguments

  • $user_id string - UUID

getUserIdToTimeClockUserIdMap

boolean FTSoapServerUnAuthenticated::getUserIdToTimeClockUserIdMap($company_obj)

Arguments

  • $company_obj mixed

convertUserIdToTimeClockUserID

boolean|integer FTSoapServerUnAuthenticated::convertUserIdToTimeClockUserID(string $user_id)

Arguments

  • $user_id string - UUID

convertTimeClockUserIDToUserID

array|boolean|integer FTSoapServerUnAuthenticated::convertTimeClockUserIDToUserID(array $timeclock_user_ids, $company_obj)

Arguments

  • $timeclock_user_ids array - UUID
  • $company_obj mixed
⚠️ **GitHub.com Fallback** ⚠️