Hello!
struct
applicationname RangerGuard
datapath C:\Home\rangerguard.pro\wwwroot\_assets\data
xactions
component _scripts.actions
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELACTION
function delAction
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
aid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
DOLOG
function doLog
Arguments:
Name Required Type Default
api Optional Any  
mode Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: determins whether to log or not an Api
Description:  
EDITACTION
function editAction
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
aid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
FILTEROUT
function filterOut
Arguments:
Name Required Type Default
api Optional Any  
data Optional Any  
ReturnType: any
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: simplifies output for given apis
Description:  
GETACTIONS
function getActions
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
bType Optional Any  
isValid Optional Any 1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETERRORMESSAGE
function getErrorMessage
Arguments:
Name Required Type Default
error Optional Any  
ReturnType: string
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: retuns friendly error msg
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETOBJECTSWITHTAG
function getObjectsWithTag
Arguments:
Name Required Type Default
tagType Optional Any  
tagName Optional Any  
ReturnType: array
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: returns objects with specific nametag
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYRAW
function getSurveyRaw
Arguments:
Name Required Type Default
aid Optional Any  
ReturnType: struct
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTAGSFOROBJECT
function getTagsForObject
Arguments:
Name Required Type Default
tagTarget Optional Any  
tagType Optional Any  
ReturnType: array
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: returns associated tags to object
Description:  
GETTAGTENANT
function getTagTenant
Arguments:
Name Required Type Default
tagId Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: returns the tags tenant Id
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASCHECKEDIN
function hasCheckedIn
Arguments:
Name Required Type Default
uid Optional Any  
gid Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: checks _tracking
Description:  
HASCLOCKEDIN
function hasClockedIn
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: checks _tracking
Description:  
HASPERMIT
function hasPermit
Arguments:
Name Required Type Default
uid Optional Any  
api Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: checks uid has asset permit
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASVALIDSKILL
function hasValidSkill
Arguments:
Name Required Type Default
uId Optional Any  
skillType Optional Any  
authorityId Optional Any 0
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: checks if user has Required Skill
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
ISTAGFORTARGET
function isTagForTarget
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
tags Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: returns true/false if tag exists for target
Description:  
JSONBOOL
function jsonBool
Arguments:
Name Required Type Default
val Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: needed to force true/false vals
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWACTION
function newAction
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETTAGS
function resetTags
Arguments:
Name Required Type Default
tagNames Optional array  
tagType Optional Any  
tagTarget Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: deletes and creates tags, useful for data post/edit
Description:  
RESPOND
function respond
Arguments:
Name Required Type Default
api Optional Any [empty string]
error Optional Any 0
uId Optional Any 0
data Optional Any [runtime expression]
raw Optional Any [runtime expression]
debug Optional Any [empty string]
args Optional Any [runtime expression]
ReturnType: struct
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: centralize response management
Description:  
SAVEDEBUG
function saveDebug
Arguments:
Name Required Type Default
title Optional Any  
data Optional Any  
run Optional Any  
reset Optional Any  
ReturnType: void
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: saves data to debug table
Description:  
SAVELOG
function saveLog
Arguments:
Name Required Type Default
api Optional Any [empty string]
error Optional Any 0
uId Optional Any 0
raw Optional Any [runtime expression]
ReturnType: numeric
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint: save to DB Log given request
Description:  
SAVESURVEYRAW
function saveSurveyRaw
Arguments:
Name Required Type Default
aid Optional Any  
raw Optional Any  
ReturnType: boolean
Roles:  
Access: private
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xadmin
component _scripts.admin
        extends _scripts.common
METHODS
APPLIST
function appList
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DBLIST
function dbList
Arguments:
Name Required Type Default
source Optional Any sql
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
DBRESET
function dbReset
Arguments:
Name Required Type Default
tables Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETPROFILES
function getProfiles
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xagendas
component _scripts.agendas
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELAGENDA
function delAgenda
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
gid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITAGENDA
function editAgenda
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
gid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETAGENDAS
function getAgendas
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
zoneId Optional Any  
targetId Optional Any -1
aStatus Optional Any -1
isValid Optional Any -1
isMe Optional Any 1
days Optional Any 5
dtStart Optional Any [runtime expression]
isLone Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWAGENDA
function newAgenda
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xassets
component _scripts.assets
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELASSET
function delAsset
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
assetId Optional Any  
body Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITASSET
function editAsset
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
assetId Optional Any  
body Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETASSETS
function getAssets
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
taskId Optional Any  
iid Optional Any 0
isValid Optional Any -1
assetId Optional Any -1
aType Optional Any -1
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWASSET
function newAsset
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
taskId Optional Any  
body Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xbinds
component _scripts.binds
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELBIND
function delBind
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
bid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITBIND
function editBind
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
bid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBINDS
function getBinds
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
bType Optional Any  
isValid Optional Any 1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWBIND
function newBind
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xbulk
component _scripts.bulk
        extends _scripts.common
