timelimit-server/docs/schema/serverdatastatus.md
2022-09-12 02:00:00 +02:00

119 KiB

ServerDataStatus Schema

https://timelimit.io/ServerDataStatus
Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated Yes Unknown status No Forbidden Forbidden none ServerDataStatus.schema.json

ServerDataStatus Type

object (ServerDataStatus)

ServerDataStatus Properties

Property Type Required Nullable Defined by
devices object Optional cannot be null ServerDataStatus
devices2 array Optional cannot be null ServerDataStatus
apps array Optional cannot be null ServerDataStatus
rmCategories array Optional cannot be null ServerDataStatus
categoryBase array Optional cannot be null ServerDataStatus
categoryApp array Optional cannot be null ServerDataStatus
usedTimes array Optional cannot be null ServerDataStatus
rules array Optional cannot be null ServerDataStatus
tasks array Optional cannot be null ServerDataStatus
users object Optional cannot be null ServerDataStatus
krq array Optional cannot be null ServerDataStatus
kr array Optional cannot be null ServerDataStatus
dh object Optional cannot be null ServerDataStatus
fullVersion number Required cannot be null ServerDataStatus
message string Optional cannot be null ServerDataStatus
apiLevel number Required cannot be null ServerDataStatus

devices

devices

devices Type

object (ServerDeviceList)

devices2

devices2

devices2 Type

object[] (ServerExtendedDeviceData)

apps

apps

apps Type

object[] (ServerInstalledAppsData)

rmCategories

rmCategories

rmCategories Type

string[]

categoryBase

categoryBase

categoryBase Type

object[] (ServerUpdatedCategoryBaseData)

categoryApp

categoryApp

categoryApp Type

object[] (ServerUpdatedCategoryAssignedApps)

usedTimes

usedTimes

usedTimes Type

object[] (ServerUpdatedCategoryUsedTimes)

rules

rules

rules Type

object[] (ServerUpdatedTimeLimitRules)

tasks

tasks

tasks Type

object[] (ServerUpdatedCategoryTasks)

users

users

users Type

object (ServerUserList)

krq

krq

krq Type

object[] (ServerKeyRequest)

kr

kr

kr Type

object[] (ServerKeyResponse)

dh

dh

dh Type

object (ServerDhKey)

fullVersion

fullVersion

fullVersion Type

number

message

message

message Type

string

apiLevel

apiLevel

apiLevel Type

number

ServerDataStatus Definitions

Definitions group ServerDeviceList

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerDeviceList"}
Property Type Required Nullable Defined by
version string Required cannot be null ServerDataStatus
data array Required cannot be null ServerDataStatus

version

version

version Type

string

data

data

data Type

object[] (ServerDeviceData)

Definitions group ServerDeviceData

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerDeviceData"}
Property Type Required Nullable Defined by
deviceId string Required cannot be null ServerDataStatus
name string Required cannot be null ServerDataStatus
model string Required cannot be null ServerDataStatus
addedAt number Required cannot be null ServerDataStatus
currentUserId string Required cannot be null ServerDataStatus
networkTime string Required cannot be null ServerDataStatus
cProtectionLevel string Required cannot be null ServerDataStatus
hProtectionLevel string Required cannot be null ServerDataStatus
cUsageStats string Required cannot be null ServerDataStatus
hUsageStats string Required cannot be null ServerDataStatus
cNotificationAccess string Required cannot be null ServerDataStatus
hNotificationAccess string Required cannot be null ServerDataStatus
cAppVersion number Required cannot be null ServerDataStatus
hAppVersion number Required cannot be null ServerDataStatus
tDisablingAdmin boolean Required cannot be null ServerDataStatus
reboot boolean Required cannot be null ServerDataStatus
hadManipulation boolean Required cannot be null ServerDataStatus
hadManipulationFlags number Required cannot be null ServerDataStatus
reportUninstall boolean Required cannot be null ServerDataStatus
isUserKeptSignedIn boolean Required cannot be null ServerDataStatus
showDeviceConnected boolean Required cannot be null ServerDataStatus
defUser string Required cannot be null ServerDataStatus
defUserTimeout number Required cannot be null ServerDataStatus
rebootIsManipulation boolean Required cannot be null ServerDataStatus
cOverlay string Required cannot be null ServerDataStatus
hOverlay string Required cannot be null ServerDataStatus
asEnabled boolean Required cannot be null ServerDataStatus
wasAsEnabled boolean Required cannot be null ServerDataStatus
activityLevelBlocking boolean Required cannot be null ServerDataStatus
qOrLater boolean Required cannot be null ServerDataStatus
mFlags number Required cannot be null ServerDataStatus
pk string Optional cannot be null ServerDataStatus

