REST Objects Flags

5.0.0

The Flags object can be part of:

The Appointment Book object, in the following location:
- Appointment Book > Flags
In this situation, a Flags object represents the state of various boolean flag values to be associated with a Work Item when performing an appointment booking.

or:

The Work Item object, in the following locations:
- Work Item > Flags
In this situation, a Flags object represents the state of various boolean flag values that are associated with a booked Work

On this page:

Related pages:

Flags Object Format

JSON Format

{
	"AllowRebook": false,
    "AllowReject": false,
	"Billable": false,
    "CallConfirmed": false,
	"ClerkReview": false,
    "Deleted": false,
    "Fixed": false,
	"HardStop": false,
    "IsDelivered": false,
    "IsRead": false,
    "IsRedacted": false,
    "Paused": false,
    "RepeatCall": false,
    "IsAllDayJob": false,
	"ForcedCall": false
}

Flags Object Properties

Property	Type	Required?	Description	Field Mappings
Property	Type	Required?	Description	ServiceDispatch	ServiceMobility	ServiceScheduling
`AllowRebook`	`boolean`	No	Is it permitted to allow the Work Item to be rebooked?	`ReSchedule`	`/CanResched`	`allowRebook`
`AllowReject`	`boolean`	No	Is it permitted for the Worker to reject the Work Item?		`/CanReject`
`Billable`	`boolean`	No	Is the Work Item billable to the customer?		`/Billable`
`CallConfirmed`	`boolean`	No	Has the customer call confirmed the Work Item?
`ClerkReview`	`boolean`	No	Does the Work Item require a review by a member of the back office team on completion?		`/ClerkReview`
`Deleted`	`boolean`	No	Has the Work Item been removed from a mobile worker's device?		`/Deleted`
`Fixed`	`boolean`	No	Is the Work Item to be completed at a fixed time (i.e. cannot be moved to optimize the schedule)?			`fixedStatus`
`HardStop`	`boolean`	No	Does the Worker need to stop working at the Work Item's specified end time, even if the work is incomplete?		`/HardStop`
`IsDelivered`	`boolean`	No	Has the Work Item been delivered to the Worker?		`/IsDelivered`
`IsRead`	`boolean`	No	Has the Work Item been seen by the Worker?		`/IsRead`
`IsRedacted`	`boolean`	No	Should certain properties of the Work Item be hidden from view until the work is accepted by the Worker?		`/IsRedacted`
`Paused`	`boolean`	No	Is the Work Item paused?		`/Paused`
`RepeatCall`	`boolean`	No	Is the Work Item a second or subsequent visit for the same work?	`RepeatCallFlag`	`/RepeatCall`
`IsAllDayJob`	`boolean`	No	Is the Work Item an all day job?			`jobStatus == 8`
`ForcedCall`	`boolean`	No	Has the Work Item been forced into the schedule (possibly overriding other Work Items)?	`ForcedCallFlag`		`ForcedCall`