Time Entry Object

Represents a single time entry object. Internally, ServiceMobility does not support a single time entry object that spans more than a single day. If the recorded end time is a different day than the start time, then ServiceMobility will automatically split the record into multiple records - one for each day the time spans. When the system splits a record it sets the SplitGuid property to the ID of the first time entry record in the split.

On this page:

Related

Time Entry Object Formats

JSON Format

{
    "EndGPSLatitude": "",
    "EndGPSLongitude": "",
    "FlexAttrs": {
        "${FlexFormID}" : {
            "${FlexAttrID}" : [
                "",
                ""
            ]
        }
    },
    "ID": "",
    "ModifiedUTC": "",
    "RefCode": "",
    "SplitGuid": "",
    "StartGPSLatitude": "",
    "StartGPSLongitude": "",
	"Status" : "",
    "SysActCode" : "",
    "SysActRefCode" : "",
    "SysCatActivityID": "",
    "SysCatCode" : "",
    "SysCatID": "",
    "SystemEndUTC": "",
    "SystemGenerated": false,
    "SystemStartUTC": "",
	"TimeCardID" : "",
    "UserEndUTC": "",
    "UserStartUTC": ""
}

Time Entry Object Properties

Required properties are in bold.

Property Value Description

EndGPSLatitude string If GPS is available, and the option to collect GPS information has been enabled, this property will contain the latitude coordinate of the technician at the time the end time was recorded. Otherwise, this property will be set to 0.0.

EndGPSLongitude string If GPS is available, and the option to collect GPS information has been enabled, this property will contain the longitude coordinate of the technician at the time the end time was recorded. Otherwise, this property will be set to 0.0.

FlexAttrs

object

This property contains the FlexAttr values that were entered.

FlexAttrs are always associated with a FlexForm
FlexAttrs values can be pre-populated from the backend

Property

Type

Description

${FlexFormID}

object

Identifies the FlexForm

Property	Type	Description
${FlexAttrID}	array	Contains an collection of values entered for the FlexAttr field identified by ${FlexAttrID}.

ID string Globally unique identifier of the time entry record. This ID is automatically created and populated by the ServiceMobility application.

ModifiedUTC datetime The date and time, in UTC format, when the object was last modified.

RefCode

string

The meaning of this, optional, property changes based on the value of the SysCatCode property.

SysCatCode	RefCode Description
9	Work order number

SplitGUID string If set, this property refers to the ID of first time entry record in the overall split.

StartGPSLatitude string If GPS is avaialble, this property will contain the latitude coordinate at the time the start time was recorded. Otherwise, if GPS was not available then this property will be set to 0.0.

StartGPSLongitude string If GPS is avaialble, this property will contain the longitude coordinate at the time the start was recorded. Otherwise, if GPS was not available then this property will be set to 0.0.

Status string

SysActCode string Identifies the activity code associated with the time entry object. This activity code is a child of the SysCatCode property.

SysActRefCode string This property has been deprecated.

SysCatActivityID string This property has been deprecated. Please use the SysActCode property instead.

SysCatCode string Identifies the time entry child system category code associated with the time entry object.

SysCatID string This property has been deprecated. Please use the SysCatCode property instead.

SystemEndUTC datetime The ending date and time, in UTC format, as recorded by the system. This value can not be changed by the technician.

SystemGenerated

boolean

Identifies is the time entry object was automatically created by the mobile application.

Valid values are:

false - The object was not auto generated. This is the default value if this property is missing.
true - The object was auto generated by the mobile application.

SystemStartUTC datetime The starting date and time, in UTC format, as recorded by the system. This value is set at the point when the object was first created. This value can not be changed by the technician.

UserEndUTC datetime The ending date and time, in UTC format, as recorded by the mobile worker. This value may be different from the SystemEndUTC property if the application configuration allows the mobile worker to edit time entry values.

UserStartUTC datetime The starting date and time, in UTC format, as recorded by the mobile worker. This value may be different from the SystemStartUTC property if the application configuration allows the mobile worker to edit time entry values.