Zoomi Service

The Zoomi Service is strictly geared to those customers who use the zoomi AI service. These methods are largely for managing the Zoomi’s behavior as a plugin to SCORM Cloud launches.

deleteApplicationZoomiKeys

DELETE /zoomi/key

Summary

Delete the Zoomi keys for an application.

Responses:

Produces: application/json

HTTP Code	Description	Schema
204	Success
400	Bad request	MessageSchema
404	`appId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`write:appmgmt` `write`

deleteZoomiCourse

DELETE /zoomi/course/{courseId}/version/{versionId}

Summary

Deletes the course in Zoomi but not in cloud

Parameters

Consumes: application/json

Type	Name	Required	Schema
Path	courseId	true	String
Path	versionId	true	Integer

Responses:

Produces: application/json

HTTP Code	Description	Schema
204	Success
400	Bad request	MessageSchema
404	`courseId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`delete:course` `delete`

getApplicationZoomiCompanyId

GET /zoomi

Summary

Gets the Zoomi company id of an application.

Responses:

Produces: application/json

HTTP Code	Description	Schema
200	Success	StringResultSchema
400	Bad request	MessageSchema
404	`appId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`read` `read:appmgmt`

getApplicationZoomiPublicKey

GET /zoomi/key

Summary

Gets the Zoomi public key for an application.

Responses:

Produces: application/json

HTTP Code	Description	Schema
200	Success	StringResultSchema
400	Bad request	MessageSchema
404	`appId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`read` `read:appmgmt`

getCourseZoomiEnabled

GET /zoomi/course/{courseId}/version/{versionId}/enabled

Summary

Gets the Zoomi enabled value of a course version

Parameters

Consumes: application/json

Type	Name	Required	Schema
Path	courseId	true	String
Path	versionId	true	Integer

Responses:

Produces: application/json

HTTP Code	Description	Schema
200	Success	EnabledSchema
400	Bad request	MessageSchema
404	`courseId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`read` `read:course`

getZoomiCourseStatus

GET /zoomi/course/{courseId}/version/{versionId}

Summary

Gets the status for a course and starts the upload process to Zoomi if not started.

Parameters

Consumes: application/json

Type	Name	Required	Schema
Path	courseId	true	String
Path	versionId	true	Integer

Responses:

Produces: application/json

HTTP Code	Description	Schema
200	Success	StringResultSchema
400	Bad request	MessageSchema
404	`courseId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`read` `read:course`

importCourseVersionToZoomi

PUT /zoomi/course/{courseId}/version/{versionId}/import

Summary

Begin the import process with Zoomi. Must be followed up by a status call.

Parameters

Consumes: application/json

Type	Name	Required	Schema
Path	courseId	true	String
Path	versionId	true	Integer
Body	zoomiCourseOptions	true	ZoomiCourseOptionsSchema

Responses:

Produces: application/json

HTTP Code	Description	Schema
204	Success
400	Bad request	MessageSchema
404	`courseId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`write:course` `write`

setApplicationZoomiCompanyId

PUT /zoomi

Summary

Set the Zoomi company id value of an application.

Parameters

Consumes: application/json

Type	Name	Required	Schema
Body	zoomiCompanyId	true	ZoomiCompanyId

Responses:

Produces: application/json

HTTP Code	Description	Schema
204	Success
400	Bad request	MessageSchema
404	`appId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`write:appmgmt` `write`

setCourseZoomiEnabled

PUT /zoomi/course/{courseId}/version/{versionId}/enabled

Summary

Set the Zoomi enabled value of a course version.

Parameters

Consumes: application/json

Type	Name	Required	Schema
Path	courseId	true	String
Path	versionId	true	Integer
Body	enabled	true	EnabledSchema

Responses:

Produces: application/json

HTTP Code	Description	Schema
204	Success
400	Bad request	MessageSchema
404	`courseId` not found	MessageSchema

Authentication:

Type	Name	Scopes
basic	APP_NORMAL
oauth2	OAUTH	`write:course` `write`