Document Version

Date            

Author(s)

Summary of Changes

9.2.2 New Functionality: Statusing Breaks

Documentation update for new SOAP API functionality added in ServiceScheduling 9.2.2

Updated the Fix Break Time SOAP API documentation to note new options to set break statuses.

9.2.2 New Functionality: Dispatching Breaks as Separate Entities

Documentation update for new SOAP API functionality added in ServiceScheduling 9.2.2

Updated the values and description of the DispEarmarkTypes enumerated type Data Type and updated the Get Dispatchable Jobs and Activities Queue SOAP API documentation to note that breaks are now dispatched as separate entities.

9.3.0 New Functionality: Cancelling and Rebooking of Long-Duration Jobs in a Split Dependency Group

Documentation update for new SOAP API functionality added in ServiceScheduling 9.3.0.

Updated the Request Appointments SOAP API documentation to note new optional useExtraDuration offerOption to allow the extraDuration value to be used for the total duration of the job parts.

Updated the Request Appointments SOAP API documentation to note new optional IgnoreOverlap forceOption to allow overlaps to be optionally ignored when obtaining offers for long-duration jobs in a split dependency group.

Updated the Book Split Dependency Group Jobs SOAP API documentation to note new optional addJobs option to allow the addition of new jobs to an existing split dependency group.

Updated the Book Split Dependency Group Jobs SOAP API documentation to note new optional forceJobs option to allow the addition of new jobs to an existing split dependency group where an overlap with existing jobs is necessary.

Updated the Cancel Dependency Group Jobs SOAP API and Book Dependency Group Jobs SOAP API documentation to note new functionality to optionally not cancel jobs in the Logged On state.

Updated the Cancel Dependency Group Jobs SOAP API documentation to note that long-duration jobs in a split dependency group that are not cancelled will not have their MuliJobID removed.

Documentation Corrections

Removed incorrectly documented bookOptions of NonConsecShift, ConsecShift and ContigShift for the Book Appointment SOAP API.

Corrected incorrectly documented SetUnEarmark option for the Update Non-Appointment Job SOAP API (was documented as UnEarmark).

Corrected incorrectly documented UseAccessHours option on the Options page (was documented as UseAccHours).

Corrected incorrectly documented API method name of sp:OfferAppsMultRequest for the Request Multi-Job Appointments SOAP API (was documented as sp:ApptOfferMultRequest).

Removed incorrectly documented MultOptions of AllowEmpOT, OfferTextEmpID, DupUseEmpID, SpareIgnVanStock and OfferTextCost for the Request Multi-Job Appointments SOAP API.

Corrected incorrectly document band structure name for the Request Multi-Job Appointments SOAP API (was documented as promBand).

Corrected incorrectly documented NoLocalKnowledge force option for the Request Appointments SOAP API (was documented as IgnoreLocalKnowledge).

Corrected incorrectly documented IntrayWithSkill option on the Options page (was documented as IntrayWithSkills).

Documentation Corrections

Corrected use of a different API method name in the description for the Get Employee Jobs SOAP API.

Corrected use of SP_EMP_NO_SHIFT_ASS (271) as return code for the Force Fix Job Operative SOAP API.

Corrected use of should vs. must for the Cancel Dependency Group Jobs SOAP API.

Removed a deprecated C API from the Update Standard Activity SOAP API documentation.

9.3.0.1

2015-07-21

Andrew Hill

Documentation Corrections

Corrected the Book Dependency Group Jobs SOAP API to note that the targJobsTime parameter of the jobDep section is actually a required, not optional, field.