_API JeopReportRequest Definition

<sp:JeopReportRequest>

<FRUs>?</FRUs>

RUID

is a list of Final Responsibility Units (FRUs) for which jobs in jeopardy are to be reported to the connected client.  FRUs are separated by the ‘;’ character

<teams>?</teams>

is a list of teams for which jobs in jeopardy are to be reported to the connected client.  Teams are separated by the ‘;’ character.

If FRUs (above) is empty and Teams is empty then all FRUs (and teams) are reported. 

Either FRUs or Teams can be specified, but not both.

<APITimeZone>?</APITimeZone>

specifies the timezone which the times (LatestAccess, ExpectedStart, ExpectedArrival,  LatestEarliest and StateDue) returned by 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  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 jeop_check_states parameter in the database).  If 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.

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 will only be reported if the Appointment Latest time has now passed.

<unresContractMissed>?</unresContractMissed>

UNSCHEDULED (0x2) for a non-appointment will only be reported if the Contract Latest time has now passed.

<apptMissed>?</apptMissed>

MISSEDAPPTLATE (0x4)will only be reported if the Appointment Latest time has now passed.

<contractMissed>?</contractMissed>

PASTCONTRACT (0x8)will only be reported if the Contract Latest time has now passed.

</options>

</sp:JeopReportRequest>