Alert Template Object

Alert Template Object Formats

JSON Format

{
	"Accept": {
		"DisplayNotes": false,
		"RequireResponseNotes": false
	},
	"Decline": {
		"DisplayNotes": false,
		"RequireResponseNotes": false
	},
	"Deleted": false,
	"Message": "",
	"TemplateID": "",
	"RefID": "",
	"URL": ""
}

Alert Template Object Properties

Required properties are in bold.

Property Type Description

Accept

object

This properly contains various criteria definition for accepting alert/notification.

Property Type Description

DisplayNotes

boolean

Identifies if the mobile application should display notes field

Default value is false

RequireResponseNotes

boolean

Identifies if the response notes are required from mobile worker on accepting alert/notification

Default value is false

Decline

object

This property contains various criteria definition for declining alert/notification. If this object is not specified, then the decline button will not be displayed.

Property Type Description

DisplayNotes

boolean

Identifies if the mobile application should display notes field

Default value is false

RequireResponseNotes

boolean

Identifies if the response notes are required from mobile worker on declining alert/notification

Default value is false

Deleted

boolean

Identifies if the alert template is to be deleted.

Valid values are:

true - The alert template object should be deleted
false - The alert template object should not be deleted. This is the default value if this property is not specified.

Message

string

This property contains information text to be displayed in alert/notification.

TemplateID

string

This property uniquely identifies the alert template.

RefID

string

This property contains optional customer assigned reference identifier. This allows the customer to tie the response back to another system

URL

string

This property contains URL to an external web site.