Integration ServiceOptimizer Change History 11.0.x

11.0.1 New Functionality: New option for employee name details in Get Job SOAP API

• Updated the Integration ServiceOptimizer Get Job SOAP API with details of the new optional parameter to allow the name details of the allocated employee to be returned.

11.0.0 Documentation Updates: Update Spares Stock and Change Work Item

Updated the UpdateSparesStockRequest page to clarify Next Day Stock and the ChangeWorkItemStatusRequest page to clarify the effect of Ignore Van Stock.

Fahad Anwar

Andrew Hill

11.0.0 New Functionality: Updated Job Spares Functionality

With the release of ServiceScheduling 11:

• updated vehicle stock values are now available for scheduling jobs straightaway (without the need for system restart);
• once vehicle spares are updated, the schedule is refreshed for all operatives who are part of the API request; and
• it is possible to pass in details of actual spare parts used during jobs, rather than relying on calculated spare delta values.

• The Set Job Status to Cleared API has been deprecated and removed.
• The Update Spare Stock SOAP API page has been updated with:
  • An updated API definition; and
  • An updated list of valid error codes returned by the API.
• The Integration ServiceOptimizer Change Work Item Status SOAP API page has an updated API definition to handle spares when required.
• The Common Return Codes page has been updated to:
  • note the new correct maximum permitted quantity for the API in relation to the SP_QUANTITY_INVALID (112) error;
  • add new error code SP_DUPLICATE_RESOURCE (803) for the Update Spare Stock SOAP API;
  • add new error code SP_JOB_SPARE_NOT_BOOKED (804) for the Integration ServiceOptimizer Change Work Item Status SOAP API; and
  • add SP_SPAREID_DUPLICATED (578) for Integration ServiceOptimizer Change Work Item Status SOAP API.

11.0.0 New Functionality: Updated Job Spares Capacity

With the release of ServiceScheduling 11, up to 30 spares items per job are now supported.

• Updated the Spares Information page to reflect increased spates capacity.
• Update the Update Spare Stock SOAP API page to:
  • Indicate that NumLocs field is now optional field and is not a required field;
  • Reflect that NumLocs field maximum value is 30.
• Updated the description of SP_NUMLOCS_INVALID(180) on the Common Return Codes page to note that SpareStock provided cannot be > 30 (SetJobClearedRequest).

• Updated the description of  SP_SPAREID_DUPLICATED(578) on the Common Return Codes page to reflect that "Combination of SpareID & Operative is used as unique ID". 

11.0.0 Improvements: Get Job SOAP API

• Updated the Get Job SOAP API to add new optional field sparesInfo to indicate if spares information needs to be return or not.
• Updated the Get Job SOAP API  to add new return structure "SpareInfo"  to return spares information for the job.

11.0.0 New Functionality: User Management

• Updated the Integration ServiceOptimizer Common Jeopardy States documentation with new enumerated data type spareNotInVan related to new User Management functionality.