deviceId

deviceId

deviceId Type

string

name

name

name Type

string

model

model

model Type

string

addedAt

addedAt

addedAt Type

number

currentUserId

currentUserId

currentUserId Type

string

networkTime

networkTime

networkTime Type

string

networkTime Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"disabled"
"enabled"
"if possible"

cProtectionLevel

cProtectionLevel

cProtectionLevel Type

string (ProtectionLevel)

cProtectionLevel Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"device owner"
"none"
"password device admin"
"simple device admin"

hProtectionLevel

hProtectionLevel

hProtectionLevel Type

string (ProtectionLevel)

hProtectionLevel Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"device owner"
"none"
"password device admin"
"simple device admin"

cUsageStats

cUsageStats

cUsageStats Type

string (RuntimePermissionStatus)

cUsageStats Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"granted"
"not granted"
"not required"

hUsageStats

hUsageStats

hUsageStats Type

string (RuntimePermissionStatus)

hUsageStats Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"granted"
"not granted"
"not required"

cNotificationAccess

cNotificationAccess

cNotificationAccess Type

string (NewPermissionStatus)

cNotificationAccess Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"granted"
"not granted"
"not supported"

hNotificationAccess

hNotificationAccess

hNotificationAccess Type

string (NewPermissionStatus)

hNotificationAccess Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"granted"
"not granted"
"not supported"

cAppVersion

cAppVersion

cAppVersion Type

number

hAppVersion

hAppVersion

hAppVersion Type

number

tDisablingAdmin

tDisablingAdmin

tDisablingAdmin Type

boolean

reboot

reboot

reboot Type

boolean

hadManipulation

hadManipulation

hadManipulation Type

boolean

hadManipulationFlags

hadManipulationFlags

hadManipulationFlags Type

number

reportUninstall

reportUninstall

reportUninstall Type

boolean

isUserKeptSignedIn

isUserKeptSignedIn

isUserKeptSignedIn Type

boolean

showDeviceConnected

showDeviceConnected

showDeviceConnected Type

boolean

defUser

defUser

defUser Type

string

defUserTimeout

defUserTimeout

defUserTimeout Type

number

rebootIsManipulation

rebootIsManipulation

rebootIsManipulation Type

boolean

cOverlay

cOverlay

cOverlay Type

string (RuntimePermissionStatus)

cOverlay Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"granted"
"not granted"
"not required"

hOverlay

hOverlay

hOverlay Type

string (RuntimePermissionStatus)

hOverlay Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"granted"
"not granted"
"not required"

asEnabled

asEnabled

asEnabled Type

boolean

wasAsEnabled

wasAsEnabled

wasAsEnabled Type

boolean

activityLevelBlocking

activityLevelBlocking

activityLevelBlocking Type

boolean

qOrLater

qOrLater

qOrLater Type

boolean

mFlags

mFlags

mFlags Type

number

pk

pk

pk Type

string

Definitions group ProtectionLevel

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ProtectionLevel"}
Property Type Required Nullable Defined by

Definitions group RuntimePermissionStatus

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/RuntimePermissionStatus"}
Property Type Required Nullable Defined by

Definitions group NewPermissionStatus

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/NewPermissionStatus"}
Property Type Required Nullable Defined by

Definitions group ServerExtendedDeviceData

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerExtendedDeviceData"}
Property Type Required Nullable Defined by
deviceId string Required cannot be null ServerDataStatus
appsBase object Optional cannot be null ServerDataStatus
appsDiff object Optional cannot be null ServerDataStatus

deviceId

deviceId

deviceId Type

string

appsBase

appsBase

appsBase Type

object (ServerCryptContainer)

appsDiff

appsDiff

appsDiff Type

object (ServerCryptContainer)

Definitions group ServerCryptContainer

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerCryptContainer"}
Property Type Required Nullable Defined by
version string Required cannot be null ServerDataStatus
data string Required cannot be null ServerDataStatus

