14.1 Jeopardy States

On This Page:

JeopStates

Related Pages:

The Jeopardy Report SOAP API contains ‘JeopStates’ fields, which allow specific jeopardy states to be passed in (to limit which states to report on) and which are passed back (to report on what states are the causes of a jeopardy condition).

For calling the API, if a particular jeopardy state is required it should be supplied, with a boolean value of true. If the option is not required it should be omitted from the call.

For API responses, the jeopardy state will either:

be present with a boolean value of true if it is a reason for the jeopardy condition; or
be present as part of a bitwise OR operation result.

For the latter case case, the hexidecimal value of each jeopardy state is included in the table to below, to allow the jeopardy state(s) for a given work item to be calculated.

JeopStates
Option Name	Type	Jeopardy State Type	Hexadecimal Value	Definition
`ADJUnsuitableShift`	`boolean`	1	`0x8000000`
`beforeContract`	`boolean`	1	`0x10000`	ETA before contract earliest.
`depMissedTime`	`boolean`	2	`0x40`	Dependency breaking time constraints of dependency.
`depNotDiffOper`	`boolean`	2	`0x20`	Dependent job not on different operative where dependency requires it.
`depNotSameOper`	`boolean`	2	`0x10`	Dependent job not on same operative where dependency requires it.
`depUnscheduled`	`boolean`	2	`0x08`	Dependent Job Unscheduled.
`dispFailBatch`	`boolean`	1	`0x4000000`	The batch dispatch of the job was rejected by the host system.
`dispFailEarmark`	`boolean`	1	`0x800000`	The dispatch for the earmark was rejected by the host system.
`dispFailReearmark`	`boolean`	1	`0x2000000`	The dispatch for the reearmark was rejected by the host system.
`dispFailUnearmark`	`boolean`	1	`0x1000000`	The dispatch for the unearmark was rejected by the host system.
`lateContact`	`boolean`	1	`0x01`	The operative has not accepted the job.
`lateEarmark`	`boolean`	1	`0x10`	The job is late being earmarked.
`lateLogoff`	`boolean`	1	`0x04`	The job is not Logged Off.
`lateLogon`	`boolean`	1	`0x02`	The job is not in LoggedOn/On Site status.
`lateTravel`	`boolean`	1	`0x20`	The job is not in travelling/EnRoute status.
`missedAppt`	`boolean`	1	`0x4000`	Appointment: ETA outside windows. If `missedApptEarly` or `missedApptLate` is set, then this is set.
`missedApptEarly`	`boolean`	1	`0x40000`	ETA before promise.
`missedApptLate`	`boolean`	1	`0x80000`	ETA after promise.
`noGo`	`boolean`	1	`0x20000000`	The job is in a No Go postal code.
`outsideAccHours`	`boolean`	2	`0x01`	Outside access hours.
`outsideServHours`	`boolean`	2	`0x04`	Outside service hours.
`ovlBreak`	`boolean`	2	`0x80`	Job overlaps a break. NOT USED.
`ovlJob`	`boolean`	1	`0x08`	The job is overlapped by another job.
`ovlOT`	`boolean`	1	`0x100`	The job exceeds the operative’s maximum overtime (UOT).
`ovlShift`	`boolean`	1	`0x80`	The job is (partially) outside the operative’s normal shift (AOT).
`ovlStdAct`	`boolean`	1	`0x200`	The job overlaps a standard activity.
`pastContract`	`boolean`	1	`0x20000`	ETA after contract latest.
`promise`	`boolean`	1	`0x800`	Broken customer promise. If any of `missedApptEarly,` `missedApptLate`, `pastContract`, `beforeContract`, `outsideAccHours` or `outsideServHours` are set, then this is set.
`spareNotInVan`	`boolean`	2	`0x100`	Not all required spares can be sourced from van stocks
`unscheduled`	`boolean`	1	`0x2000`	The job is unscheduled.