Hello JC!

struct

applicationname

RangerGuard

datapath

C:\Sites\rangerguard.one\wwwroot\_assets\data

xadmin

[cfc1] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

Description:

BUILDGEOFENCE

function buildGEOFence

Arguments:

Name	Required	Type	Default
jArray	Optional	array

ReturnType:

string

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

returns a string ready for geometry insert

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
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:

GETDATAFROMTABLE

function getDataFromTable

Arguments:

Name	Required	Type	Default
table	Optional	Any
pk	Optional	Any
id	Optional	Any
fields	Optional	Any

ReturnType:

Any

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

helper for quick single queries

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:

GETLASTTRACKING

function getLastTracking

Arguments:

Name	Required	Type	Default
uid	Optional	Any

ReturnType:

struct

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

Description:

GETLIAISON

function getLiaison

Arguments:

Name	Required	Type	Default
uid	Optional	Any

ReturnType:

struct

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

Description:

GETPROFILES

function getProfiles

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

GETUSERASSIGNEDTASKS

function getUserAssignedTasks

Arguments:

Name	Required	Type	Default
uid	Optional	Any

ReturnType:

Any

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

task.bind.site.plan

Description:

GETUSERPOSITIONTASKS

function getUserPositionTasks

Arguments:

Name	Required	Type	Default
uid	Optional	Any

ReturnType:

Any

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

task.bind.site.plan

Description:

GETUSERSITETASKS

function getUserSiteTasks

Arguments:

Name	Required	Type	Default
uid	Optional	Any
filterDistance	Optional	Any	false
filterSkills	Optional	Any	false

ReturnType:

Any

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

task.bind.site.plan

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

ISCLOCKEDIN

function isClockedIn

Arguments:

Name	Required	Type	Default
uid	Optional	Any

ReturnType:

boolean

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

Description:

ISSTILLELIGIBLETASK

function isStillEligibleTask

Arguments:

Name	Required	Type	Default
uid	Optional	Any
taskId	Optional	Any

ReturnType:

boolean

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

checks if task has already been done or not

Description:

ISUSERCLOSETOSITE

function isUserCloseToSite

Arguments:

Name	Required	Type	Default
uid	Optional	Any
siteId	Optional	Any

ReturnType:

boolean

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

used to determine to show site tasks or not

Description:

ISVALIDCLIENTID

function isValidClientId

Arguments:

Name	Required	Type	Default
clientId	Optional	Any

ReturnType:

boolean

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

Description:

ISVALIDTARGETID

function isValidTargetId

Arguments:

Name	Required	Type	Default
targetId	Optional	Any

ReturnType:

boolean

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

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:

PARSEGEOFENCE

function parseGEOFence

Arguments:

Name	Required	Type	Default
gArray	Optional	string

ReturnType:

array

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

reads from DB and converts to JSON

Description:

PARSEGEOPOINT

function parseGEOPoint

Arguments:

Name	Required	Type	Default
gPoint	Optional	string

ReturnType:

struct

Roles:

Access:

private

Static:

false

Output:

DisplayName:

Hint:

reads from DB and converts to JSON

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]
customText	Optional	Any	[empty string]

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	true
reset	Optional	Any	false

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xapps

[cfc2] component _scripts.apps
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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

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:

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

PUT

function put

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xbinds

[cfc3] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
bindId	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

del bind

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

gets default values

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:

GETSOURCE

function getSource

Arguments:

Name	Required	Type	Default
bindType	Optional	Any
bindSource	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

left

Description:

GETTARGET

function getTarget

Arguments:

Name	Required	Type	Default
bindType	Optional	Any
bindTarget	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

right

Description:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

post new bind

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xclients

[cfc4] component _scripts.clients
extends _scripts.common

METHODS

ADDCLIENTNOTES

function addClientNotes

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
clientId	Optional	Any
notes	Optional	array

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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
clientId	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

update existing client

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
isActive	Optional	Any	-1
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

gets default values

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:

GETNOTESFORCLIENT

function getNotesForClient

Arguments:

Name	Required	Type	Default
client	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:

POST

function post

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:

post new client

Description:

PUT

function put

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
body	Optional	Any
clientId	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

update existing client

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xdefaults

[cfc5] component _scripts.defaults
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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
did	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

delete default values

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
targetId	Optional	Any
dType	Optional	Any	appNav
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

gets default values

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
body	Optional	Any
targetId	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

add a default value

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xgroups

[cfc6] component _scripts.groups
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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
groupId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

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:

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

PUT

function put

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
body	Optional	Any
groupId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xlobbies

[cfc7] component _scripts.lobbies
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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
lid	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

