Uploading and creating a content package via LMS365 API

Uploading SCORM and AICC content 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 content package 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 content package 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 in the top left corner and in the Upload File field choose a zip file from your computer. When ready, select the 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 content package and isn't displayed in the list of content packages in the LMS365 Admin Center. To finish creation of a content package complete the steps below. For creating a content package 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 content package via API

After a zip file is uploaded to LMS365 via API, this file can be used as a base to create a content package recognizable by LMS365. 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 in the top left corner and in the Edit Value field specify the parameters. Some of the parameters are required, others are optional. Some of the required parameters can be taken from the response of the endpoint used to upload the zip file (described in the section above).

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 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 content package and its details. Please, make sure that the Success is true to confirm that the content package has been successfully created.
  • You can use the Download button to save the results to your computer in .JSON format.

 

The content package is now successfully created via LMS365 API and will be displayed in the content package storage of the LMS365 Admin Center.

 

 

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

Comments

Article is closed for comments.