Document toolboxDocument toolbox

Integration ServiceOptimizer SOAP APIs

Owned by Matthew Wren
Last updated: Jun 13, 2023Version comment
2 min read

The pages listed below describe the public SOAP APIs provided by ServiceOptimizer.

API Index

The following index allows for quick translation between the SOAP API names and the relevant pages that document the APIs in the integration guide.

SOAP API NameAPI
loginLogin SOAP API
sp:ActDeleteRequestDelete Standard Activity SOAP API
sp:ActGetRequestGet Standard Activity SOAP API
sp:ActTypeFindFromDescRequestFind Standard Activity Types SOAP API
sp:ActUpdateRequestUpdate Standard Activity SOAP API
sp:AddSpecialPeriodRequestCreate Special Period SOAP API
sp:ApptBookRequestBook Appointment SOAP API
sp:ApptOfferRequestRequest Appointments SOAP API
sp:BookDependencyGroupRequestBook Dependency Group Jobs SOAP API
sp:BookSplitDependencyGroupRequestBook Split Dependency Group Jobs SOAP API
sp:CancelDependencyGroupRequestCancel Dependency Group Jobs SOAP API
sp:ChangeJobPriorityRequestUpdate Job Priority SOAP API
sp:ChangeWorkItemStatusRequestChange Work Item Status SOAP API
sp:CreateUserRequestCreate User SOAP API
sp:DeleteSpecialPeriodRequestDelete Special Period SOAP API
sp:DeleteUserRequestDelete User SOAP API
sp:DispInitRequestInitialize Dispatch Queue SOAP API
sp:DispRequestGet Dispatchable Jobs and Activities Queue SOAP API
sp:DispResultRequestConfirm Dispatched Job SOAP API
sp:DVForceFixJobRequestForce Fix Job Operative SOAP API
sp:EmpAddActRequestCreate Standard Activity SOAP API
sp:EmpChangeTravelStatus2RequestUpdate Travel Status SOAP API
sp:EmpCreateRequestCreate Operative SOAP API
sp:EmpOverrideRequestOperative Override SOAP API
sp:EmpRestoreRequestShift and Location Restore SOAP API
sp:EmpUpdateRequestUpdate Operative SOAP API
sp:FixBreakTimesRequestIntegration ServiceOptimizer Fix Break Time SOAP API
sp:GetActsRequestGet Employee Activities SOAP API
sp:GetCapacityStatsRequestIntegration ServiceOptimizer Get Capacity Statistics SOAP API



SOAP API NameAPI
sp:GetChangedEmpRequestOperative External Data SOAP API
sp:GetChangedWorkItemsRequestGet Changed Work Items SOAP API
sp:GetEmpRequestIntegration ServiceOptimizer Get Operative SOAP API
sp:GetEmpsRequestGet Employees SOAP API
sp:GetJobRequestGet Job SOAP API
sp:GetJobsRequestGet Employee Jobs SOAP API
sp:GetJobStatsRequestIntegration ServiceOptimizer Get Job Statistics SOAP API
sp:GetJobTypeRequestIntegration ServiceOptimizer Get Job Type SOAP API
sp:GetRespUnitsRequestGet Responsibility Units SOAP API
sp:GetUserRequestIntegration ServiceOptimizer Get User SOAP API
sp:GetWorkItemStatusRequestGet Work Item Status SOAP API
sp:JeopReportRequestJeopardy Report SOAP API
sp:JobBookRequestBook Non-Appointment Job SOAP API
sp:JobCancelRequestCancel Job SOAP API
sp:JobChangeArrivalTimeRequestUpdate Job Arrival Time SOAP API
sp:JobChangeFinishTimeRequestUpdate Job Finish Time SOAP API
sp:JobChangeStartTimeRequestUpdate Job Start Time SOAP API
sp:JobHistoryRequestIntegration ServiceOptimizer Job History SOAP API
sp:JobUpdateRequestUpdate Non-Appointment Job SOAP API
sp:SkillCreateRequestCreate Skill SOAP API
sp:OfferAppsMultRequestRequest Multi-Job Appointments SOAP API
sp:OptimizerStartRequestStart Optimizer SOAP API
sp:OptimizerStopRequestStop Optimizer SOAP API
sp:SetPauseJobIntegration ServiceOptimizer Set Pause Job SOAP API
sp:spQuitDisconnect SOAP API
sp:UpdateLocationRequestCreate, Update Delete Postcode Location SOAP API
sp:UpdateSparesStockRequestUpdate Spares Stock SOAP API
sp:UpdateSpecialPeriodRequestUpdate Special Period SOAP API
sp:UpdateUserDerestrictionsRequestUpdate User Job Derestriction SOAP API
sp:UpdateUserRequestUpdate User SOAP API