Content Comparison

Documentation Corrections

• Removed incorrect statement that unused spare IDs should be specified in the description of the <reqSpares> structure on the Integration ServiceOptimizer Common API Concepts Spares Information page.
• Corrected the Integration ServiceOptimizer Set Job Status to Cleared SOAP API page to note that both the <dateTime> and <spareStock> fields are optional, not required.
• Corrected the Integration ServiceOptimizer Update Spares Stock SOAP API page to note that:
  • • The <NumLocs> field is of type int, is a mandatory field, and must be set to the number of <spareStock> structures in the request;
    • Only the Vehicle value for the <LocType> field is supported; and
    • Corrected the description for the <quantity> field.

Documentation Improvements

• Updated the following to correct links to other sections of the documentation:
  • • Integration ServiceOptimizer Book Appointment SOAP API
    • Integration ServiceOptimizer Book Dependency Group Jobs SOAP API
    • Integration ServiceOptimizer Book Non-Appointment Job SOAP API
    • Integration ServiceOptimizer Request Appointments SOAP API

Jackie Latham

Documentation Improvements

• Updated the Integration ServiceOptimizer Request Appointments SOAP API make it clearer that specific fields should be used to retrieve data rather than parsing the offerText field.

Documentation Corrections

• Fixed the definition of the Operative Override SOAP API, to add a missing <reqBreaks> section in the API definition.

Documentation Corrections

• Corrected the details of when the SP_OPTION_COMBINATION_INVALID (159) error code is returned on the Return Codes page.

Documentation Improvements

• Re-ordered the SOAP APIs sections to match original publication order.
• Added an index to the SOAP APIs page to make finding documentation via SOAP API name easier.

Documentation Improvements

• Updated the Integration ServiceOptimizer Request Appointments SOAP API make it clearer that specific fields should be used to retrieve data rather than parsing the offerText field.

Documentation Corrections

• Fixed the definition of the Operative Override SOAP API, to add a missing <reqBreaks> section in the API definition.

Documentation Corrections

• Corrected the details of when the SP_OPTION_COMBINATION_INVALID (159) error code is returned on the Return Codes page.

Documentation Improvements

• Re-ordered the SOAP APIs sections to match original publication order.
• Added an index to the SOAP APIs page to make finding documentation via SOAP API name easier.

Documentation Improvements

• Corrected description for SP_BREAKTYPE_INVALID (650) on the Return Codes page.

 Documentation Improvements

• Corrected return codes for Fix Break Time SOAP API.
• Improved description for SP_BREAKSEQ_OVERLAPS (654)  within on the Return Codes page.
• Improved description for breaks within Operative Override SOAP API to state that breaks must be passed in chronological order.
• Added section Customer Information section.
• Added section Dependency Groups section.
• Added section Description Fields section.
• Added section Employee Jobs Interface section.
• Added section Spares Information section.

Documentation Improvements

• Clarified the timezone for BreakStart in Initialize Dispatch Queue SOAP API and Get Dispatchable Jobs and Activities Queue SOAP API.

Documentation Corrections

• Updated the Request Appointments SOAP API to correct the description of OfferText and Clarify clarify the difference between Long long jobs and normal jobs with regard to return of EmpId.

Documentation Corrections

• Added missing SP_BREAKTYPE_INVALID (650) to list of response codes for Shift and Location Restore SOAP API.
• Corrected documentation re: OfferTextEmpId for Request Appointments SOAP API.

Documentation Corrections

• Added missing parameter ReqEmpType to Get Employee Jobs SOAP API return definition.
• Corrected cross reference to MPX details in the Get Job SOAP API and Get Employee Jobs SOAP API definitions.
• Corrected description of parameters in the Force Fix Job Operative SOAP API definition.

Documentation Improvements

• Moved details on Common API Concepts Contract , Service and Access Hours into a separate common concepts section, from various locations throughout the guide.
• Updated the Create, Update Delete Postcode Location SOAP API to note the effect of not supplying optional parameters.