Dispatch Service

API V2 reference

This page applies to SCORM Cloud API V2. If you're looking for our V1 api reference see here

createDestinations

POST /dispatch/destinations

Summary

Create multiple destinations.

Parameters

Consumes: application/json

Type Name Required Schema
Body destinationsList true DestinationListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




createDispatches

POST /dispatch/dispatches

Summary

Create multiple dispatches at once.

Parameters

Consumes: application/json

Type Name Required Schema
Body dispatchList true CreateDispatchListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




deleteDestination

DELETE /dispatch/destinations/{destinationId}

Summary

Delete the destination with destinationId

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Path destinationId2 true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:dispatch
delete




deleteDestinationDispatches

DELETE /dispatch/destinations/{destinationId}/dispatches

Summary

Delete the dispatches in a destination

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:dispatch
delete




deleteDestinationTags

DELETE /dispatch/destinations/{destinationId}/tags

Summary

Delete the tags for this destination

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Body tags true TagListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




deleteDispatch

DELETE /dispatch/dispatches/{dispatchId}

Summary

Delete the dispatch with dispatchId.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String
Path dispatchId2 true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:dispatch
delete




deleteDispatchPostbackInfo

DELETE /dispatch/dispatches/{dispatchId}/postback

Summary

Delete the postback info dispatch with ‘dispatchId’.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:dispatch
delete




deleteDispatchTags

DELETE /dispatch/dispatches/{dispatchId}/tags

Summary

Delete the tags for this dispatch.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String
Body tags true TagListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




enableRegistrationInstancing

POST /dispatch/destinations/{destinationId}/dispatches/registrationInstancing

Summary

Enable or disable registration instancing.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Body enabled true EnabledSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




getDestination

GET /dispatch/destinations/{destinationId}

Summary

Gets detailed information about a destination belonging to a destinationId.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 The destination belonging to the provided id. DestinationSchema
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDestinationDispatchRegistrationCount

GET /dispatch/destinations/{destinationId}/dispatches/registrationCount

Summary

Get an aggregate count of all related dispatch registrations.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 IntegerResultSchema
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDestinationDispatchZip

GET /dispatch/destinations/{destinationId}/dispatches/zip

Summary

Returns a zip file containing all of the dispatch packages for a destination.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Query type String
Query cssUrl String
Query tags List

Responses:

Produces: application/zip

HTTP Code Description Schema
200 A zip file containing the dispatches. file
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDestinationDispatches

GET /dispatch/destinations/{destinationId}/dispatches

Summary

Get a list of related dispatches.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Query courseId String
Query more String
Query since Date
Query until Date
Query tags List
Query datetimeFilter String
Query orderBy String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of dispatches DispatchListSchema
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDestinationHashUserInfo

GET /dispatch/destinations/{destinationId}/dispatches/hashUserInfo

Summary

True if the destination is set to hash user info, or false if it is disabled.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 The current state of the enabled flag EnabledSchema
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDestinationTags

GET /dispatch/destinations/{destinationId}/tags

Summary

Get the tags for this destination

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 List of tags for this destination TagListSchema
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDestinations

GET /dispatch/destinations

Summary

Get a list of destinations.

Parameters

Consumes: application/json

Type Name Required Schema
Query courseId String
Query more String
Query since Date
Query until Date
Query tags List
Query datetimeFilter String
Query orderBy String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of destination. DestinationListSchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDispatch

GET /dispatch/dispatches/{dispatchId}

Summary

Get the dispatch with dispatchId.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 The dispatch belonging to the provided id. DispatchSchema
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDispatchEnabled

GET /dispatch/dispatches/{dispatchId}/enabled

Summary

Get the enabled status for dispatchId. True if the dispatch is enabled, or false if it is disabled.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 EnabledSchema
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDispatchHashUserInfo

GET /dispatch/dispatches/{dispatchId}/hashUserInfo

Summary

Get if this dispatch has PII hashing enabled. True if the dispatch is set to hash user info, or false if it is disabled.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 The current state of the enabled flag EnabledSchema
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDispatchRegistrationCount

GET /dispatch/dispatches/{dispatchId}/registrationCount

