Activity Object

An activity is a scheduled event that may or may not be associated with an actual address. Activities appear within the mobile application's schedule views along side scheduled work orders.

Any time the mobile user performs an action that causes the activity object to change, it will automatically be uploaded to the server. For example, when the activity is started, the activity object will be uploaded to the server with the updated Started field populated.

Related pages:

Activity Object Formats

JSON Format

{
	"ActivityID": "",
	"ActualEndDate": "",
	"ActualStartDate": "",
	"ActualTravelEndDate": "",
	"ActualTravelStartDate": "",
	"Description": "",
	"Extensions": {
		"key1": "value1",
		"key2": "value2"
	},
	"FlexForms": [
		"${FlexFormID}"
	],
	"FlexView": [{
		"Title": "GroupName",
		"Items": [{
			"Label": "labeltext",
			"Value": "valuetext"
		}]
	}],
	"Location": {
		"LocationNum": "",
		"Name": "",
		"Address": {
			"AddrLine1": "",
			"AddrLine2": "",
			"AddrLine3": "",
			"AddrLine4": "",
			"AddrType": "",
			"City": "",
			"Country": "",
			"Intersection": "",
			"Lat": 0,
			"Lon": 0,
			"Region": "",
			"Zip": ""
		}
	},
	"ModifiedUTC": "",
	"Notes": [{
		"ID": "",
		"Author": "",
		"Date": "",
		"Text": ""
	}],
	"Paused": false,
	"PlannedEndDate": "",
	"PlannedStartDate": "",
	"Priority": "",
	"Status": "",
	"Title": "",
	"Type": "",
	"UserAdjustedEndUTC": "",
	"UserAdjustedStartUTC": "",
	"UserAdjustedTravelEndUTC": "",
	"UserAdjustedTravelStartUTC": "",
	"UserName": ""
}

Activity Object Properties

Required properties are in bold.

Property Type Description

ActivityID string The unique identifier for the activity. This value must be globally unique across all activities.

ActualEndDate datetime Identifies the actual date and time the activity was completed.

ActualStartDate datetime Identifies the actual date and time the activity was started on site at the account location. This value does not include the start travel time.

ActualTravelEndDate datetime Identifies the actual end travel date and time for the activity.

ActualTravelStartDate datetime Identifies the actual start travel date and time.

Description string A simple description of the activity.

Extensions

object

This object contains an optional collection of key/value pairs.

These key/value are defined and controlled by the customer and are typically used to assist in integration by pass additional data around the system.

FlexAttrs

object

This property contains the Flex-Field values that were entered.

Flex-Fields are always associated with a Flex-Form

Flex-Field values can be pre-populated from the backend

Property Type Description

${FlexFormID}

object

Identifies the Flex-Form

Property	Type	Description
Value	boolean	Identifies the value associated with the rule
CanOverride	boolean	Identifies if the provided value can be edited by the mobile worker. Default value is `false`

FlexForms

collection

An optional collection of FlexForm IDs. Each form specified in the collection will be available for the identified task.

See: FlexForm Object

FlexView

collection

The optional FlexViews object is used to provided additional read-only details and information specific to the object they are included in. The FlexViews are fully customizable by the customer.

See: Flex Views Object

Location

object

The account location identifies the actual location (address) of where the activity is to be completed.

See: Account Location Object

Notes

collection

The Notes object contains an optional collection of notes associated with the activity. These can be recorded by anyone involved with scheduling the activity.

Paused

boolean

Identifies if the activity is currently paused.

Valid values are:

true = The activity is currently paused.
false = The activity is not paused.

PlannedEndTime datetime The date and time, in UTC format, when the activity is scheduled to end.

PlannedStartTime datetime The date and time, in UTC format, when the activity is scheduled to start.

Priority

string

Identifies the current priority of the activity. Contains an Activity Priorities System Category value identifying the priority of activity.

Status

string

Identifies the current status of the activity. Contains an Activity Status System Category value for status of the activity

Title string A short title for the activity.

Type string Identifies the type of activity. Activity types are defined and controlled with a Activity Types System Category.

UserAdjustedEndUTC

datetime

The ending date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualEndDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity date and time

4.16.0

UserAdjustedStartUTC

datetime

The starting date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualStartDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity date and time.

4.16.0

UserAdjustedTravelEndUTC

datetime

The ending travel date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualTravelEndDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity travel date and time

4.16.0

UserAdjustedTravelStartUTC

datetime

The starting travel date and time, in UTC format, as recorded by the mobile worker. This value may be different from the ActualTravelEndDate property if the application configuration (Activity.editStartEndTimeEnabled = true) allows the mobile worker to edit activity travel date and time

4.16.0

UserName string This property identifies the ID of the mobile worker that has been assigned to the activity.