Content Comparison

<sp:GetJobResponse>

<jobDetails>

<jobType>?</jobType>

JobTypeID

as specified when the job was booked

<earliest>?</earliest>

spDateTime

The earliest date and time at which an appointment can be started OR The ContractEarliest for an SLA.

<latest>?</latest>

spDateTime

The latest date and time at which an appointment can be started (or completed if the job is Call to Fix). OR

The Contract Latest for an SLA

<ReqEmpType>?</ReqEmpType>

int

Present for reasons of backwards compatibility – please ignore.

<listReqEmps>

<reqEmp>

<EmpID>?</EmpID>

EmpID

Identifier of an employee who is either preferred or mandated (by the user) for the task, or who must not be assigned to the task.

<ReqEmpType>?</ReqEmpType>

int

See Integration ServiceOptimizer Common API Concepts Mandatory/Preferred/Excluded Employees (MPX)

</reqEmp

</listReqEmps>

<customer>

Customer information. Structure is optional as data may not be available in the Optimizer tables.

</customer>

<actNotes>?</actNotes>

ActNotes

Free text description. For a job, this is constructed from the 4 description fields supplied when the job was booked, separated by newline characters.

<moreNotes>?</moreNotes>

An optional extra description that can be supplied when the job is booked.

<isAllDayJob>?</isAllDayJob>

Not used – JobStatus field value= 8 will be returned for AllDayJob.

<postcode>?</postcode>

Postcode

Postcode of the employee's location at the time the job is completed.

<region>?</region>

The identifier of the region in which the job takes place.

<expectedStart>?</expectedStart>

The date and time at which the job is expected to start. For a job that spans more than one operative day, this is the start of the first part job. This field is always NULL for an unresourced job.

<expectedEnd>?</expectedEnd>

The date and time at which the job is expected to end. A null value indicates that the job continues indefinitely. For a job that spans more than one operative day, this is the end of the last part job. This field is always NULL for an unresourced job.

<travel>?</travel>

The amount of travel time, in seconds, which is included in the job duration. This is used only for faults and appointments. For a job that spans more than one operative day, this is the travel to the first part job. This field is always NULL for an unresourced job.

<scheduledEmp>?</scheduledEmp>

The identifier of the employee undertaking the job.  if the Job is unresourced, this parameter is not returned at all.

<priority>?</priority>

<disStatus>?</disStatus>

DisStatus

The current dispatch status of the job

<jobStatus>?</jobStatus>

Job Status

0 -Normal

1 - Reserved

4 - Cleared

8 - All Day Job

9 - Reserved

<fixedStatus>?</fixedStatus>

Boolean

Indicates whether the job has been fixed on the schedule

<FRU>?</FRU>

RUID

Responsibility Unit to which the job belongs.

<fruDescription>?</fruDescription>

String

Is the textual description of the fru as set up in the ServicePower database.

<BreakTime>?</BreakTime>

int

is the number of minutes (if any) allowed for any breaks in the duration between expectedStart and expectedEnd; undefined if the job is unresourced

</jobDetails>

</sp:GetJobResponse>