METHODS
_LOCATIONS
function _locations
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
_USERS
function _users
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
CLEANDATA
function cleanData
Arguments:
Name Required Type Default
action Optional Any none
table Optional Any  
data Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used to remove unecessary fields
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DOWNLOAD
function download
Arguments:
Name Required Type Default
tables Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SAVE
function save
Arguments:
Name Required Type Default
action Optional Any none
table Optional Any  
data Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: actually does the action
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
UPLOAD
function upload
Arguments:
Name Required Type Default
table Optional Any  
row Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: converts rowdata into a struct
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xcatalogs
component _scripts.catalogs
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELCATALOG
function delCatalog
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
cid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITCATALOG
function editCatalog
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
cid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETCATALOGS
function getCatalogs
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
cType Optional Any  
cName Optional Any -1
cValue Optional Any -1
isValid Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWCATALOG
function newCatalog
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
ctype Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xchecks
component _scripts.checks
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
EDITCHECK
function editCheck
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
checkId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETCHECKS
function getChecks
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
tenantId Optional Any  
isValid Optional Any 1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWCHECK
function newCheck
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xclients
component _scripts.clients
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELCLIENT
function delClient
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
clientId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITCLIENT
function editClient
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
clientId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETCLIENTS
function getClients
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
tenantId Optional Any  
isValid Optional Any -1
clientId Optional Any -1
tags Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWCLIENT
function newClient
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
tenantId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xconsole
component _scripts.console
METHODS
APPLIST
function appList
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns array with registered apps
Description:  
CHECKIN
function checkIn
Arguments:
Name Required Type Default
tid Optional Any  
pathId Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: executes a User Check-in
Description:  
DBLIST
function dbList
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: return db schema tables
Description:  
DBRESET
function dbReset
Arguments:
Name Required Type Default
tid Optional Any  
tables Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: resets a specific table (supports multiple ',')
Description:  
GETACTIONS
function getActions
Arguments:
Name Required Type Default
tid Optional Any  
isValid Optional Any 1
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: gets all Actions
Description:  
GETALLPATHS
function getAllPaths
Arguments:
Name Required Type Default
tid Optional Any  
siteId Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: gets all Paths
Description:  
GETBINDS
function getBinds
Arguments:
Name Required Type Default
tid Optional Any  
bType Optional Any *
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: gets all Actions
Description:  
GETCLIENTS
function getClients
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns all users
Description:  
GETDEFAULT
function getDefault
Arguments:
Name Required Type Default
appId Optional Any 0
siteId Optional Any 0
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: helper function for switching, gets first data of... else 0
Description:  
GETLOCATIONS
function getLocations
Arguments:
Name Required Type Default
tid Optional Any  
siteId Optional Any  
locId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns available locations for appID
Description:  
GETPATH
function getPath
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: gets all Paths
Description:  
GETPATHS
function getPaths
Arguments:
Name Required Type Default
tid Optional Any  
siteId Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: gets all Paths
Description:  
GETPLANS
function getPlans
Arguments:
Name Required Type Default
tid Optional Any  
siteId Optional Any  
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: gets all Plans
Description:  
GETPROFILES
function getProfiles
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns available profiles and permits
Description:  
GETSITES
function getSites
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns available sites for appID
Description:  
GETTASKS
function getTasks
Arguments:
Name Required Type Default
tId Optional Any  
pathId Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: gets all Tasks for User
Description:  
GETUSER
function getUser
Arguments:
Name Required Type Default
tid Optional Any  
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns all users
Description:  
GETUSERS
function getUsers
Arguments:
Name Required Type Default
tid Optional Any  
appId Optional Any *
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns all users
Description:  
HS_GETSUMMARY
function HS_getSummary
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HS_IMPORTCONTACTS
function HS_importContacts
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HS_METACONTACTS
function HS_metaContacts
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
LOGIN
function login
Arguments:
Name Required Type Default
email Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns tid required for apis
Description:  
MEGET
function meGet
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: return db schema tables
Description:  
NEWPLAN
function newPlan
Arguments:
Name Required Type Default
tid Optional Any  
locId Optional Any  
uid Optional Any 0
firstRun Optional Any [runtime expression]
repeatEvery Optional Any D
repeatUntil Optional Any 2100-01-01 00:00
ignoreDays Optional Any [empty string]
isValid Optional Any 1
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: inserts a new Plan
Description:  
NEWUSER
function newUser
Arguments:
Name Required Type Default
tid Optional Any  
appId Optional Any  
firstName Optional Any  
email Optional Any  
pass Optional Any  
profile Optional Any  
lastName Optional Any [empty string]
extId Optional Any [empty string]
isValid Optional Any 1
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: creates a new User
Description:  
POSTACTION
function postAction
Arguments:
Name Required Type Default
tid Optional Any  
type Optional Any  
name Optional Any  
description Optional Any [empty string]
source Optional Any [empty string]
isValid Optional Any 1
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: creates an Action
Description:  
POSTBIND
function postBind
Arguments:
Name Required Type Default
tid Optional Any  
aId Optional Any  
pId Optional Any  
pathId Optional Any  
order Optional Any 1
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: post a Bind
Description:  
POSTLOCATION
function postLocation
Arguments:
Name Required Type Default
tid Optional Any  
siteId Optional Any  
clientId Optional Any  
mapsPlaceId Optional Any  
locName Optional Any  
locAddress Optional Any  
latitude Optional Any  
longitude Optional Any  
locPhoto Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: creates a New location
Description:  
PUTTASK
function putTask
Arguments:
Name Required Type Default
tId Optional Any  
pathId Optional Any  
aId Optional Any  
tValue Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates the result for a task
Description:  
TT_GETCLIENTS
function TT_getClients
Arguments:
Name Required Type Default
tid Optional Any  
staffrGuid Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns all hires
Description:  
TT_GETHIRES
function TT_getHires
Arguments:
Name Required Type Default
tid Optional Any  
staffrId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns all hires
Description:  
TT_GETSUMMARY
function TT_getSummary
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
TT_IMPORTCSV
function TT_importCSV
Arguments:
Name Required Type Default
tid Optional Any  
type Optional Any  
csv Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
UPDATEUSER
function updateUser
Arguments:
Name Required Type Default
tid Optional Any  
uid Optional Any  
body Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates an existing User
Description:  
xemployees
component _scripts.employees
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETEMPLOYEE
function getEmployee
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
targetId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
PUTEMPLOYEE
function putEmployee
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
targetId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xhooks
component _scripts.hooks
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SAVESURVEYRESPONSE
function saveSurveyResponse
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
taskId Optional Any  
gid Optional Any  
data Optional Any  
allow Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xincidents
component _scripts.incidents
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELINCIDENT
function delIncident
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
iid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITINCIDENT
function editIncident
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
iid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETINCIDENTS
function getIncidents
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
zoneId Optional Any  
iid Optional Any -1
isValid Optional Any -1
archived Optional Any 0
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWINCIDENT
function newIncident
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
zoneId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xme
component _scripts.me
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETME
function getMe
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
my Optional Any [empty string]
allow Optional Any false
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: get self summary data
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xpermits
component _scripts.permits
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELPERMIT
function delPermit
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
api Optional Any  
profileId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETPERMITS
function getPermits
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
profileId Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWPERMIT
function newPermit
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
profileId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xplans
component _scripts.plans
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELPLAN
function delplan
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
sid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: moves from shift to plans for user assignment (deletes previous first)
Description:  
EDITPLAN
function editplan
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
sid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: moves from shift to plans for user assignment (deletes previous first)
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETPLANS
function getplans
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
templateId Optional Any  
isValid Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWPLAN
function newplan
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
templateId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: moves from shift to plans for user assignment (deletes previous first)
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xpositions
component _scripts.positions
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELPOSITION
function delPosition
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITPOSITION
function editPosition
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
pid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETPOSITIONS
function getPositions
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
zoneId Optional Any  
isValid Optional Any -1
isLone Optional Any -1
pid Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWPOSITION
function newPosition
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xprofiles
component _scripts.profiles
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELPROFILE
function delProfile
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
profileId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITPROFILE
function editProfile
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
profileId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETPROFILES
function getProfiles
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
isValid Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWPROFILE
function newProfile
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xreports
component _scripts.reports
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETREPORTS
function getReports
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
reportName Optional Any  
filters Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
MFAILEDCHECKINS
function mFailedCheckins
Arguments:
Name Required Type Default
appid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
MTABLECOUNT
function mTableCount
Arguments:
Name Required Type Default
appId Optional Any  
table Optional Any  
filter Optional Any [empty string]
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xshifts
component _scripts.shifts
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELSHIFT
function delshift
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
sid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITSHIFT
function editshift
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
sid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSHIFTS
function getshifts
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
templateId Optional Any  
isValid Optional Any -1
defaultUid Optional Any -1
pid Optional Any -1
zoneId Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWSHIFT
function newshift
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
templateId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xsites
component _scripts.sites
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELSITE
function delSite
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
siteId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITSITE
function editSite
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
siteId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSITES
function getSites
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
isValid Optional Any -1
clientId Optional Any -1
zoneid Optional Any -1
siteId Optional Any -1
tags Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWSITE
function newSite
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xskills
component _scripts.skills
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELSKILL
function delSkill
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
skillId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITSKILL
function editSkill
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
skillId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSKILLS
function getSkills
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
targetId Optional Any -1
isValid Optional Any -1
skillType Optional Any -1
authorityId Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWSKILL
function newSkill
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xtags
component _scripts.tags
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELTAG
function delTag
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
tagId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTAGS
function getTags
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
tenantId Optional Any -1
tagType Optional Any -1
tagTarget Optional Any -1
tagName Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWTAG
function newTag
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xtasks
component _scripts.tasks
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELTASK
function delTask
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
taskId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITTASK
function editTask
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
taskId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETTASKS
function getTasks
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
gId Optional Any  
isDone Optional Any -1
isValid Optional Any -1
isMe Optional Any 0
getRaw Optional Any 0
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWTASK
function newTask
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
gId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xtemplates
component _scripts.templates
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELTEMPLATE
function delTemplate
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
templateId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITTEMPLATE
function editTemplate
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
templateId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETTEMPLATES
function getTemplates
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
zoneId Optional Any  
isValid Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWTEMPLATE
function newTemplate
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
tenantId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xtenants
component _scripts.tenants
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELTENANT
function delTenant
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
tenantId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITTENANT
function editTenant
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
tenantId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETTENANTS
function getTenants
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
isValid Optional Any -1
tenantId Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWTENANT
function newTenant
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xtests
component _scripts.tests
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHREQUESTTEST
function authRequestTest
Arguments:
Name Required Type Default
data Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDECRYPTTEST
function encryptdecryptTest
Arguments:
Name Required Type Default
data Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETERRORMESSAGETEST
function getErrorMessageTest
Arguments:
Name Required Type Default
data Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xtokens
component _scripts.tokens
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DOLOGIN
function doLogin
Arguments:
Name Required Type Default
appid Optional Any  
body Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xtools
component _scripts.tools
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETALLDISTANCES
function getAllDistances
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETALLPERMITS
function getAllPermits
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
zoneId Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETALLTAGS
function getAllTags
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
tagType Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: return array of existing tags
Description:  
GETALLTEMPLATES
function getAllTemplates
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
zoneId Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: return array of existing templates
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETCLOSESTSITES
function getClosestSites
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
latitude Optional Any 0
longitude Optional Any 0
radius Optional Any 50
unit Optional Any K
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns closes sites direct from SQL
Description:  
GETELIGIBLEUSERS
function getEligibleUsers
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
pid Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYDATA
function getSurveyData
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
taskId Optional Any  
gid Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns survey information
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCHECKEDIN
function isCheckedIn
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
gid Optional Any 0
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SEARCHTOPS
function searchTops
Arguments:
Name Required Type Default
appId Optional Any  
id Optional Any  
type Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: https://tops.portal.texas.gov/psp-self-service/search/result/ID?type=TYPE
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SETAGENDA
function setAgenda
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: uses the info from plans and copies to agenda, first resets it. does tasks too
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
TRACKUSERS
function trackUsers
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: post location to use as checkin/clockin
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xusers
component _scripts.users
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELUSER
function delUser
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
targetId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITUSER
function editUser
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
targetId Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETUSERS
function getUsers
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
tenantId Optional Any -1
zoneId Optional Any -1
targetId Optional Any -1
isValid Optional Any -1
tags Optional Any -1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWUSER
function newUser
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
SYNCCRMUSERTAGS
function syncCRMUserTags
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
USERENABLE
function userEnable
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
targetId Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xvars
struct
bulk
struct
_locations
struct
fields appId,locId,clientId,locName,latitude,longitude,locAddress,locPhoto,siteId,tenantId,tags
pk locId
_users
struct
fields appId,uid,firstName,lastName,email,extId,pass,isValid,avatarUrl,mobile,title,siteId,tenantId,profileId,latitude,longitude,tags
pk uId
config
struct
admins
array[empty]
checkinKm 1
checkinMins 20
debugLog YES
tokenMinutes 480
verifySkillYr 1
console
struct
admin
array
1 181.214.139.130
endpoint https://rangerguard.pro/rest/one
env pro
restPath C:\Home\rangerGuard.pro\wwwroot\_apis
errors
struct
e0 OK
e1 Catch Exception
e10 Invalid User Credentials
e11 Missing FirstName
e12 Missing Role
e13 Duplicate User
e14 Invalid Email
e15 Invalid Role
e16 Not Implemented
e17 Table is Locked
e18 Invalid Uid for AppId
e19 Invalid LocId for AppId
e2 Invalid App Credentials
e20 Duplicate Hubspot Id
e21 Missing Latitude and Longitude for User
e22 Missing deviceID or FCM for User
e23 Missing LocId
e24 Missing UID
e25 Duplicate Plan
e26 Expired or Invalid OTP
e27 Need to update user position
e28 Closed Check-in
e29 invalid Check-in uID/Loc
e3 Disabled App
e30 Excess Distance uId/Loc
e31 Needs to Check-in
e32 Invalid Uid/TaskId
e33 Invalid Asset ID
e34 Invalid Binding
e35 Duplicate Binding or Path
e36 Invalid or Inactive Resource
e37 Invalid Geo-fence
e38 Invalid Tenant
e39 Incomplete Body
e4 Missing tId
e40 Duplicate Record
e41 Invalid ApiPermit
e42 Invalid Profile
e43 Invalid TagType
e44 Invalid Target for Tag
e45 Invalid Tag Id
e46 Invalid SkillType or Authority
e47 Invalid SkillId
e48 invalid VerifyDate
e49 Invalid Site
e5 Not Logged In
e50 Does not have required skill
e51 Cannot delete, binded records
e52 Missing Users for Shifts
e53 Missing TemplateId
e54 Has not clocked-in
e55 Has not checked-in
e56 No Data
e57 Locked. Survey is closed
e58 Invalid Table
e59 Duplicate vehicle assignment
e6 Disabled User
e60 Needs GHLCID key
e7 No Permit
e8 Missing Email
e9 Missing Pass
log
array
1
struct
api common.authRequest
log
struct
catch YES
success NO
validate YES
2
struct
api common.authUser
log
struct
catch YES
success NO
validate YES
3
struct
api tools.getAllTags
log
struct
catch YES
success YES
validate YES
4
struct
api tools.getAllTemplates
log
struct
catch YES
success YES
validate YES
5
struct
api tools.getAllPermits
log
struct
catch YES
success YES
validate YES
6
struct
api tools.getAllDistances
log
struct
catch YES
success YES
validate YES
7
struct
api tools.trackUsers
log
struct
catch YES
success YES
validate YES
8
struct
api tools.getEligibleUsers
log
struct
catch YES
success YES
validate YES
9
struct
api tools.getAgendaTasks
log
struct
catch YES
success YES
validate YES
10
struct
api tools.setAgenda
log
struct
catch YES
success YES
validate YES
11
struct
api tokens.doLogin
log
struct
catch YES
success NO
validate YES
12
struct
api me.getMe
log
struct
catch YES
success YES
validate YES
13
struct
api users.getUsers
log
struct
catch YES
success YES
validate YES
14
struct
api users.newUser
log
struct
catch YES
success YES
validate YES
15
struct
api users.editUser
log
struct
catch YES
success YES
validate YES
16
struct
api users.delUser
log
struct
catch YES
success YES
validate YES
17
struct
api zones.getZones
log
struct
catch YES
success YES
validate YES
18
struct
api zones.newZone
log
struct
catch YES
success YES
validate YES
19
struct
api zones.editZone
log
struct
catch YES
success YES
validate YES
20
struct
api zones.delZone
log
struct
catch YES
success YES
validate YES
21
struct
api sites.getSites
log
struct
catch YES
success YES
validate YES
22
struct
api sites.newSite
log
struct
catch YES
success YES
validate YES
23
struct
api sites.editSite
log
struct
catch YES
success YES
validate YES
24
struct
api sites.delSite
log
struct
catch YES
success YES
validate YES
25
struct
api clients.getClients
log
struct
catch YES
success YES
validate YES
26
struct
api clients.newClient
log
struct
catch YES
success YES
validate YES
27
struct
api clients.editClient
log
struct
catch YES
success YES
validate YES
28
struct
api clients.delClient
log
struct
catch YES
success YES
validate YES
29
struct
api tenants.getTenants
log
struct
catch YES
success YES
validate YES
30
struct
api tenants.newTenant
log
struct
catch YES
success YES
validate YES
31
struct
api tenants.editTenant
log
struct
catch YES
success YES
validate YES
32
struct
api tenants.delTenant
log
struct
catch YES
success YES
validate YES
33
struct
api tags.getTags
log
struct
catch YES
success YES
validate YES
34
struct
api tags.tagNew
log
struct
catch YES
success YES
validate YES
35
struct
api tags.delTag
log
struct
catch YES
success YES
validate YES
36
struct
api catalogs.getCatalogs
log
struct
catch YES
success YES
validate YES
37
struct
api catalogs.newCatalog
log
struct
catch YES
success YES
validate YES
38
struct
api catalogs.editCatalog
log
struct
catch YES
success YES
validate YES
39
struct
api catalogs.delCatalog
log
struct
catch YES
success YES
validate YES
40
struct
api skills.getSkills
log
struct
catch YES
success YES
validate YES
41
struct
api skills.newSkill
log
struct
catch YES
success YES
validate YES
42
struct
api skills.editSkill
log
struct
catch YES
success YES
validate YES
43
struct
api skills.delSkill
log
struct
catch YES
success YES
validate YES
44
struct
api assets.getAssets
log
struct
catch YES
success YES
validate YES
45
struct
api assets.newAsset
log
struct
catch YES
success YES
validate YES
46
struct
api assets.editAsset
log
struct
catch YES
success YES
validate YES
47
struct
api assets.delAsset
log
struct
catch YES
success YES
validate YES
48
struct
api profiles.getProfiles
log
struct
catch YES
success YES
validate YES
49
struct
api profiles.newProfile
log
struct
catch YES
success YES
validate YES
50
struct
api profiles.editProfile
log
struct
catch YES
success YES
validate YES
51
struct
api profiles.delProfile
log
struct
catch YES
success YES
validate YES
52
struct
api permits.newPermit
log
struct
catch YES
success YES
validate YES
53
struct
api permits.delPermit
log
struct
catch YES
success YES
validate YES
54
struct
api agendas.getAgendas
log
struct
catch YES
success YES
validate YES
55
struct
api agendas.newAgenda
log
struct
catch YES
success YES
validate YES
56
struct
api agendas.editAgenda
log
struct
catch YES
success YES
validate YES
57
struct
api agendas.delAgenda
log
struct
catch YES
success YES
validate YES
58
struct
api positions.getPositions
log
struct
catch YES
success YES
validate YES
59
struct
api positions.newPosition
log
struct
catch YES
success YES
validate YES
60
struct
api positions.editPosition
log
struct
catch YES
success YES
validate YES
61
struct
api positions.delPosition
log
struct
catch YES
success YES
validate YES
62
struct
api shifts.getshifts
log
struct
catch YES
success YES
validate YES
63
struct
api shifts.newshift
log
struct
catch YES
success YES
validate YES
64
struct
api shifts.editshift
log
struct
catch YES
success YES
validate YES
65
struct
api shifts.delshift
log
struct
catch YES
success YES
validate YES
66
struct
api plans.getplans
log
struct
catch YES
success YES
validate YES
67
struct
api plans.newplan
log
struct
catch YES
success YES
validate YES
68
struct
api plans.editplan
log
struct
catch YES
success YES
validate YES
69
struct
api plans.delplan
log
struct
catch YES
success YES
validate YES
70
struct
api templates.getTemplates
log
struct
catch YES
success YES
validate YES
71
struct
api templates.newTemplate
log
struct
catch YES
success YES
validate YES
72
struct
api templates.editTemplate
log
struct
catch YES
success YES
validate YES
73
struct
api templates.delTemplate
log
struct
catch YES
success YES
validate YES
74
struct
api binds.getBinds
log
struct
catch YES
success YES
validate YES
75
struct
api binds.newBind
log
struct
catch YES
success YES
validate YES
76
struct
api binds.delBind
log
struct
catch YES
success YES
validate YES
77
struct
api actions.getActions
log
struct
catch YES
success YES
validate YES
78
struct
api actions.newAction
log
struct
catch YES
success YES
validate YES
79
struct
api actions.editAction
log
struct
catch YES
success YES
validate YES
80
struct
api actions.delAction
log
struct
catch YES
success YES
validate YES
81
struct
api tasks.getTasks
log
struct
catch YES
success YES
validate YES
82
struct
api tasks.newTask
log
struct
catch YES
success YES
validate YES
83
struct
api tasks.editTask
log
struct
catch YES
success YES
validate YES
84
struct
api tasks.delTask
log
struct
catch YES
success YES
validate YES
85
struct
api incidents.getIncidents
log
struct
catch YES
success YES
validate YES
86
struct
api incidents.newIncident
log
struct
catch YES
success YES
validate YES
87
struct
api incidents.editIncident
log
struct
catch YES
success YES
validate YES
88
struct
api incidents.delIncident
log
struct
catch YES
success YES
validate YES
89
struct
api reports.getReports
log
struct
catch YES
success YES
validate YES
permits
array
1
struct
api me.getMe
req YES
2
struct
api tools.getAllPermits
req YES
3
struct
api tools.getAllTemplates
req NO
4
struct
api tools.getAllTags
req NO
5
struct
api tools.isCheckedIn
req YES
6
struct
api tools.getAllDistances
req YES
7
struct
api tools.getClosestSites
req YES
8
struct
api tools.getEligibleUsers
req YES
9
struct
api tools.setAgenda
req NO
10
struct
api tools.getSurveyData
req NO
11
struct
api tools.trackUsers
req YES
12
struct
api users.getUsers
req YES
13
struct
api users.newUser
req NO
14
struct
api users.editUser
req NO
15
struct
api users.delUser
req NO
16
struct
api zones.getZones
req YES
17
struct
api zones.newZone
req NO
18
struct
api zones.editZone
req NO
19
struct
api zones.delZone
req NO
20
struct
api sites.getSites
req YES
21
struct
api sites.newSite
req NO
22
struct
api sites.editSite
req NO
23
struct
api sites.delSite
req YES
24
struct
api clients.getClients
req YES
25
struct
api clients.newClient
req NO
26
struct
api clients.editClient
req NO
27
struct
api clients.delClient
req NO
28
struct
api tenants.getTenants
req YES
29
struct
api tenants.newTenant
req NO
30
struct
api tenants.editTenant
req NO
31
struct
api tenants.delTenant
req NO
32
struct
api tags.getTags
req YES
33
struct
api tags.newTag
req NO
34
struct
api catalogs.getCatalogs
req YES
35
struct
api catalogs.newCatalog
req NO
36
struct
api catalogs.editCatalog
req NO
37
struct
api catalogs.delCatalog
req NO
38
struct
api skills.getSkills
req YES
39
struct
api skills.newSkill
req NO
40
struct
api skills.editSkill
req NO
41
struct
api skills.delSkill
req NO
42
struct
api assets.getAssets
req YES
43
struct
api assets.newAsset
req NO
44
struct
api assets.editAsset
req NO
45
struct
api assets.delAsset
req NO
46
struct
api profiles.getProfiles
req YES
47
struct
api profiles.newProfile
req NO
48
struct
api profiles.editProfile
req NO
49
struct
api profiles.delProfile
req NO
50
struct
api permits.getPermits
req YES
51
struct
api permits.newPermit
req NO
52
struct
api permits.delPermit
req NO
53
struct
api agendas.getAgendas
req NO
54
struct
api agendas.newAgenda
req NO
55
struct
api agendas.editAgenda
req NO
56
struct
api agendas.delAgenda
req NO
57
struct
api positions.getPositions
req NO
58
struct
api positions.newPosition
req NO
59
struct
api positions.editPosition
req NO
60
struct
api positions.delPosition
req NO
61
struct
api shifts.getshifts
req NO
62
struct
api shifts.newshift
req NO
63
struct
api shifts.editshift
req NO
64
struct
api shifts.delshift
req NO
65
struct
api plans.getplans
req NO
66
struct
api plans.newplan
req NO
67
struct
api plans.editplan
req NO
68
struct
api plans.delplan
req NO
69
struct
api templates.getTemplates
req NO
70
struct
api templates.newTemplate
req NO
71
struct
api templates.editTemplate
req NO
72
struct
api templates.delTemplate
req NO
73
struct
api binds.getBinds
req YES
74
struct
api binds.newBind
req NO
75
struct
api binds.editBind
req NO
76
struct
api binds.delBind
req NO
77
struct
api actions.getActions
req YES
78
struct
api actions.newAction
req NO
79
struct
api actions.editAction
req NO
80
struct
api actions.delAction
req NO
81
struct
api tasks.getTasks
req NO
82
struct
api tasks.newTask
req NO
83
struct
api tasks.editTask
req NO
84
struct
api tasks.delTask
req NO
85
struct
api incidents.getIncidents
req NO
86
struct
api incidents.newIncident
req NO
87
struct
api incidents.editIncident
req NO
88
struct
api incidents.delIncident
req NO
89
struct
api employees.getEmployee
req NO
90
struct
api employees.putEmployee
req NO
91
struct
api vehicles.getVehicles
req NO
92
struct
api vehicles.newVehicle
req NO
93
struct
api vehicles.editVehicle
req NO
94
struct
api vehicles.delVehicle
req NO
95
struct
api checks.getChecks
req NO
96
struct
api checks.newCheck
req NO
97
struct
api checks.editCheck
req NO
98
struct
api reports.getReports
req NO
reports
struct
rawTable
struct
skipFields
array
1 _apps.keys
2 _apps.appToken
3 _users.pass
tables
array
1
struct
lock NO
name _actions
2
struct
lock NO
name _agendas
3
struct
lock NO
name _answers
4
struct
lock NO
name _apps
5
struct
lock NO
name _assets
6
struct
lock NO
name _binds
7
struct
lock NO
name _catalogs
8
struct
lock NO
name _clients
9
struct
lock NO
name _debug
10
struct
lock NO
name _incidents
11
struct
lock NO
name _logs
12
struct
lock NO
name _permits
13
struct
lock NO
name _plans
14
struct
lock NO
name _positions
15
struct
lock NO
name _profiles
16
struct
lock NO
name _shifts
17
struct
lock NO
name _sites
18
struct
lock NO
name _skills
19
struct
lock NO
name _surveys
20
struct
lock NO
name _tags
21
struct
lock NO
name _tasks
22
struct
lock NO
name _templates
23
struct
lock NO
name _tenants
24
struct
lock NO
name _tokens
25
struct
lock NO
name _trackings
26
struct
lock NO
name _users
27
struct
lock NO
name _zones
xvehicles
component _scripts.vehicles
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELVEHICLE
function delVehicle
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
vid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITVEHICLE
function editVehicle
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
vid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETVEHICLES
function getVehicles
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
tenantId Optional Any  
isValid Optional Any 1
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWVEHICLE
function newVehicle
Arguments:
Name Required Type Default
appId Optional Any  
uid Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
xzones
component _scripts.zones
        extends _scripts.common