delete a lobby rule

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
targetId	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

get all lobbies for a given user

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
body	Optional	Any
targetId	Optional	Any
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

add a lobby rule

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xme

[cfc8] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

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:

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xnotes

[cfc9] component _scripts.notes
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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
nid	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
table	Optional	Any	-1
by	Optional	Any	-1
for	Optional	Any	-1
type	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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

PUT

function put

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
nId	Optional	Any
body	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xplans

[cfc10] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
planId	Optional	Any
body	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
isDraft	Optional	Any	true
zoneId	Optional	Any	-1
tenantId	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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

ISBANNED

function isBanned

Arguments:

Name	Required	Type	Default
targetId	Optional	Any
planId	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

POST

function post

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:

PUT

function put

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xpositions

[cfc11] component _scripts.positions
extends _scripts.common

METHODS

ADDPOSITIONNOTES

function addPositionNotes

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
posId	Optional	Any
notes	Optional	array

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

ADDPOSITIONSKILLS

function addPositionSkills

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
posId	Optional	Any
skills	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

ADDPOSITIONTASKS

function addPositionTasks

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
posId	Optional	Any
tasks	Optional	Any

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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
posId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
clientId	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:

GETNOTESFORPOS

function getNotesForPos

Arguments:

Name	Required	Type	Default
posId	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

GETSITESWITHPOS

function getSitesWithPos

Arguments:

Name	Required	Type	Default
posId	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

GETSKILLSFORPOS

function getSkillsForPos

Arguments:

Name	Required	Type	Default
posId	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

GETTASKSFORPOS

function getTasksForPos

Arguments:

Name	Required	Type	Default
posId	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:

POST

function post

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
clientId	Optional	Any
body	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

PUT

function put

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
posId	Optional	Any
body	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xshifts

[cfc12] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

Description:

CANDELETESHIFT

function canDeleteShift

Arguments:

Name	Required	Type	Default
shiftId	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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
shiftId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

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:

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

ISVALIDPOS

function isValidPos

Arguments:

Name	Required	Type	Default
posId	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

ISVALIDSITE

function isValidSite

Arguments:

Name	Required	Type	Default
siteId	Optional	Any

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

POST

function post

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:

PUT

function put

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
body	Optional	Any
shiftId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xsites

[cfc13] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
clientId	Optional	Any	-1
subId	Optional	Any	-1
zoneId	Optional	Any	-1
tenantId	Optional	Any	-1
groupId	Optional	Any	-1
isActive	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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uid	Optional	Any
body	Optional	Any
subId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

PUT

function put

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xskills

[cfc14] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xsubs

[cfc15] component _scripts.subs
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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
subId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

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:

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
body	Optional	Any
zoneId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

PUT

function put

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
body	Optional	Any
subId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xtasks

[cfc16] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
posId	Optional	Any	-1
taskId	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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

PUT

function put

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xtenants

[cfc17] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
groupId	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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
body	Optional	Any
groupId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

PUT

function put

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xtokens

[cfc18] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xtools

[cfc19] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GETAGENDA

function getAgenda

Arguments:

Name	Required	Type	Default
uid	Optional	Any
dtPlan	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:

GETORG

function getOrg

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

GETTASKS

function getTasks

Arguments:

Name	Required	Type	Default
uid	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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xtrackings

[cfc20] component _scripts.trackings
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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
targetId	Optional	Any	-1
event	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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xusers

[cfc21] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

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:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

Arguments:

Name	Required	Type	Default
uid	Optional	Any
appId	Optional	Any
targetId	Optional	Any	-1
tags	Optional	Any	-1
isActive	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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

PUT

function put

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:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description:

xvars

struct

config

struct

debugLog

YES

metersToSite

5000

superAdmins

array
1	1
2	2

tokenMinutes

480

console

struct

admin

array
1	181.214.139.130

appToken

test

auth

MTp0ZXN0

endpoint

https://rangerguard.one/rest/one

env

dev

restPath

C:\Sites\rangerGuard.one\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
e61	Not Authorized
e62	Invalid AccessTable
e63	Invalid isValid
e64	Invalid KeyID
e65	Invalid Lid
e66	Invalid User
e67	Cannot target oneself
e68	Invalid dType
e69	dValue needs appId and zoneId
e7	No Permit
e70	Nothing to do
e71	User cannot modify target user
e72	Cannot delete, must first delete dependencies
e73	Cannot create, invalid parent
e74	Cannot create, invalid client
e75	cannot clock-out without clocking-in
e76	cannot check-out without checking-in
e77	invalid task type
e78	Cannot create, invalid site
e79	cannot break-end without break-start
e8	Missing Email
e80	invalid date
e81	User is banned to Position and cannot be assigned
e82	Invalid position, must be static or patrol
e9	Missing Pass

