TimeTrex API Manual

APITimeClockUnAuthenticated

Table of Contents

$company_obj  : mixed
$mode_flag  : mixed
$station_obj  : mixed
$test_mode  : mixed
$user_id_to_timeclock_user_id_map  : mixed
__construct()  : mixed
APITimeClockUnAuthenticated constructor.
checkStationType()  : bool
getCompanyObject()  : bool|null
getConfig()  : bool
getDate()  : int
getFirmware()  : array<string|int, mixed>|bool
getFirmwareFile()  : string
getFirmwareVersion()  : bool
getLatestFirmwareVersion()  : string
getMessage()  : array<string|int, mixed>
getModeFlagMap()  : mixed
getStationObject()  : bool|null
getTimeZone()  : array<string|int, mixed>
getUserIdentification()  : array<string|int, mixed>|bool
The clock needs to pass a list of new users that were just added to it, so the identification for those users is included no matter what, along with any new data.
getUserIdForEmployeeNumber()  : bool|int
getUsers()  : array<string|int, mixed>|bool
Accept a list of valid_user_ids from getUserIDs() so we can always send data for those users.
isLatestData()  : array<string|int, mixed>
isLatestFirmwareVersion()  : bool
ping()  : bool
PING function to test internet connection.
setAttendance()  : bool
setLog()  : bool
setUserIdentification()  : bool
convertTimeClockUserIDToUserID()  : array<string|int, mixed>|bool|int
convertUserIdToTimeClockUserID()  : bool|int
getNextTimeClockUserId()  : bool|int
getStatusAndType()  : array<string|int, mixed>
getUserIdToTimeClockUserIdMap()  : bool
getUserIdToTimeClockUserIdMapInitializationDate()  : bool|int
processPunches()  : bool
setTimeClockUserIdForUser()  : bool

Properties

Methods

getConfig()

public getConfig(int $last_check_epoch[, array<string|int, mixed> $current_config = [] ]) : bool
Parameters
$last_check_epoch : int
$current_config : array<string|int, mixed> = []
Return values
bool

getFirmware()

public getFirmware([null $current_version = null ]) : array<string|int, mixed>|bool
Parameters
$current_version : null = null
Return values
array<string|int, mixed>|bool

getMessage()

public getMessage(string $user_id, int $punch_status, int $order) : array<string|int, mixed>
Parameters
$user_id : string

UUID

$punch_status : int
$order : int
Return values
array<string|int, mixed>

getUserIdentification()

The clock needs to pass a list of new users that were just added to it, so the identification for those users is included no matter what, along with any new data.

public getUserIdentification(int $last_update_epoch[, array<string|int, mixed> $clock_user_ids = [] ]) : array<string|int, mixed>|bool

The clock will need to do this automatically.

Parameters
$last_update_epoch : int
$clock_user_ids : array<string|int, mixed> = []
Return values
array<string|int, mixed>|bool

getUserIdForEmployeeNumber()

public getUserIdForEmployeeNumber( $employee_number) : bool|int
Parameters
$employee_number :
Return values
bool|int

getUsers()

Accept a list of valid_user_ids from getUserIDs() so we can always send data for those users.

public getUsers(int $last_update_epoch[, array<string|int, mixed> $clock_user_ids = [] ]) : array<string|int, mixed>|bool

as well as sending updated data based on last_update_epoch. Since users can be assigned/unassigned from clocks without updating their own data in some cases.

Parameters
$last_update_epoch : int
$clock_user_ids : array<string|int, mixed> = []
Return values
array<string|int, mixed>|bool

isLatestData()

public isLatestData(int $last_check_epoch[, int $clock_epoch = null ]) : array<string|int, mixed>
Parameters
$last_check_epoch : int

EPOCH

$clock_epoch : int = null

EPOCH

Return values
array<string|int, mixed>

convertTimeClockUserIDToUserID()

protected convertTimeClockUserIDToUserID(string|array<string|int, string> $timeclock_user_ids) : array<string|int, mixed>|bool|int
Parameters
$timeclock_user_ids : string|array<string|int, string>

UUID

Return values
array<string|int, mixed>|bool|int

convertUserIdToTimeClockUserID()

protected convertUserIdToTimeClockUserID(string $user_id) : bool|int
Parameters
$user_id : string

UUID

Return values
bool|int

getStatusAndType()

protected getStatusAndType(int $clock_status_id) : array<string|int, mixed>
Parameters
$clock_status_id : int
Return values
array<string|int, mixed>

getUserIdToTimeClockUserIdMapInitializationDate()

protected getUserIdToTimeClockUserIdMapInitializationDate() : bool|int
Return values
bool|int

setTimeClockUserIdForUser()

protected setTimeClockUserIdForUser(string $user_id) : bool
Parameters
$user_id : string

UUID

Return values
bool

Search results