METHODS
AUTHREQUEST
function authRequest
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages appId header auth
Description:  
AUTHUSER
function authUser
Arguments:
Name Required Type Default
appid Optional Any  
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: manages user token validation
Description:  
CALCULATEDISTANCE
function calculateDistance
Arguments:
Name Required Type Default
lat1 Required numeric  
lon1 Required numeric  
lat2 Required numeric  
lon2 Required numeric  
mode Optional string K
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: calculates distance between 2 points
Description:  
DECRYPTDATA
function decryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
DELZONE
function delZone
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
zoneId Optional Any  
allow Optional Any false
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
EDITZONE
function editZone
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
zoneId Optional Any  
allow Optional Any false
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ENCRYPTDATA
function encryptData
Arguments:
Name Required Type Default
string Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: used for header, login & keys
Description:  
GETBODY
function getBody
Arguments:
Name Required Type Default
requestData Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: parses body from request (keep public)
Description:  
GETGEOFENCE
function getGeoFence
Arguments:
Name Required Type Default
zoneId Optional Any  
ReturnType: array
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETLASTPOSITION
function getLastPosition
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETSURVEYANSWERS
function getSurveyAnswers
Arguments:
Name Required Type Default
taskId Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETTARGETNAME
function getTargetName
Arguments:
Name Required Type Default
tagType Optional Any  
tagTarget Optional Any  
ReturnType: string
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: translates targetID to fieldName
Description:  
GETUIDFROMTID
function getUidFromtid
Arguments:
Name Required Type Default
tid Optional Any  
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
GETZONES
function getZones
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
tenantId Optional Any -1
isValid Optional Any -1
zoneId Optional Any -1
allow Optional Any false
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
HASTASKSDONE
function hasTasksDone
Arguments:
Name Required Type Default
gid Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
INIT
function init
Arguments:none
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
ISCOORDINFENCE
function isCoordInFence
Arguments:
Name Required Type Default
point Optional Any  
polygon Optional Any  
ReturnType: boolean
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns true/false if point is inside polygon
Description:  
LOGRATE
function logRate
Arguments:
Name Required Type Default
clientId Optional Any 0
uid Optional Any 0
mapField Optional Any billRatePHr
newValue Optional Any 0
pId Optional Any 0
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: updates _rates table with current, triggered on every client/employee update
Description:  
NEEDSVEHICLEREPORT
function needsVehicleReport
Arguments:
Name Required Type Default
uid Optional Any  
ReturnType: numeric
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: returns trid if missing vehicle report
Description:  
NEWZONE
function newZone
Arguments:
Name Required Type Default
appId Optional Any  
uId Optional Any  
body Optional Any  
allow Optional Any false
ReturnType: struct
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
RESETPASSWORD
function resetPassword
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
pass Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SENDMAILOTP
function sendMailOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description:  
SQLCLOSESTSITES
function sqlClosestSites
Arguments:
Name Required Type Default
latitude Optional Any  
longitude Optional Any  
radius Optional Any 50
unit Optional Any K
siteIds Optional Any -1
ReturnType: any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint: queries DB for closest sites using haversine
Description:  
VALIDATEOTP
function validateOTP
Arguments:
Name Required Type Default
appId Optional Any  
email Optional Any  
otp Optional Any  
ReturnType: Any
Roles:  
Access: public
Static: false
Output:  
DisplayName:  
Hint:  
Description: