Table of Contents

Class ScormController

Namespace
Engine.Scorm
Assembly
Engine.Scorm.dll
[ApiController]
public class ScormController : ControllerBase
Inheritance
ScormController
Inherited Members

Constructors

ScormController(IMonitor) 

public ScormController(IMonitor monitor)

Parameters

monitor IMonitor

Methods

CreateImportAsync(string, bool, string, string, string) 

[HttpPost("imports")]
[ProducesResponseType<string>(200)]
[EndpointName("createImport")]
public Task<ActionResult<string>> CreateImportAsync(string courseSlug, bool mayCreateNewVersion, string callbackUrl, string uploadedContentType, string contentMetadata)

Parameters

courseSlug string
mayCreateNewVersion bool
callbackUrl string
uploadedContentType string
contentMetadata string

Returns

Task<ActionResult<string>>

CreateRegistration(RegistrationRequest) 

[HttpPost("registrations")]
[ProducesResponseType(204)]
[ProducesResponseType<Problem>(402)]
[EndpointName("createRegistration")]
public IActionResult CreateRegistration(RegistrationRequest request)

Parameters

request RegistrationRequest

Returns

IActionResult

GetCourse(string) 

[HttpGet("courses/{courseSlug}")]
[ProducesResponseType<Course>(200, "application/json", new string[] { })]
[ProducesResponseType(404)]
[EndpointName("getCourse")]
public ActionResult<Course> GetCourse(string courseSlug)

Parameters

courseSlug string

Returns

ActionResult<Course>

GetCourses() 

[HttpGet("courses")]
[ProducesResponseType<Course[]>(200, "application/json", new string[] { })]
[EndpointName("getCourses")]
public ActionResult<Course[]> GetCourses()

Returns

ActionResult<Course[]>

GetImportStatus(string) 

[HttpGet("imports/{importSlug}")]
[ProducesResponseType<CourseImport>(200, "application/json", new string[] { })]
[EndpointName("getImportStatus")]
public ActionResult<CourseImport> GetImportStatus(string importSlug)

Parameters

importSlug string

Returns

ActionResult<CourseImport>

GetRegistrationId(string, Guid) 

[HttpGet("courses/{courseSlug}/learners/{learnerId}/registration")]
[ProducesResponseType<string>(200)]
[EndpointName("getRegistrationId")]
public ActionResult<string> GetRegistrationId(string courseSlug, Guid learnerId)

Parameters

courseSlug string
learnerId Guid

Returns

ActionResult<string>

GetRegistrationInstance(Guid) 

[HttpGet("registrations/{registrationId}/last-instance")]
[ProducesResponseType<int?>(200)]
[EndpointName("getRegistrationInstance")]
public ActionResult<int?> GetRegistrationInstance(Guid registrationId)

Parameters

registrationId Guid

Returns

ActionResult<int?>

GetRegistrationInstanceProgress(Guid) 

[HttpGet("registrations/{registrationId}/progress")]
[ProducesResponseType<RegistrationProgress>(200, "application/json", new string[] { })]
[EndpointName("getRegistrationInstanceProgress")]
public ActionResult<RegistrationProgress> GetRegistrationInstanceProgress(Guid registrationId)

Parameters

registrationId Guid

Returns

ActionResult<RegistrationProgress>

GetRegistrationLaunchUrl(Guid, string, bool, string, string) 

[HttpGet("registrations/{registrationId}/launch-url")]
[ProducesResponseType<string>(200)]
[EndpointName("getRegistrationLaunchUrl")]
public ActionResult<string> GetRegistrationLaunchUrl(Guid registrationId, string courseSlug, bool preview, string callbackUrl, string exitUrl)

Parameters

registrationId Guid
courseSlug string
preview bool
callbackUrl string
exitUrl string

Returns

ActionResult<string>

GetRegistrations(string?, string?) 

[HttpGet("registrations")]
[ProducesResponseType<Registration[]>(200, "application/json", new string[] { })]
[EndpointName("getRegistrations")]
public ActionResult<Registration[]> GetRegistrations(string? course = null, string? more = null)

Parameters

course string
more string

Returns

ActionResult<Registration[]>