Summary

Get the registration count for this dispatch, and the date and time of the last count reset, if any.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 DispatchRegistrationCountSchema
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDispatchTags

GET /dispatch/dispatches/{dispatchId}/tags

Summary

Get the tags for this dispatch.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String

Responses:

Produces: application/json

HTTP Code Description Schema
200 List of tags for this dispatch TagListSchema
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDispatchZip

GET /dispatch/dispatches/{dispatchId}/zip

Summary

Get the ZIP for the dispatch with dispatchId

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String
Query type String
Query cssUrl String

Responses:

Produces: application/zip

HTTP Code Description Schema
200 file
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




getDispatches

GET /dispatch/dispatches

Summary

Get a list of dispatches.

Parameters

Consumes: application/json

Type Name Required Schema
Query courseId String
Query more String
Query since Date
Query until Date
Query tags List
Query datetimeFilter String
Query orderBy String

Responses:

Produces: application/json

HTTP Code Description Schema
200 A list of dispatches DispatchListSchema
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH read
read:dispatch




putDestinationTags

PUT /dispatch/destinations/{destinationId}/tags

Summary

Set the tags for this destination

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Body tags true TagListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




putDestinationTagsBatch

PUT /dispatch/destinations/tags

Summary

Sets all of the provided tags on all of the provided destinations

Parameters

Consumes: application/json

Type Name Required Schema
Body batch true BatchTagsSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




putDispatchTags

PUT /dispatch/dispatches/{dispatchId}/tags

Summary

Set the tags for this dispatch.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String
Body tags true TagListSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




putDispatchTagsBatch

PUT /dispatch/dispatches/tags

Summary

Sets all of the provided tags on all of the provided dispatches

Parameters

Consumes: application/json

Type Name Required Schema
Body batch true BatchTagsSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Set tags successfully
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




resetDestinationDispatchRegistrationCount

DELETE /dispatch/destinations/{destinationId}/dispatches/registrationCount

Summary

Reset registration counts for all related dispatches.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:dispatch
delete




resetDispatchRegistrationCount

DELETE /dispatch/dispatches/{dispatchId}/registrationCount

Summary

Reset the registration count for this dispatch.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH delete:dispatch
delete




setDestination

PUT /dispatch/destinations/{destinationId}

Summary

Creates or updates the destination identified by the destinationId provided in the path. If the destination is being created, a name should be provided in the DestinationSchema, else an error will be thrown.

You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. If you do not supply an e-mail address upon the creation of a destination, the owner of the Realm will be used. This can, of course, also be changed via calling this method to update an existing destination.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Body destination true DestinationSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




setDestinationDispatchEnabled

POST /dispatch/destinations/{destinationId}/dispatches/enabled

Summary

Enable or disable all related dispatches.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Body enabled true EnabledSchema

Responses:

Produces: application/json

HTTP Code Description Schema
200
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




setDispatchEnabled

PUT /dispatch/dispatches/{dispatchId}/enabled

Summary

Set the enabled status for dispatchId.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String
Body enabled true EnabledSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




updateDestinationHashUserInfo

PUT /dispatch/destinations/{destinationId}/dispatches/hashUserInfo

Summary

Enable or disable hashing of the user info for the destination.

Parameters

Consumes: application/json

Type Name Required Schema
Path destinationId true String
Body enabled true EnabledSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 destinationId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




updateDispatch

PUT /dispatch/dispatches/{dispatchId}

Summary

Update the dispatch with dispatchId.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String
Body dispatchProperties true UpdateDispatchSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write




updateDispatchHashUserInfo

PUT /dispatch/dispatches/{dispatchId}/hashUserInfo

Summary

Enable or disable hashing of the user info for the dispatch.

Parameters

Consumes: application/json

Type Name Required Schema
Path dispatchId true String
Body enabled true EnabledSchema

Responses:

Produces: application/json

HTTP Code Description Schema
204 Success
400 Bad request MessageSchema
404 dispatchId not found. MessageSchema

Authentication:

Type Name Scopes
basic APP_NORMAL
oauth2 OAUTH write:dispatch
write