version

version

version Type

string

data

data

data Type

string

Definitions group ServerInstalledAppsData

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerInstalledAppsData"}
Property Type Required Nullable Defined by
deviceId string Required cannot be null ServerDataStatus
version string Required cannot be null ServerDataStatus
apps array Required cannot be null ServerDataStatus
activities array Required cannot be null ServerDataStatus

deviceId

deviceId

deviceId Type

string

version

version

version Type

string

apps

apps

apps Type

object[] (SerializedInstalledApp)

activities

activities

activities Type

object[] (SerializedAppActivityItem)

Definitions group SerializedInstalledApp

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/SerializedInstalledApp"}
Property Type Required Nullable Defined by
packageName string Required cannot be null ServerDataStatus
title string Required cannot be null ServerDataStatus
isLaunchable boolean Required cannot be null ServerDataStatus
recommendation string Required cannot be null ServerDataStatus

packageName

packageName

packageName Type

string

title

title

title Type

string

isLaunchable

isLaunchable

isLaunchable Type

boolean

recommendation

recommendation

recommendation Type

string (AppRecommendation)

recommendation Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"blacklist"
"none"
"whitelist"

Definitions group AppRecommendation

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/AppRecommendation"}
Property Type Required Nullable Defined by

Definitions group SerializedAppActivityItem

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/SerializedAppActivityItem"}
Property Type Required Nullable Defined by
p string Required cannot be null ServerDataStatus
c string Required cannot be null ServerDataStatus
t string Required cannot be null ServerDataStatus

p

p

p Type

string

c

c

c Type

string

t

t

t Type

string

Definitions group ServerUpdatedCategoryBaseData

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUpdatedCategoryBaseData"}
Property Type Required Nullable Defined by
categoryId string Required cannot be null ServerDataStatus
childId string Required cannot be null ServerDataStatus
title string Required cannot be null ServerDataStatus
blockedTimes string Required cannot be null ServerDataStatus
extraTime number Required cannot be null ServerDataStatus
extraTimeDay number Required cannot be null ServerDataStatus
tempBlocked boolean Required cannot be null ServerDataStatus
tempBlockTime number Required cannot be null ServerDataStatus
version string Required cannot be null ServerDataStatus
parentCategoryId string Required cannot be null ServerDataStatus
blockAllNotifications boolean Required cannot be null ServerDataStatus
timeWarnings number Required cannot be null ServerDataStatus
mblCharging number Required cannot be null ServerDataStatus
mblMobile number Required cannot be null ServerDataStatus
sort number Required cannot be null ServerDataStatus
networks array Required cannot be null ServerDataStatus
dlu number Required cannot be null ServerDataStatus
flags number Required cannot be null ServerDataStatus
blockNotificationDelay number Required cannot be null ServerDataStatus
atw array Required cannot be null ServerDataStatus

categoryId

categoryId

categoryId Type

string

childId

childId

childId Type

string

title

title

title Type

string

blockedTimes

blockedTimes

blockedTimes Type

string

extraTime

extraTime

extraTime Type

number

extraTimeDay

extraTimeDay

extraTimeDay Type

number

tempBlocked

tempBlocked

tempBlocked Type

boolean

tempBlockTime

tempBlockTime

tempBlockTime Type

number

version

version

version Type

string

parentCategoryId

parentCategoryId

parentCategoryId Type

string

blockAllNotifications

blockAllNotifications

blockAllNotifications Type

boolean

timeWarnings

timeWarnings

timeWarnings Type

number

mblCharging

mblCharging

mblCharging Type

number

mblMobile

mblMobile

mblMobile Type

number

sort

sort

sort Type

number

networks

networks

networks Type

object[] (ServerCategoryNetworkId)

dlu

dlu

dlu Type

number

flags

flags

flags Type

number

blockNotificationDelay

blockNotificationDelay

blockNotificationDelay Type

number

atw

atw

atw Type

number[]

Definitions group ServerCategoryNetworkId

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerCategoryNetworkId"}
Property Type Required Nullable Defined by
itemId string Required cannot be null ServerDataStatus
hashedNetworkId string Required cannot be null ServerDataStatus

itemId

itemId

itemId Type

string

hashedNetworkId

hashedNetworkId

hashedNetworkId Type

string

