Uploading and creating a SCORM via LMS365 API

Uploading SCORM packages to LMS365  can be done either in the LMS365 Admin Center or directly via the LMS365 API endpoints. This article describes how to upload a zip file and later create a SCORM based on this zip file with the help of LMS365 APIs.

In this article

 

Uploading a zip file via API to be able to create a SCORM via API

To upload a zip package to the LMS365 content packages storage do the following:

  1. Navigate to the LMS365 Cloud API, get authorized and under the Scorms section select the POST /scorms/upload endpoint with the 'Upload zip package to storage' description.
  2. Select 'Try it out' and in the Upload File field choose a zip file from your computer. When ready, select the blue 'Execute' button to run the command.

     

     

  3. Scroll down to the Responses block to check the results:

    • Number 2xx (for example, 200) under Code shows that the request worked correctly.
    • In the Response body field you will see a newly uploaded zip package and its details. Please, make sure that the Success is true to confirm that the zip file has been successfully uploaded.

 

 

NOTE   

At this step the file is uploaded to LMS365 but it isn't recognize as a SCORM content package and isn't displayed in the list of content packages in the LMS365 Admin Center. To finish creation of a SCORM package complete the steps below. For creating a SCORM data from this step will be relevant, so we recommend not to close this endpoint to be able to refer to its data.

 

Creating a SCORM via API

After a zip file is uploaded to LMS365 via API, a SCORM package can be created based on this uploaded file to be recognized by LMS365 as a SCORM package. To do this, follow the steps:

1. Under the Scorms section select the POST /odata/v2/Scorms endpoint with the 'Creates a SCORM.' description.

2. Select 'Try it out' and in the Edit Value field specify the parameters. Some of the parameters are requires, others are optional. The required parameter can be taken from the response of the endpoint used to upload the zip file.

The required parameters are:

  • "Title": Give your SCORM a name.
  • "Configuration": Take this data from the response of the endpoint used to upload the zip file under the DefaultConfiguration parameter.

     

     

    IMPORTANT   

    A backslash is required to add right before each of the double quotation mark, for example, {\"AllowBrowse\":false,\"Tag\":\"\",\"Attempts\":null}".

     

    • "ContentType": Type either 'Scorm' or 'Aicc'.
    • "Location": Insert the location of the uploaded zip file.

       

       

    3. When ready, select the blue 'Execute' button to run the command.
    Here as an example of the API request body to create a SCORM filled in with the data from the response of the uploaded zip file. The API request body contains required and optional parameters set.

     

     

    4. Scroll down to the Responses block to check the results:

    • Number 2xx (for example, 200) under Code shows that the request worked correctly.
    • In the Response body field you will see a newly created SCORM package and its details. Please, make sure that the Success is true to confirm that the SCORM has been successfully created.

     

     

    The SCORM is now successfully created via LMS365 API and will be displayed in the LMS365 Admin Center in the list of content packages.

     

     

  •  
Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.