Engine Dispatch API equivalents for Cloud Dispatch API methods

The Cloud Dispatch API consists of methods for performing actions on dispatches and destinations. The Engine Dispatch API is RESTful, and consists of resources that are operated upon using standard HTTP methods. Those resources are "destinations" and "dispatches".

This document describes how to perform all of the operations available via the Cloud Dispatch API using the Engine Dispatch API, but omits details about request bodies and headers which are covered in the Engine Dispatch API documentation.

Create a dispatch destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.createDestination&appid=myappid&name=Test+Destination

Engine: PUT http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}

Get a list of dispatch destinations

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.getDestinationList&appid=myappid&page=1

Engine: GET http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations

Get information about a single dispatch destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.getDestinationInfo&appid=myappid&destinationid={destinationId}

Engine: GET http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}

Update the name of a dispatch destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.updateDestination&appid=myappid&destinationid={destinationId}&name=Test+Destination+2

Engine: PUT http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}

Delete a dispatch destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.deleteDestination&appid=myappid&destinationid={destinationId}

Engine: DELETE http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}

Create a dispatch

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.createDispatch&appid=myappid&destinationid={destinationId}&courseid={courseId}

Engine: PUT http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches/{dispatchId}

Get a list of all dispatches

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.getDispatchList&appid=myappid&page=1

Engine: GET http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches

Get a list of all dispatches for a particular destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.getDispatchList&appid=myappid&page=1&destinationid={destinationId}

Engine: GET http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}/dispatches

Get information about a single dispatch

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.getDispatchInfo&appid=myappid&dispatchid={dispatchId}

Engine: GET http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches/{dispatchId}

Download a single dispatch package

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.downloadDispatches&appid=myappid&dispatchid={dispatchId}

Engine: GET http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches/{dispatchId}/zip

Download all dispatch packages for a particular destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.downloadDispatches&appid=myappid&destinationid={destinationId}

Engine: GET http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}/dispatches/zip

Update a single dispatch

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.updateDispatches&appid=myappid&dispatchid={dispatchId}

Engine: PUT http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches/{dispatchId} or PUT http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches/{dispatchId}/enabled or DELETE http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches/{dispatchId}/count

Update all dispatches for a particular destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.updateDispatches&appid=myappid&destinationid={destinationId}

Engine: POST http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}/dispatches/enabled or DELETE http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}/dispatches/count

Update all dispatches of a particular course

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.updateDispatches&appid=myappid&courseid={courseid}

Engine: POST http://mylms.com/ScormEngineInterface/api/v1/{tenant}/course/{courseId}/dispatches/enabled or DELETE http://mylms.com/ScormEngineInterface/api/v1/{tenant}/course/{courseId}/dispatches/count

Delete a single dispatch

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.deleteDispatches&appid=myappid&dispatchid={dispatchId}

Engine: DELETE http://mylms.com/ScormEngineInterface/api/v1/{tenant}/dispatches/{dispatchId}

Delete all dispatches for a particular destination

Cloud: http://cloud.scorm.com/api?method=rustici.dispatch.deleteDispatches&appid=myappid&destinationid={destinationId}

Engine: DELETE http://mylms.com/ScormEngineInterface/api/v1/{tenant}/destinations/{destinationId}/dispatches