RESTified APIs
ServiceBroker RESTified APIs allow other systems to be integrated with ServiceBroker and to then interact with sub-systems that are supported by ServiceBroker, but where native ServiceBroker support for the sub-systems actions are not yet supported.
That is, when integrating a system with ServiceBroker, it may be desirable to integrate with an associated Dispatch or Scheduling system's functionality, where that functionality is not yet natively integrated into ServiceBroker.
In these cases, it is possible for the integrating system to directly call the appropriate Dispatch or Scheduling system API, as required.
However, ServiceBroker's RESTified APIs allow for the integrating system to call a REST API endpoint hosted by ServiceBroker, and ServiceBroker will "pass-through" the request to the relevant sub-system - including handling the conversion of the API call into the appropriate endpoint requirement (e.g. translation into SOAP).
This pass-through feature can assist systems integrators to more quickly integrate with multiple systems, by providing both a single endpoint (ServiceBroker) and a single integration approach (REST API).
When integrating with ServiceBroker, please check the native REST APIs for desired functionality first. Where available, native ServiceBroker APIs should be used in preference to the pass-through, RESTified APIs.
As ServiceBroker development proceeds, RESTified APIs may be replaced over time with native REST APIs. Systems integrators should be prepared to update their integrations to native REST APIs when they become available.
Available RESTified APIs
Claims RESTified APIs
Dispatch RESTified APIs
In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.
- GetNetworkAttributes RESTified API
- GetServicerNotes RESTified API
- GetShipmentInfo RESTified API
- GetStatusEnquiry RESTified API
- GetStatusHistory RESTified API
- ReNotify RESTified API
- UpdateCallScheduleInfo RESTified API
- UpdateCallStatusInfo RESTified API
- UpdateConsumerInfo RESTified API
- UpdateNetworkAttributes RESTified API
- UpdatePaymentInfo RESTified API
- UpdateProblemInfo RESTified API
- UpdateProductInfo RESTified API
- UpdateServicerNotes RESTified API
- Dispatch return codes
- DispatchErrorcodes
Scheduling RESTified APIs
In addition to the Standard Return Codes, and the Scheduling Error codes, individual API calls made have unique codes found on their individual pages.
- CDM Scheduling APIs
- UpdateJobArrivalTime RESTified API
- UpdateJobFinishTime RESTified API
- CreateSkill RESTified API
- ConfirmDispatchedJob RESTified API
- GetChangedWorkItems RESTified API
- GetEmployeeActivities RESTified API
- FixBreakTimes RESTified API
- CancelDependencyGroupJobs RESTified API
- BookDependencyGroupJobs RESTified API
- CancelJob RESTified API
- BookJob RESTified API
- GetResponsiblityUnits RESTified API
- ForceFixJob RESTified API
- UpdateJob RESTified API
- EmpAddAct RESTified API
- GetEmployeeJobs RESTified API
- Non-CDM Scheduling APIs