REST Object Definitions User Related Objects UserStatus Object

UserStatus Object Formats

JSON Format

{
	"Breaks": [{
		"StartBreakUTC": "",
		"EndBreakUTC": ""
	}],
	"CheckIn": {
		"FlexAttrs": {}
	},
	"CheckOut": {
		"FlexAttrs": {}
	},
	"CheckInUTC": "",
	"CheckOutUTC": "",
	"UserName": ""
	"UserStatus": ""
}

UserStatus Object Properties

Required properties are in bold.

Property

Type

Description

Breaks

collection

A collection of start and end times for breaks taken during the user's workday

Break Properties

Property	Type	Description
StartBreakUTC	string	Identifies the start date and time of the break
EndBreakUTC	string	Identifies the end date and time of the break

CheckIn

object

This property is used to store the FlexForms values in for the Check-in process

CheckOut

object

This property is used to store the FlexForms values in for the Check-out process

CheckInUTC

datetime

Identifies the date and time the user checked in.

CheckOutUTC

datetime

Identifies the date and time the user checked out.

UserName

string

Identifies the currently logged in user.

UserStatus

string

Contains a UserStatus System Category value identifying the user's status.

Valid values are:

1001 - Checked In
1002 - On Break
1003 - Checked Out