log

array

1

struct

api

APPS.del

log

struct
catch	true
success	true
validate	true

2

struct

api

APPS.get

log

struct
catch	true
success	true
validate	true

3

struct

api

APPS.post

log

struct
catch	true
success	true
validate	true

4

struct

api

APPS.put

log

struct
catch	true
success	true
validate	true

5

struct

api

BINDS.del

log

struct
catch	true
success	true
validate	true

6

struct

api

BINDS.get

log

struct
catch	true
success	true
validate	true

7

struct

api

BINDS.post

log

struct
catch	true
success	true
validate	true

8

struct

api

CLIENTS.del

log

struct
catch	true
success	true
validate	true

9

struct

api

CLIENTS.get

log

struct
catch	true
success	true
validate	true

10

struct

api

CLIENTS.post

log

struct
catch	true
success	true
validate	true

11

struct

api

CLIENTS.put

log

struct
catch	true
success	true
validate	true

12

struct

api

DEFAULTS.del

log

struct
catch	true
success	true
validate	true

13

struct

api

DEFAULTS.get

log

struct
catch	true
success	true
validate	true

14

struct

api

DEFAULTS.post

log

struct
catch	true
success	true
validate	true

15

struct

api

GROUPS.del

log

struct
catch	true
success	true
validate	true

16

struct

api

GROUPS.get

log

struct
catch	true
success	true
validate	true

17

struct

api

GROUPS.post

log

struct
catch	true
success	true
validate	true

18

struct

api

GROUPS.put

log

struct
catch	true
success	true
validate	true

19

struct

api

LOBBIES.del

log

struct
catch	true
success	true
validate	true

20

struct

api

LOBBIES.get

log

struct
catch	true
success	true
validate	true

21

struct

api

LOBBIES.post

log

struct
catch	true
success	true
validate	true

22

struct

api

ME.get

log

struct
catch	true
success	true
validate	true

23

struct

api

NOTES.del

log

struct
catch	true
success	true
validate	true

24

struct

api

NOTES.get

log

struct
catch	true
success	true
validate	true

25

struct

api

NOTES.post

log

struct
catch	true
success	true
validate	true

26

struct

api

NOTES.put

log

struct
catch	true
success	true
validate	true

27

struct

api

PLANS.del

log

struct
catch	true
success	true
validate	true

28

struct

api

PLANS.get

log

struct
catch	true
success	true
validate	true

29

struct

api

PLANS.post

log

struct
catch	true
success	true
validate	true

30

struct

api

PLANS.put

log

struct
catch	true
success	true
validate	true

31

struct

api

POSITIONS.del

log

struct
catch	true
success	true
validate	true

32

struct

api

POSITIONS.get

log

struct
catch	true
success	true
validate	true

33

struct

api

POSITIONS.post

log

struct
catch	true
success	true
validate	true

34

struct

api

POSITIONS.put

log

struct
catch	true
success	true
validate	true

35

struct

api

SHIFTS.del

log

struct
catch	true
success	true
validate	true

36

struct

api

SHIFTS.get

log

struct
catch	true
success	true
validate	true

37

struct

api

SHIFTS.post

log

struct
catch	true
success	true
validate	true

38

struct

api

SHIFTS.put

log

struct
catch	true
success	true
validate	true

39

struct

api

SITES.del

log

struct
catch	true
success	true
validate	true

40

struct

api

SITES.get

log

struct
catch	true
success	true
validate	true

41

struct

api

SITES.post

log

struct
catch	true
success	true
validate	true

42

struct

api

SITES.put

log

struct
catch	true
success	true
validate	true

43

struct

api

SKILLS.del

log

struct
catch	true
success	true
validate	true

44

struct

api

SKILLS.get

log

struct
catch	true
success	true
validate	true

45

struct

api

SKILLS.post

log

struct
catch	true
success	true
validate	true

46

struct

api

SKILLS.put

log

struct
catch	true
success	true
validate	true

47

struct

api

SUBS.del

log

struct
catch	true
success	true
validate	true

48

struct

api

SUBS.get

log

struct
catch	true
success	true
validate	true

49

struct

api

SUBS.post

log

struct
catch	true
success	true
validate	true

50

struct

api

SUBS.put

log

struct
catch	true
success	true
validate	true

51

struct

api

TASKS.del

log

struct
catch	true
success	true
validate	true

52

struct

api

TASKS.get

log

struct
catch	true
success	true
validate	true

53

struct

api

TASKS.post

log

struct
catch	true
success	true
validate	true

54

struct

api

