<sp:JeopReportRequest>
| | | | |
| <FRUs>?</FRUs>
| RUID
| is a A list of Final Responsibility Units (FRUs) for which jobs work items in jeopardy are to be reported to the connected client. FRUs FRUs are separated by the ‘;’ character If teams (below) is empty and FRUs is empty then all FRUs (and teams) are reported. Either FRUs or teams can be specified, but not both. | 
| 
|
| <teams>?</teams>
| | is a A list of teams for which jobs work items in jeopardy are to be reported to the connected client. Teams Teams are separated by the ‘;’ character. If FRUs (above) is empty and Teams teams is empty then all FRUs teams (and teamsFRUs) are reported. Either teams or FRUs or Teams can be specified, but not both. | Note |
|---|
Since an unresourced job is not associated with a team, unresourced jobs will not be returned if a list of teams is supplied. |
|
|
|
| <APITimeZone>?</APITimeZone>
| | specifies Specifies the timezone which the times (LatestAccess, ExpectedStart, ExpectedArrival, LatestEarliest LatestEarliest and StateDue) returned by sp:JeopReportRequest (section 0) are to be local to. It must be a POSIX timezone string (in sp056), for example: EST5EDT,M4.1.0,M10.5.0 or or IST-5.30 If not supplied, the database parameter tz_jeop_api will be used. |
| |
| <statesToReport>
| is the set of jeopardy conditions to be reported through the web service e.g. (see section 4.3.1 and section 4.3.2). It allows the call to be restricted to a subset of those conditions generated (controlled by | See the "Jeopardy Options" for the optional boolean values which can be passed in as part of the statesToReport structure. When one or more jeopardy state options is set, the results of the call will be restricted to the subset of work items in jeopardy that match the conditions specified. When no jeopardy state options are set, then no filtering is applied and all available work items in jeopardy will be returned. | Note |
|---|
The jeop_check_states |
parameter in the database). If database parameter controls which types of jeopardy states are returned by the API. Only those Jeopardy Options set via the jeop_check_states |
does not contain the check in StatesToReport then those jeopardy conditions will not be reported.If statesToReport1 == 0 then no filtering is applied and all jeopardy conditions will be returned. database parameter to be jeopardy states "in use" can ever be returned by the API, regardless of the value of the StatesToReport parameter passed into the API call. |
|
| |
| | | JeopOptions | | JeopStates1, JeopStates2
| see section 4.3.1 and section 4.3.2 for possible values that can be set |
|
|
| </statesToReport>
| | | | |
| <options>
| | If any other options, other than those shown below, are specified, SP_OPTIONS_INVALID (80) will be returned. |
| |
| | <unresApptMissed>?</unresApptMissed>
| | UNSCHEDULED (0x1)for an appointment boolean | If true, an unresourced work item will only be reported as being in jeopardy if the Appointment Latest time has now passed. |
| |
| | <unresContractMissed>?</unresContractMissed>
| | UNSCHEDULED (0x2) for a non-appointment boolean | If true, an unresourced work item will only be reported as being in jeopardy if the Contract Latest time has now passed. |
| |
| | <apptMissed>?</apptMissed>
| | MISSEDAPPTLATE (0x4)boolean | If true, a resourced work item will only be reported as being in jeopardy if the Appointment Latest time has now passed. |
| |
| | <contractMissed>?</contractMissed>
| | PASTCONTRACT (0x8)boolean | If true, a resourced work item will only be reported as being in jeopardy if the Contract Latest time has now passed. |
| |
| </options>
| | | | |
</sp:JeopReportRequest>
| | | | |
