SOAP APIs

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 Name	API
`login`	Login SOAP API
`sp:ActDeleteRequest`	Delete Standard Activity SOAP API
`sp:ActGetRequest`	Get Standard Activity SOAP API
`sp:ActTypeFindFromDescRequest`	Find Standard Activity Types SOAP API
`sp:ActUpdateRequest`	Update Standard Activity SOAP API
`sp:AddSpecialPeriodRequest`	Create Special Period SOAP API
`sp:ApptBookRequest`	Book Appointment SOAP API
`sp:ApptOfferRequest`	Request Appointments SOAP API
`sp:BookDependencyGroupRequest`	Book Dependency Group Jobs SOAP API
`sp:BookSplitDependencyGroupRequest`	Book Split Dependency Group Jobs SOAP API
`sp:CancelDependencyGroupRequest`	Cancel Dependency Group Jobs SOAP API
`sp:ChangeJobPriorityRequest`	Update Job Priority SOAP API
`sp:ChangeWorkItemStatusRequest`	Change Work Item Status SOAP API
`sp:CreateUserRequest`	Create User SOAP API
`sp:DeleteSpecialPeriodRequest`	Delete Special Period SOAP API
`sp:DeleteUserRequest`	Delete User SOAP API
`sp:DispInitRequest`	Initialize Dispatch Queue SOAP API
`sp:DispRequest`	Get Dispatchable Jobs and Activities Queue SOAP API
`sp:DispResultRequest`	Confirm Dispatched Job SOAP API
`sp:DVForceFixJobRequest`	Force Fix Job Operative SOAP API
`sp:EmpAddActRequest`	Create Standard Activity SOAP API
`sp:EmpChangeTravelStatus2Request`	Update Travel Status SOAP API
`sp:EmpCreateRequest`	Create Operative SOAP API
`sp:EmpOverrideRequest`	Operative Override SOAP API
`sp:EmpRestoreRequest`	Shift and Location Restore SOAP API
`sp:EmpUpdateRequest`	Update Operative SOAP API
`sp:FixBreakTimesRequest`	Fix Break Times SOAP API
`sp:GetActsRequest`	Get Employee Activities SOAP API
`sp:GetCapacityStatsRequest`	Get Capacity Statistics SOAP API
`sp:GetChangedEmpRequest`	Operative External Data SOAP API

SOAP API Name	API
`sp:GetChangedWorkItemsRequest`	Get Changed Work Items SOAP API
`sp:GetEmpRequest`	Get Operative SOAP API
`sp:GetEmpsRequest`	Get Employees SOAP API
`sp:GetJobRequest`	Get Job SOAP API
`sp:GetJobsRequest`	Get Employee Jobs SOAP API
`sp:GetJobStatsRequest`	Get Job Statistics SOAP API
`sp:GetJobTypeRequest`	Get Job Type SOAP API
`sp:GetRespUnitsRequest`	Get Responsibility Units SOAP API
`sp:GetUserRequest`	Get User SOAP API
`sp:GetWorkItemStatusRequest`	Get Work Item Status SOAP API
`sp:JeopReportRequest`	Jeopardy Report SOAP API
`sp:JobBookRequest`	Book Non-Appointment Job SOAP API
`sp:JobCancelRequest`	Cancel Job SOAP API
`sp:JobChangeArrivalTimeRequest`	Update Job Arrival Time SOAP API
`sp:JobChangeFinishTimeRequest`	Update Job Finish Time SOAP API
`sp:JobChangeStartTimeRequest`	Update Job Start Time SOAP API
`sp:JobHistoryRequest`	Job History SOAP API
`sp:JobUpdateRequest`	Update Non-Appointment Job SOAP API
`sp:SkillCreateRequest`	Create Skill SOAP API
`sp:OfferAppsMultRequest`	Request Multi-Job Appointments SOAP API
`sp:OptimizerStartRequest`	Start Optimizer SOAP API
`sp:OptimizerStopRequest`	Stop Optimizer SOAP API
`sp:SetPauseJob`	Set Pause Job SOAP API
`sp:spQuit`	Disconnect SOAP API
`sp:UpdateLocationRequest`	Create, Update Delete Postcode Location SOAP API
`sp:UpdateSparesStockRequest`	Update Spares Stock SOAP API
`sp:UpdateSpecialPeriodRequest`	Update Special Period SOAP API
`sp:UpdateUserDerestrictionsRequest`	Update User Job Derestriction SOAP API
`sp:UpdateUserRequest`	Update User SOAP API
`sp2:GetPromSetsResponse`	Get Promise Sets SOAP API

ServiceScheduling 14.2

SOAP APIs

Analytics

API Index

Related content