<sp:GetEmpResponse>

A optional structure containing the employee's details.

• This structure is only returned when the API call does not return an error Return Code.

The employee type:

• When 0, the employee is a individual employee;
• When 1, the employee is actually a crew (team) of employees.

string

string

<hand-held1>?</hand-held1>

<hand-held2>?</hand-held2>  

<current-hand-held>?</current-hand-held>

string

A flag indicating whether or not the employee can be scheduled jobs:

• 0 - The employee is not schedulable
• 1 - The employee is schedulable

The inform lead time, in minutes, for this employee, if one has been defined.

In the event that one has not been defined for the employee, then no value will be returned. However, please be aware that in this case, the system will be using either:

• the inform lead time for the employee's responsibility unit (recorded in the sp213_scheduler_parameters database table), or, if this is NULL; then
• the system inform lead time (recorded in the sp083_system_parameters database table).

A reference to a location in the sp047_postcodes database table, where the value of sp047_postcodes.region_no is equal to the value of work-region-no.

The reference define's the employee's "work" location, to be used when appropriate for:

• Their start of shift location (see the default-start-loc field);
• Their end of shift location (see the default-end-loc field); or
• Their local knowledge calculation location (see the default-lk-centre-loc field).

An employee may, through a working day, move between different time zones. The employee's schedule for the day could be represented in terms of the time zone of the location in which they are in at any given time, but it is more sensible to assume that the employee has a watch and is working to their own "local" time zone.

The tz-type flag indicates how the employee's "local" time zone is determined:

• 0 - The employee's "local" time zone will be determined by the value of the tz_no field.
• 1 - The employee's "local" time zone will be determined by the employee's home address.

Otherwise, if the field is NULL, the employee's "local" time zone will be determined by the tz_Default value of the sp083_system_parameters database table.

When the tz-type field (above) is set to 0:

• If tz-no is NULL, then the server's time zone is used for the employee's "local" time zone; otherwise
• The employee's "local" time zone is the timezone stored in the sp056_time_zones database table, where the value of sp056_time_zones.tz_no is equal to the value of tz-no.

The maximum number of jobs that will be auto-earmarked at any given time for the employee.

The count only applies to jobs that are auto-eamarked. Those earmarked by batch dispatch or user-earmarked do not count towards earmarked_jobs_max. Once a job is no longer earmarked, e.g. it has passed on into the contacted state, it also no longer counts towards earmarked_jobs_max.

If the field is NULL, then the maxmimum number of jobs that will be auto-earmarked at any given time for the employee will be determined by the disp_earmark_jobs_max value set in the sp213_scheduler_parameters database table (if present for the employee's RU), or, otherwise, by the disp_earmark_jobs_max value of the sp083_system_parameters database table.

string

The location of the employee at the start of their shift:

• 0 - Home
• 1 - Work
• 2 - Depot
• 3 - Specified

The ID of the employee's start of shift location "region", when the value of the default-start-loc field is 3 (Specified).

string

The location of the employee at the end of their shift:

• 0 - Home
• 1 - Work
• 2 - Depot
• 3 - Specified

The ZIP code/postcode of the employee's end of shift location, when the value of the default-end-loc field is 3 (Specified).

The maximum permitted before-shift travel for the employee, in minutes.

When NULL, this indicates that the maximum permitted before-shift travel value for the employee will be the value defined for the employee's FRU.

The maximum permitted after-shift travel for the employee, in minutes.

When NULL, this indicates that the maximum permitted after-shift travel value for the employee will be the value defined for the employee's FRU.

string

The location from which the employee's Local Knowledge range is calculated:

• 0 - Home
• 1 - Work
• 2 - Depot
• 3 - Specified

string

The number of days, starting from "today", that should be frozen for the employee.

If this value is 0 then "today" does not get frozen until "now" is later than the value of frozen-day-trigger-time. If this value is 1 then "today" will be frozen, and "tomorrow" will be frozen once it is later than the value of frozen-day-trigger-time – and so on.

Takes account of non-working days (see: sp013_non_working_days).

int

int

A flag field that defines how the employee's status will be displayed in ServiceScheduling.

When the value is:

• 0 - Neither the employee's status or travel status is displayed;
• 1 - Only the employee's status is displayed;
• 2 - Only the employee's travel status is displayed;
• 3 - Both the employee's status and the travel status are displayed.

The employee's current travel status as set by an Update Travel Status SOAP API call.

Typically this is the status reported to ServiceOptimizer that represents the vehicle's current state:

• 0 - None
• 2 - Stopped
• 3 - Stationary
• 4 - Moving
• 5 - Unknown.

If travel status is not enabled for this employee or this employee has not yet had a travel status supplied via the API, then the value will be 0.

The date/time (in the employee's FRU timezone) that the employee's travel-status value was set by an Update Travel Status SOAP API call, for the last such API call made.

Note: This is the date and time at which the call to the Update Travel Status SOAP API was made - not the timeStamp field supplied as one of the Update Travel Status SOAP API call parameters.

The date/time (in the employee's FRU timezone) that the employee's travel-status value was set according to the timeStamp field supplied as one of the Update Travel Status SOAP API call parameters, for the last such API call made.

The most recent date/time (in the employee's FRU timezone) that the employee's travel-status value was set to the Moving status, according to the timeStamp field supplied as one of the Update Travel Status SOAP API call parameters, for the last such API call made.

string

If the current travel-status value is 2 (i.e. Stopped) then the current-loc-type value further qualifies the type of location at which the employee is stopped (see sp561_geofence_location_types).

The date/time (in the employee's FRU timezone) that the employee's travel status was last known to be stopped at a location in the "overnight" class (see sp561_geofence_location_types.location_class).

The date/time (in the employee's FRU timezone) that the employee's travel status was last known to be stopped at a location in the "customer" class (see sp561_geofence_location_types.location_class).