TASKS.put

log

struct
catch	true
success	true
validate	true

55

struct

api

TENANTS.del

log

struct
catch	true
success	true
validate	true

56

struct

api

TENANTS.get

log

struct
catch	true
success	true
validate	true

57

struct

api

TENANTS.post

log

struct
catch	true
success	true
validate	true

58

struct

api

TENANTS.put

log

struct
catch	true
success	true
validate	true

59

struct

api

TRACKINGS.get

log

struct
catch	true
success	true
validate	true

60

struct

api

TRACKINGS.post

log

struct
catch	true
success	true
validate	true

61

struct

api

USERS.del

log

struct
catch	true
success	true
validate	true

62

struct

api

USERS.get

log

struct
catch	true
success	true
validate	true

63

struct

api

USERS.post

log

struct
catch	true
success	true
validate	true

64

struct

api

USERS.put

log

struct
catch	true
success	true
validate	true

65

struct

api

ZONES.del

log

struct
catch	true
success	true
validate	true

66

struct

api

ZONES.get

log

struct
catch	true
success	true
validate	true

67

struct

api

ZONES.post

log

struct
catch	true
success	true
validate	true

68

struct

api

ZONES.put

log

struct
catch	true
success	true
validate	true

permits

array

1

struct
api	apps.del

2

struct
api	apps.get

3

struct
api	apps.post

4

struct
api	apps.put

5

struct
api	binds.del

6

struct
api	binds.get

7

struct
api	binds.post

8

struct
api	clients.del

9

struct
api	clients.get

10

struct
api	clients.post

11

struct
api	clients.put

12

struct
api	defaults.del

13

struct
api	defaults.get

14

struct
api	defaults.post

15

struct
api	groups.del

16

struct
api	groups.get

17

struct
api	groups.post

18

struct
api	groups.put

19

struct
api	lobbies.del

20

struct
api	lobbies.get

21

struct
api	lobbies.post

22

struct
api	me.get

23

struct
api	notes.del

24

struct
api	notes.get

25

struct
api	notes.post

26

struct
api	notes.put

27

struct
api	plans.del

28

struct
api	plans.get

29

struct
api	plans.post

30

struct
api	plans.put

31

struct
api	positions.del

32

struct
api	positions.get

33

struct
api	positions.post

34

struct
api	positions.put

35

struct
api	shifts.del

36

struct
api	shifts.get

37

struct
api	shifts.post

38

struct
api	shifts.put

39

struct
api	sites.del

40

struct
api	sites.get

41

struct
api	sites.post

42

struct
api	sites.put

43

struct
api	skills.del

44

struct
api	skills.get

45

struct
api	skills.post

46

struct
api	skills.put

47

struct
api	subs.del

48

struct
api	subs.get

49

struct
api	subs.post

50

struct
api	subs.put

51

struct
api	tasks.del

52

struct
api	tasks.get

53

struct
api	tasks.post

54

struct
api	tasks.put

55

struct
api	tenants.del

56

struct
api	tenants.get

57

struct
api	tenants.post

58

struct
api	tenants.put

59

struct
api	trackings.get

60

struct
api	trackings.post

61

struct
api	users.del

62

struct
api	users.get

63

struct
api	users.post

64

struct
api	users.put

65

struct
api	zones.del

66

struct
api	zones.get

67

struct
api	zones.post

68

struct
api	zones.put

xzones

[cfc22] 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
allow	Optional	Any	false

ReturnType:

struct

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

manages user token validation

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:

DEL

function del

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
zoneId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

DOESHAVEACCESS

function doesHaveAccess

Arguments:

Name	Required	Type	Default
uid	Optional	Any
accessTable	Optional	Any
accessKeyId	Optional	Any

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

checks lobby

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:

FROMUTC

function fromUTC

Arguments:

Name	Required	Type	Default
utcDate	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date from UTC/GMT to server Local

Description:

GEOMETRY

function geometry

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:	TEMP disabled, just reference
Description:

GET

function get

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:

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:

INIT

function init

Arguments:	none
ReturnType:	Any
Roles:
Access:	public
Static:	false
Output:
DisplayName:
Hint:
Description:

POST

function post

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:

PUT

function put

Arguments:

Name	Required	Type	Default
appId	Optional	Any
uId	Optional	Any
body	Optional	Any
zoneId	Optional	Any
allow	Optional	Any	false

ReturnType:

Any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

Description:

TOUTC

function toUTC

Arguments:

Name	Required	Type	Default
dt	Required	date

ReturnType:

any

Roles:

Access:

public

Static:

false

Output:

DisplayName:

Hint:

converts date to UTC/GMT from server local

Description: