arisjulio / scorm-api-adapter

Simple SCORM API Adapter.
20 stars 6 forks source link

Can you give documentation for this? #1

Closed sureshmariadass closed 5 years ago

sureshmariadass commented 5 years ago

I am new to SCORM. Can you explain how to use that?

arisjulio commented 5 years ago

As you will know, A SCORM package is a set of web and media object to present information to an user.

To allow a SCORM Object to persist data you need an adapter and a web service like a REST API.

This repo is a simple implementation of an adapter. You need to load the minified file in the parent window on which the SCORM will be loaded.

The SCORM calls the adapter when it needs to persists data and the adapter calls the web service. For this implementation you need to specify a URL to commit the changes.

A sample POST request body to the endpoint looks like:

{
  "question_1": "answer_1",
  "intereaction_2": "answer_2",
  "interaction_3": "B"
}

For this package, the endpoint must return a success field:

{
  "success": true
}