Definitions group ServerUpdatedCategoryAssignedApps

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUpdatedCategoryAssignedApps"}
Property Type Required Nullable Defined by
categoryId string Required cannot be null ServerDataStatus
apps array Required cannot be null ServerDataStatus
version string Required cannot be null ServerDataStatus

categoryId

categoryId

categoryId Type

string

apps

apps

apps Type

string[]

version

version

version Type

string

Definitions group ServerUpdatedCategoryUsedTimes

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUpdatedCategoryUsedTimes"}
Property Type Required Nullable Defined by
categoryId string Required cannot be null ServerDataStatus
times array Required cannot be null ServerDataStatus
sessionDurations array Required cannot be null ServerDataStatus
version string Required cannot be null ServerDataStatus

categoryId

categoryId

categoryId Type

string

times

times

times Type

object[] (ServerUsedTimeItem)

sessionDurations

sessionDurations

sessionDurations Type

object[] (ServerSessionDurationItem)

version

version

version Type

string

Definitions group ServerUsedTimeItem

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUsedTimeItem"}
Property Type Required Nullable Defined by
day number Required cannot be null ServerDataStatus
time number Required cannot be null ServerDataStatus
start number Required cannot be null ServerDataStatus
end number Required cannot be null ServerDataStatus

day

day

day Type

number

time

time

time Type

number

start

start

start Type

number

end

end

end Type

number

Definitions group ServerSessionDurationItem

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerSessionDurationItem"}
Property Type Required Nullable Defined by
md number Required cannot be null ServerDataStatus
spd number Required cannot be null ServerDataStatus
sm number Required cannot be null ServerDataStatus
em number Required cannot be null ServerDataStatus
l number Required cannot be null ServerDataStatus
d number Required cannot be null ServerDataStatus

md

the maximum duration of a session (maxSessionDuration)

md

md Type

number

spd

the pause duration after a session (sessionPauseDuration)

spd

spd Type

number

sm

the start minute of the day of the session/ the rule which created this session (startMinuteOfDay)

sm

sm Type

number

em

the end minute of the day of the session/ the rule which created this session (endMinuteOfDay)

em

em Type

number

l

the timestamp of the last usage of this session (lastUsage)

l

l Type

number

d

the duration of the last/ current session (lastSessionDuration)

d

d Type

number

Definitions group ServerUpdatedTimeLimitRules

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUpdatedTimeLimitRules"}
Property Type Required Nullable Defined by
categoryId string Required cannot be null ServerDataStatus
version string Required cannot be null ServerDataStatus
rules array Required cannot be null ServerDataStatus

categoryId

categoryId

categoryId Type

string

version

version

version Type

string

rules

rules

rules Type

object[] (ServerTimeLimitRule)

Definitions group ServerTimeLimitRule

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerTimeLimitRule"}
Property Type Required Nullable Defined by
id string Required cannot be null ServerDataStatus
extraTime boolean Required cannot be null ServerDataStatus
dayMask number Required cannot be null ServerDataStatus
maxTime number Required cannot be null ServerDataStatus
start number Required cannot be null ServerDataStatus
end number Required cannot be null ServerDataStatus
session number Required cannot be null ServerDataStatus
pause number Required cannot be null ServerDataStatus
perDay boolean Required cannot be null ServerDataStatus

id

id

id Type

string

extraTime

extraTime

extraTime Type

boolean

dayMask

dayMask

dayMask Type

number

maxTime

maxTime

maxTime Type

number

start

start

start Type

number

end

end

end Type

number

session

session

session Type

number

pause

pause

pause Type

number

perDay

perDay

perDay Type

boolean

Definitions group ServerUpdatedCategoryTasks

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUpdatedCategoryTasks"}
Property Type Required Nullable Defined by
categoryId string Required cannot be null ServerDataStatus
version string Required cannot be null ServerDataStatus
tasks array Required cannot be null ServerDataStatus

categoryId

categoryId

categoryId Type

string

version

version

version Type

string

tasks

tasks

tasks Type

object[] (ServerUpdatedCategoryTask)

Definitions group ServerUpdatedCategoryTask

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUpdatedCategoryTask"}
Property Type Required Nullable Defined by
i string Required cannot be null ServerDataStatus
t string Required cannot be null ServerDataStatus
d number Required cannot be null ServerDataStatus
p boolean Required cannot be null ServerDataStatus
l number Required cannot be null ServerDataStatus

