Document toolboxDocument toolbox

9.3.2.x 2

Change History

Document Version

Date            

Author(s)

Summary of Changes

9.3.2.22016-05-27Andrew HillNo changes.
9.3.2.12016-05-09Andrew HillNo changes.
9.3.2.02016-03-24 Paul Hindle

Contains multiple clarifications and corrections as a result of consultants documentation review.

9.3.2.02016-03-24Andrew Hill

Documentation Corrections

9.3.2.02016-03-22Andrew Hill

Documentation Corrections

  • Corrected the documentation for the Request Appointments SOAP API to fix the descriptions of the ContigShift and ConsecShift values in the splitOffers return structure.

Documentation Improvements

  • Clarified the definitions of what types of shifts will be returned when using the ContigShift, ConsecShift or NonConsecShift long duration job booking options.
9.3.2.02016-03-18Andrew Hill

Documentation Corrections

Documentation Improvements

  • Clarified how the Request Appointments SOAP API numReq and numReqType parameters operate, potentially returning more appointments than defined by numReq.
  • Clarified the use of the start and end date parameter values for the Request Appointments SOAP API, and what error codes will be returned under the two possible error situations for incorrect dates.
  • Clarified how the AllowEmpOT option of the Request Appointments SOAP API affects consideration of using overtime when requesting appointments for jobs of long duration, that are split across multiple shifts.
  • Clarified the validity of the days and preferredDate parameters in the Request Appointments SOAP API when requesting appointments for jobs of long duration, that are split across multiple shifts.
9.3.2.02016-03-16Andrew Hill

Documentation Corrections

  • Corrected the details of valid inputs for the mode parameter of the Initialize Dispatch Queue SOAP API (was documented as the options for another API parameter).
  • Corrected the name of the DispMode enumerated Data Type (was documented as DisMode).
  • Corrected the name of the DispRangeType enumerated Data Type (was documented as DispRangeTypes).
  • Added missing FRUID and DRUID Common Data Types.
9.3.2.02016-03-11Andrew Hill

Documentation Corrections

  • Corrected the size of the Common Data Type ActNotes field to 2003 characters (was documented as 503).
9.3.2.02015-10-22Wendy Swann

Documentation Corrections