i

i

i Type

string

t

t

t Type

string

d

d

d Type

number

p

p

p Type

boolean

l

l

l Type

number

Definitions group ServerUserList

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUserList"}
Property Type Required Nullable Defined by
version string Required cannot be null ServerDataStatus
data array Required cannot be null ServerDataStatus

version

version

version Type

string

data

data

data Type

object[] (ServerUserEntry)

Definitions group ServerUserEntry

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerUserEntry"}
Property Type Required Nullable Defined by
id string Required cannot be null ServerDataStatus
name string Required cannot be null ServerDataStatus
password string Required cannot be null ServerDataStatus
secondPasswordSalt string Required cannot be null ServerDataStatus
type string Required cannot be null ServerDataStatus
timeZone string Required cannot be null ServerDataStatus
disableLimitsUntil number Required cannot be null ServerDataStatus
mail string Required cannot be null ServerDataStatus
currentDevice string Required cannot be null ServerDataStatus
categoryForNotAssignedApps string Required cannot be null ServerDataStatus
relaxPrimaryDevice boolean Required cannot be null ServerDataStatus
mailNotificationFlags number Required cannot be null ServerDataStatus
blockedTimes string Required cannot be null ServerDataStatus
flags number Required cannot be null ServerDataStatus
llc string Optional cannot be null ServerDataStatus
pbd number Optional cannot be null ServerDataStatus

id

id

id Type

string

name

name

name Type

string

password

password

password Type

string

secondPasswordSalt

secondPasswordSalt

secondPasswordSalt Type

string

type

type

type Type

string

type Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"child"
"parent"

timeZone

timeZone

timeZone Type

string

disableLimitsUntil

disableLimitsUntil

disableLimitsUntil Type

number

mail

mail

mail Type

string

currentDevice

currentDevice

currentDevice Type

string

categoryForNotAssignedApps

categoryForNotAssignedApps

categoryForNotAssignedApps Type

string

relaxPrimaryDevice

relaxPrimaryDevice

relaxPrimaryDevice Type

boolean

mailNotificationFlags

mailNotificationFlags

mailNotificationFlags Type

number

blockedTimes

blockedTimes

blockedTimes Type

string

flags

flags

flags Type

number

llc

llc

llc Type

string

pbd

pbd

pbd Type

number

Definitions group ServerKeyRequest

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerKeyRequest"}
Property Type Required Nullable Defined by
srvSeq number Required cannot be null ServerDataStatus
senId string Required cannot be null ServerDataStatus
senSeq number Required cannot be null ServerDataStatus
deviceId string Optional cannot be null ServerDataStatus
categoryId string Optional cannot be null ServerDataStatus
type number Required cannot be null ServerDataStatus
tempKey string Required cannot be null ServerDataStatus
signature string Required cannot be null ServerDataStatus

srvSeq

srvSeq

srvSeq Type

number

senId

senId

senId Type

string

senSeq

senSeq

senSeq Type

number

deviceId

deviceId

deviceId Type

string

categoryId

categoryId

categoryId Type

string

type

type

type Type

number

tempKey

tempKey

tempKey Type

string

signature

signature

signature Type

string

Definitions group ServerKeyResponse

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerKeyResponse"}
Property Type Required Nullable Defined by
srvSeq number Required cannot be null ServerDataStatus
sender string Required cannot be null ServerDataStatus
rqSeq number Required cannot be null ServerDataStatus
tempKey string Required cannot be null ServerDataStatus
cryptKey string Required cannot be null ServerDataStatus
signature string Required cannot be null ServerDataStatus

srvSeq

srvSeq

srvSeq Type

number

sender

sender

sender Type

string

rqSeq

rqSeq

rqSeq Type

number

tempKey

tempKey

tempKey Type

string

cryptKey

cryptKey

cryptKey Type

string

signature

signature

signature Type

string

Definitions group ServerDhKey

Reference this group by using

{"$ref":"https://timelimit.io/ServerDataStatus#/definitions/ServerDhKey"}
Property Type Required Nullable Defined by
v string Required cannot be null ServerDataStatus
k string Required cannot be null ServerDataStatus

v

v

v Type

string

k

k

k Type

string