@easyedu/js-lsm-api 1.90.0 → 1.92.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +70 -0
- package/README.md +65 -2
- package/dist/apis/ContentLibraryQuizApi.d.ts +451 -0
- package/dist/apis/ContentLibraryQuizApi.js +1162 -0
- package/dist/apis/PlayerApi.d.ts +130 -1
- package/dist/apis/PlayerApi.js +257 -1
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ContentLibraryQuizApi.d.ts +451 -0
- package/dist/esm/apis/ContentLibraryQuizApi.js +1158 -0
- package/dist/esm/apis/PlayerApi.d.ts +130 -1
- package/dist/esm/apis/PlayerApi.js +256 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/GetCourseVersionItem.d.ts +14 -0
- package/dist/esm/models/GetCourseVersionItem.js +9 -0
- package/dist/esm/models/GetLibraryQuiz.d.ts +124 -0
- package/dist/esm/models/GetLibraryQuiz.js +100 -0
- package/dist/esm/models/GetLibraryQuizAnalytics.d.ts +68 -0
- package/dist/esm/models/GetLibraryQuizAnalytics.js +67 -0
- package/dist/esm/models/GetLibraryQuizList.d.ts +57 -0
- package/dist/esm/models/GetLibraryQuizList.js +60 -0
- package/dist/esm/models/GetLibraryQuizResult.d.ts +94 -0
- package/dist/esm/models/GetLibraryQuizResult.js +79 -0
- package/dist/esm/models/GetLibraryQuizSession.d.ts +177 -0
- package/dist/esm/models/GetLibraryQuizSession.js +129 -0
- package/dist/esm/models/GetLibraryQuizSessionList.d.ts +57 -0
- package/dist/esm/models/GetLibraryQuizSessionList.js +60 -0
- package/dist/esm/models/GetLibraryQuizUsage.d.ts +56 -0
- package/dist/esm/models/GetLibraryQuizUsage.js +59 -0
- package/dist/esm/models/GetLibraryQuizVersion.d.ts +170 -0
- package/dist/esm/models/GetLibraryQuizVersion.js +125 -0
- package/dist/esm/models/GetResourceSession.d.ts +30 -0
- package/dist/esm/models/GetResourceSession.js +16 -0
- package/dist/esm/models/GetResourceSessionDiagnostics.d.ts +76 -0
- package/dist/esm/models/GetResourceSessionDiagnostics.js +69 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.js +76 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsResource.js +56 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.js +59 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsUser.js +47 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsVersion.js +67 -0
- package/dist/esm/models/GetResourceSessionScormApiLogs.d.ts +57 -0
- package/dist/esm/models/GetResourceSessionScormApiLogs.js +60 -0
- package/dist/esm/models/GetResourceSessionScormData.d.ts +77 -0
- package/dist/esm/models/GetResourceSessionScormData.js +66 -0
- package/dist/esm/models/GetResourceSessionScormDataActivity.d.ts +44 -0
- package/dist/esm/models/GetResourceSessionScormDataActivity.js +45 -0
- package/dist/esm/models/LibraryQuizCriterion.d.ts +95 -0
- package/dist/esm/models/LibraryQuizCriterion.js +76 -0
- package/dist/esm/models/LibraryQuizQuestion.d.ts +70 -0
- package/dist/esm/models/LibraryQuizQuestion.js +63 -0
- package/dist/esm/models/LibraryQuizQuestionInput.d.ts +50 -0
- package/dist/esm/models/LibraryQuizQuestionInput.js +51 -0
- package/dist/esm/models/LibraryQuizSessionAnswerChoice.d.ts +51 -0
- package/dist/esm/models/LibraryQuizSessionAnswerChoice.js +54 -0
- package/dist/esm/models/LibraryQuizSessionQuestion.d.ts +96 -0
- package/dist/esm/models/LibraryQuizSessionQuestion.js +84 -0
- package/dist/esm/models/PostCourseLibraryQuizSession.d.ts +32 -0
- package/dist/esm/models/PostCourseLibraryQuizSession.js +41 -0
- package/dist/esm/models/PostLibraryQuiz.d.ts +107 -0
- package/dist/esm/models/PostLibraryQuiz.js +70 -0
- package/dist/esm/models/PostLibraryQuizSession.d.ts +32 -0
- package/dist/esm/models/PostLibraryQuizSession.js +41 -0
- package/dist/esm/models/PostLibraryQuizVersion.d.ts +32 -0
- package/dist/esm/models/PostLibraryQuizVersion.js +41 -0
- package/dist/esm/models/PutLibraryQuiz.d.ts +38 -0
- package/dist/esm/models/PutLibraryQuiz.js +43 -0
- package/dist/esm/models/PutLibraryQuizCriteria.d.ts +33 -0
- package/dist/esm/models/PutLibraryQuizCriteria.js +44 -0
- package/dist/esm/models/PutLibraryQuizQuestions.d.ts +33 -0
- package/dist/esm/models/PutLibraryQuizQuestions.js +44 -0
- package/dist/esm/models/PutLibraryQuizSessionAnswer.d.ts +40 -0
- package/dist/esm/models/PutLibraryQuizSessionAnswer.js +45 -0
- package/dist/esm/models/PutLibraryQuizSessionGrade.d.ts +38 -0
- package/dist/esm/models/PutLibraryQuizSessionGrade.js +45 -0
- package/dist/esm/models/PutLibraryQuizVersion.d.ts +101 -0
- package/dist/esm/models/PutLibraryQuizVersion.js +64 -0
- package/dist/esm/models/QuestionSelectionMethod.d.ts +25 -0
- package/dist/esm/models/QuestionSelectionMethod.js +43 -0
- package/dist/esm/models/ResourceSessionScormApiLogItem.d.ts +79 -0
- package/dist/esm/models/ResourceSessionScormApiLogItem.js +73 -0
- package/dist/esm/models/index.d.ts +34 -0
- package/dist/esm/models/index.js +34 -0
- package/dist/models/GetCourseVersionItem.d.ts +14 -0
- package/dist/models/GetCourseVersionItem.js +10 -1
- package/dist/models/GetLibraryQuiz.d.ts +124 -0
- package/dist/models/GetLibraryQuiz.js +108 -0
- package/dist/models/GetLibraryQuizAnalytics.d.ts +68 -0
- package/dist/models/GetLibraryQuizAnalytics.js +74 -0
- package/dist/models/GetLibraryQuizList.d.ts +57 -0
- package/dist/models/GetLibraryQuizList.js +67 -0
- package/dist/models/GetLibraryQuizResult.d.ts +94 -0
- package/dist/models/GetLibraryQuizResult.js +86 -0
- package/dist/models/GetLibraryQuizSession.d.ts +177 -0
- package/dist/models/GetLibraryQuizSession.js +137 -0
- package/dist/models/GetLibraryQuizSessionList.d.ts +57 -0
- package/dist/models/GetLibraryQuizSessionList.js +67 -0
- package/dist/models/GetLibraryQuizUsage.d.ts +56 -0
- package/dist/models/GetLibraryQuizUsage.js +66 -0
- package/dist/models/GetLibraryQuizVersion.d.ts +170 -0
- package/dist/models/GetLibraryQuizVersion.js +132 -0
- package/dist/models/GetResourceSession.d.ts +30 -0
- package/dist/models/GetResourceSession.js +16 -0
- package/dist/models/GetResourceSessionDiagnostics.d.ts +76 -0
- package/dist/models/GetResourceSessionDiagnostics.js +76 -0
- package/dist/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
- package/dist/models/GetResourceSessionDiagnosticsCourseContext.js +83 -0
- package/dist/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
- package/dist/models/GetResourceSessionDiagnosticsResource.js +63 -0
- package/dist/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
- package/dist/models/GetResourceSessionDiagnosticsScormSummary.js +66 -0
- package/dist/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
- package/dist/models/GetResourceSessionDiagnosticsUser.js +54 -0
- package/dist/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
- package/dist/models/GetResourceSessionDiagnosticsVersion.js +74 -0
- package/dist/models/GetResourceSessionScormApiLogs.d.ts +57 -0
- package/dist/models/GetResourceSessionScormApiLogs.js +67 -0
- package/dist/models/GetResourceSessionScormData.d.ts +77 -0
- package/dist/models/GetResourceSessionScormData.js +73 -0
- package/dist/models/GetResourceSessionScormDataActivity.d.ts +44 -0
- package/dist/models/GetResourceSessionScormDataActivity.js +52 -0
- package/dist/models/LibraryQuizCriterion.d.ts +95 -0
- package/dist/models/LibraryQuizCriterion.js +84 -0
- package/dist/models/LibraryQuizQuestion.d.ts +70 -0
- package/dist/models/LibraryQuizQuestion.js +70 -0
- package/dist/models/LibraryQuizQuestionInput.d.ts +50 -0
- package/dist/models/LibraryQuizQuestionInput.js +58 -0
- package/dist/models/LibraryQuizSessionAnswerChoice.d.ts +51 -0
- package/dist/models/LibraryQuizSessionAnswerChoice.js +61 -0
- package/dist/models/LibraryQuizSessionQuestion.d.ts +96 -0
- package/dist/models/LibraryQuizSessionQuestion.js +92 -0
- package/dist/models/PostCourseLibraryQuizSession.d.ts +32 -0
- package/dist/models/PostCourseLibraryQuizSession.js +48 -0
- package/dist/models/PostLibraryQuiz.d.ts +107 -0
- package/dist/models/PostLibraryQuiz.js +77 -0
- package/dist/models/PostLibraryQuizSession.d.ts +32 -0
- package/dist/models/PostLibraryQuizSession.js +48 -0
- package/dist/models/PostLibraryQuizVersion.d.ts +32 -0
- package/dist/models/PostLibraryQuizVersion.js +48 -0
- package/dist/models/PutLibraryQuiz.d.ts +38 -0
- package/dist/models/PutLibraryQuiz.js +50 -0
- package/dist/models/PutLibraryQuizCriteria.d.ts +33 -0
- package/dist/models/PutLibraryQuizCriteria.js +51 -0
- package/dist/models/PutLibraryQuizQuestions.d.ts +33 -0
- package/dist/models/PutLibraryQuizQuestions.js +51 -0
- package/dist/models/PutLibraryQuizSessionAnswer.d.ts +40 -0
- package/dist/models/PutLibraryQuizSessionAnswer.js +52 -0
- package/dist/models/PutLibraryQuizSessionGrade.d.ts +38 -0
- package/dist/models/PutLibraryQuizSessionGrade.js +52 -0
- package/dist/models/PutLibraryQuizVersion.d.ts +101 -0
- package/dist/models/PutLibraryQuizVersion.js +71 -0
- package/dist/models/QuestionSelectionMethod.d.ts +25 -0
- package/dist/models/QuestionSelectionMethod.js +51 -0
- package/dist/models/ResourceSessionScormApiLogItem.d.ts +79 -0
- package/dist/models/ResourceSessionScormApiLogItem.js +81 -0
- package/dist/models/index.d.ts +34 -0
- package/dist/models/index.js +34 -0
- package/docs/ContentLibraryQuizApi.md +1780 -0
- package/docs/GetCourseVersionItem.md +2 -0
- package/docs/GetLibraryQuiz.md +62 -0
- package/docs/GetLibraryQuizAnalytics.md +46 -0
- package/docs/GetLibraryQuizList.md +42 -0
- package/docs/GetLibraryQuizResult.md +54 -0
- package/docs/GetLibraryQuizSession.md +78 -0
- package/docs/GetLibraryQuizSessionList.md +42 -0
- package/docs/GetLibraryQuizUsage.md +42 -0
- package/docs/GetLibraryQuizVersion.md +78 -0
- package/docs/GetResourceSession.md +10 -0
- package/docs/GetResourceSessionDiagnostics.md +47 -0
- package/docs/GetResourceSessionDiagnosticsCourseContext.md +50 -0
- package/docs/GetResourceSessionDiagnosticsResource.md +40 -0
- package/docs/GetResourceSessionDiagnosticsScormSummary.md +48 -0
- package/docs/GetResourceSessionDiagnosticsUser.md +36 -0
- package/docs/GetResourceSessionDiagnosticsVersion.md +52 -0
- package/docs/GetResourceSessionScormApiLogs.md +43 -0
- package/docs/GetResourceSessionScormData.md +49 -0
- package/docs/GetResourceSessionScormDataActivity.md +38 -0
- package/docs/LibraryQuizCriterion.md +48 -0
- package/docs/LibraryQuizQuestion.md +46 -0
- package/docs/LibraryQuizQuestionInput.md +40 -0
- package/docs/LibraryQuizSessionAnswerChoice.md +40 -0
- package/docs/LibraryQuizSessionQuestion.md +50 -0
- package/docs/PlayerApi.md +320 -3
- package/docs/PostCourseLibraryQuizSession.md +34 -0
- package/docs/PostLibraryQuiz.md +58 -0
- package/docs/PostLibraryQuizSession.md +34 -0
- package/docs/PostLibraryQuizVersion.md +34 -0
- package/docs/PutLibraryQuiz.md +36 -0
- package/docs/PutLibraryQuizCriteria.md +34 -0
- package/docs/PutLibraryQuizQuestions.md +34 -0
- package/docs/PutLibraryQuizSessionAnswer.md +36 -0
- package/docs/PutLibraryQuizSessionGrade.md +36 -0
- package/docs/PutLibraryQuizVersion.md +56 -0
- package/docs/QuestionSelectionMethod.md +32 -0
- package/docs/ResourceSessionScormApiLogItem.md +47 -0
- package/package.json +1 -1
- package/src/apis/ContentLibraryQuizApi.ts +1624 -0
- package/src/apis/PlayerApi.ts +351 -1
- package/src/apis/index.ts +1 -0
- package/src/models/GetCourseVersionItem.ts +17 -0
- package/src/models/GetLibraryQuiz.ts +207 -0
- package/src/models/GetLibraryQuizAnalytics.ts +120 -0
- package/src/models/GetLibraryQuizList.ts +110 -0
- package/src/models/GetLibraryQuizResult.ts +154 -0
- package/src/models/GetLibraryQuizSession.ts +286 -0
- package/src/models/GetLibraryQuizSessionList.ts +110 -0
- package/src/models/GetLibraryQuizUsage.ts +102 -0
- package/src/models/GetLibraryQuizVersion.ts +290 -0
- package/src/models/GetResourceSession.ts +43 -0
- package/src/models/GetResourceSessionDiagnostics.ts +161 -0
- package/src/models/GetResourceSessionDiagnosticsCourseContext.ts +148 -0
- package/src/models/GetResourceSessionDiagnosticsResource.ts +103 -0
- package/src/models/GetResourceSessionDiagnosticsScormSummary.ts +123 -0
- package/src/models/GetResourceSessionDiagnosticsUser.ts +75 -0
- package/src/models/GetResourceSessionDiagnosticsVersion.ts +141 -0
- package/src/models/GetResourceSessionScormApiLogs.ts +110 -0
- package/src/models/GetResourceSessionScormData.ts +134 -0
- package/src/models/GetResourceSessionScormDataActivity.ts +81 -0
- package/src/models/LibraryQuizCriterion.ts +147 -0
- package/src/models/LibraryQuizQuestion.ts +118 -0
- package/src/models/LibraryQuizQuestionInput.ts +91 -0
- package/src/models/LibraryQuizSessionAnswerChoice.ts +100 -0
- package/src/models/LibraryQuizSessionQuestion.ts +166 -0
- package/src/models/PostCourseLibraryQuizSession.ts +65 -0
- package/src/models/PostLibraryQuiz.ts +173 -0
- package/src/models/PostLibraryQuizSession.ts +65 -0
- package/src/models/PostLibraryQuizVersion.ts +65 -0
- package/src/models/PutLibraryQuiz.ts +73 -0
- package/src/models/PutLibraryQuizCriteria.ts +74 -0
- package/src/models/PutLibraryQuizQuestions.ts +74 -0
- package/src/models/PutLibraryQuizSessionAnswer.ts +74 -0
- package/src/models/PutLibraryQuizSessionGrade.ts +74 -0
- package/src/models/PutLibraryQuizVersion.ts +163 -0
- package/src/models/QuestionSelectionMethod.ts +53 -0
- package/src/models/ResourceSessionScormApiLogItem.ts +132 -0
- package/src/models/index.ts +34 -0
package/docs/PlayerApi.md
CHANGED
|
@@ -10,14 +10,18 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
10
10
|
| [**getFileAsset**](PlayerApi.md#getfileasset) | **GET** /file/{contentId}/asset | File asset |
|
|
11
11
|
| [**getFilePlayer**](PlayerApi.md#getfileplayer) | **GET** /file/session/{sessionId}/player | File player HTML page |
|
|
12
12
|
| [**getImagePlayer**](PlayerApi.md#getimageplayer) | **GET** /image/session/{sessionId}/player | Image player HTML page |
|
|
13
|
+
| [**getLibraryQuizSessionPlayer**](PlayerApi.md#getlibraryquizsessionplayer) | **GET** /quiz/sessions/{sessionId}/player | Serve the player for a reusable quiz session |
|
|
13
14
|
| [**getPdfAsset**](PlayerApi.md#getpdfasset) | **GET** /pdf/{contentId}/asset | PDF asset |
|
|
14
15
|
| [**getPdfPlayer**](PlayerApi.md#getpdfplayer) | **GET** /pdf/session/{sessionId}/player | PDF player HTML page |
|
|
15
16
|
| [**getQuizPlayer**](PlayerApi.md#getquizplayer) | **GET** /quiz/session/{sessionId}/player | Quiz player HTML page |
|
|
16
17
|
| [**getResourceScormValue**](PlayerApi.md#getresourcescormvalue) | **GET** /resource/sessions/{sessionId}/get-value | Read a CMI value from a reusable SCORM resource session |
|
|
17
18
|
| [**getResourceSession**](PlayerApi.md#getresourcesession) | **GET** /resource/sessions/{sessionId} | Get a resource session |
|
|
18
19
|
| [**getResourceSessionAsset**](PlayerApi.md#getresourcesessionasset) | **GET** /resource/sessions/{sessionId}/asset/{assetPath} | Stream an asset pinned to a resource session |
|
|
20
|
+
| [**getResourceSessionDiagnostics**](PlayerApi.md#getresourcesessiondiagnostics) | **GET** /resource/sessions/{sessionId}/diagnostics | Get administrator diagnostics for a resource session |
|
|
19
21
|
| [**getResourceSessionList**](PlayerApi.md#getresourcesessionlist) | **GET** /resource/sessions | List resource sessions for the selected portal |
|
|
20
22
|
| [**getResourceSessionPlayer**](PlayerApi.md#getresourcesessionplayer) | **GET** /resource/sessions/{sessionId}/player | Serve the player for a version-pinned reusable resource session |
|
|
23
|
+
| [**getResourceSessionScormApiLogs**](PlayerApi.md#getresourcesessionscormapilogs) | **GET** /resource/sessions/{sessionId}/api-logs | Get SCORM runtime logs for a resource session |
|
|
24
|
+
| [**getResourceSessionScormData**](PlayerApi.md#getresourcesessionscormdata) | **GET** /resource/sessions/{sessionId}/scorm-data | Get SCORM CMI data for a resource session |
|
|
21
25
|
| [**getScormAsset**](PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset |
|
|
22
26
|
| [**getScormPlayer**](PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page |
|
|
23
27
|
| [**getVideoAsset**](PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset |
|
|
@@ -434,6 +438,71 @@ No authorization required
|
|
|
434
438
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
435
439
|
|
|
436
440
|
|
|
441
|
+
## getLibraryQuizSessionPlayer
|
|
442
|
+
|
|
443
|
+
> string getLibraryQuizSessionPlayer(sessionId)
|
|
444
|
+
|
|
445
|
+
Serve the player for a reusable quiz session
|
|
446
|
+
|
|
447
|
+
### Example
|
|
448
|
+
|
|
449
|
+
```ts
|
|
450
|
+
import {
|
|
451
|
+
Configuration,
|
|
452
|
+
PlayerApi,
|
|
453
|
+
} from '@easyedu/js-lsm-api';
|
|
454
|
+
import type { GetLibraryQuizSessionPlayerRequest } from '@easyedu/js-lsm-api';
|
|
455
|
+
|
|
456
|
+
async function example() {
|
|
457
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
458
|
+
const api = new PlayerApi();
|
|
459
|
+
|
|
460
|
+
const body = {
|
|
461
|
+
// string
|
|
462
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
463
|
+
} satisfies GetLibraryQuizSessionPlayerRequest;
|
|
464
|
+
|
|
465
|
+
try {
|
|
466
|
+
const data = await api.getLibraryQuizSessionPlayer(body);
|
|
467
|
+
console.log(data);
|
|
468
|
+
} catch (error) {
|
|
469
|
+
console.error(error);
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
// Run the test
|
|
474
|
+
example().catch(console.error);
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
### Parameters
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
| Name | Type | Description | Notes |
|
|
481
|
+
|------------- | ------------- | ------------- | -------------|
|
|
482
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
483
|
+
|
|
484
|
+
### Return type
|
|
485
|
+
|
|
486
|
+
**string**
|
|
487
|
+
|
|
488
|
+
### Authorization
|
|
489
|
+
|
|
490
|
+
No authorization required
|
|
491
|
+
|
|
492
|
+
### HTTP request headers
|
|
493
|
+
|
|
494
|
+
- **Content-Type**: Not defined
|
|
495
|
+
- **Accept**: `text/html`
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
### HTTP response details
|
|
499
|
+
| Status code | Description | Response headers |
|
|
500
|
+
|-------------|-------------|------------------|
|
|
501
|
+
| **200** | Quiz player HTML | - |
|
|
502
|
+
|
|
503
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
504
|
+
|
|
505
|
+
|
|
437
506
|
## getPdfAsset
|
|
438
507
|
|
|
439
508
|
> getPdfAsset(contentId)
|
|
@@ -838,9 +907,75 @@ No authorization required
|
|
|
838
907
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
839
908
|
|
|
840
909
|
|
|
910
|
+
## getResourceSessionDiagnostics
|
|
911
|
+
|
|
912
|
+
> GetResourceSessionDiagnostics getResourceSessionDiagnostics(sessionId)
|
|
913
|
+
|
|
914
|
+
Get administrator diagnostics for a resource session
|
|
915
|
+
|
|
916
|
+
### Example
|
|
917
|
+
|
|
918
|
+
```ts
|
|
919
|
+
import {
|
|
920
|
+
Configuration,
|
|
921
|
+
PlayerApi,
|
|
922
|
+
} from '@easyedu/js-lsm-api';
|
|
923
|
+
import type { GetResourceSessionDiagnosticsRequest } from '@easyedu/js-lsm-api';
|
|
924
|
+
|
|
925
|
+
async function example() {
|
|
926
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
927
|
+
const api = new PlayerApi();
|
|
928
|
+
|
|
929
|
+
const body = {
|
|
930
|
+
// string
|
|
931
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
932
|
+
} satisfies GetResourceSessionDiagnosticsRequest;
|
|
933
|
+
|
|
934
|
+
try {
|
|
935
|
+
const data = await api.getResourceSessionDiagnostics(body);
|
|
936
|
+
console.log(data);
|
|
937
|
+
} catch (error) {
|
|
938
|
+
console.error(error);
|
|
939
|
+
}
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
// Run the test
|
|
943
|
+
example().catch(console.error);
|
|
944
|
+
```
|
|
945
|
+
|
|
946
|
+
### Parameters
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
| Name | Type | Description | Notes |
|
|
950
|
+
|------------- | ------------- | ------------- | -------------|
|
|
951
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
952
|
+
|
|
953
|
+
### Return type
|
|
954
|
+
|
|
955
|
+
[**GetResourceSessionDiagnostics**](GetResourceSessionDiagnostics.md)
|
|
956
|
+
|
|
957
|
+
### Authorization
|
|
958
|
+
|
|
959
|
+
No authorization required
|
|
960
|
+
|
|
961
|
+
### HTTP request headers
|
|
962
|
+
|
|
963
|
+
- **Content-Type**: Not defined
|
|
964
|
+
- **Accept**: `application/json`
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
### HTTP response details
|
|
968
|
+
| Status code | Description | Response headers |
|
|
969
|
+
|-------------|-------------|------------------|
|
|
970
|
+
| **200** | Resource session diagnostics | - |
|
|
971
|
+
| **404** | Resource session not found | - |
|
|
972
|
+
|
|
973
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
974
|
+
|
|
975
|
+
|
|
841
976
|
## getResourceSessionList
|
|
842
977
|
|
|
843
|
-
> GetResourceSessionList getResourceSessionList(userId, resourceId, versionId, courseId, environment, completionStatus, createdFrom, createdTo, page, pageSize)
|
|
978
|
+
> GetResourceSessionList getResourceSessionList(userId, resourceId, versionId, courseId, courseVersionId, itemId, resourceType, environment, completionStatus, gradeStatus, isCurrent, attemptNumber, createdFrom, createdTo, updatedFrom, updatedTo, hasScormErrors, sortBy, sortDirection, page, pageSize)
|
|
844
979
|
|
|
845
980
|
List resource sessions for the selected portal
|
|
846
981
|
|
|
@@ -866,15 +1001,37 @@ async function example() {
|
|
|
866
1001
|
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
867
1002
|
// string (optional)
|
|
868
1003
|
courseId: courseId_example,
|
|
1004
|
+
// string (optional)
|
|
1005
|
+
courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1006
|
+
// string (optional)
|
|
1007
|
+
itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1008
|
+
// ResourceType (optional)
|
|
1009
|
+
resourceType: ...,
|
|
869
1010
|
// ResourceSessionEnvironment (optional)
|
|
870
1011
|
environment: ...,
|
|
871
|
-
//
|
|
1012
|
+
// 'not_attempted' | 'in_progress' | 'completed' (optional)
|
|
872
1013
|
completionStatus: completionStatus_example,
|
|
1014
|
+
// 'ungraded' | 'passed' | 'failed' | 'points_earned' | 'percentage_earned' | 'not_applicable' (optional)
|
|
1015
|
+
gradeStatus: gradeStatus_example,
|
|
1016
|
+
// boolean (optional)
|
|
1017
|
+
isCurrent: true,
|
|
1018
|
+
// number (optional)
|
|
1019
|
+
attemptNumber: 56,
|
|
873
1020
|
// number (optional)
|
|
874
1021
|
createdFrom: 789,
|
|
875
1022
|
// number (optional)
|
|
876
1023
|
createdTo: 789,
|
|
877
1024
|
// number (optional)
|
|
1025
|
+
updatedFrom: 789,
|
|
1026
|
+
// number (optional)
|
|
1027
|
+
updatedTo: 789,
|
|
1028
|
+
// boolean (optional)
|
|
1029
|
+
hasScormErrors: true,
|
|
1030
|
+
// 'created_at' | 'updated_at' | 'attempt_number' (optional)
|
|
1031
|
+
sortBy: sortBy_example,
|
|
1032
|
+
// 'asc' | 'desc' (optional)
|
|
1033
|
+
sortDirection: sortDirection_example,
|
|
1034
|
+
// number (optional)
|
|
878
1035
|
page: 56,
|
|
879
1036
|
// number (optional)
|
|
880
1037
|
pageSize: 56,
|
|
@@ -901,10 +1058,21 @@ example().catch(console.error);
|
|
|
901
1058
|
| **resourceId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
902
1059
|
| **versionId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
903
1060
|
| **courseId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1061
|
+
| **courseVersionId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1062
|
+
| **itemId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1063
|
+
| **resourceType** | `ResourceType` | | [Optional] [Defaults to `undefined`] [Enum: scorm, video, audio, image, pdf, powerpoint, file, link, rich_text] |
|
|
904
1064
|
| **environment** | `ResourceSessionEnvironment` | | [Optional] [Defaults to `undefined`] [Enum: live, demo] |
|
|
905
|
-
| **completionStatus** | `
|
|
1065
|
+
| **completionStatus** | `not_attempted`, `in_progress`, `completed` | | [Optional] [Defaults to `undefined`] [Enum: not_attempted, in_progress, completed] |
|
|
1066
|
+
| **gradeStatus** | `ungraded`, `passed`, `failed`, `points_earned`, `percentage_earned`, `not_applicable` | | [Optional] [Defaults to `undefined`] [Enum: ungraded, passed, failed, points_earned, percentage_earned, not_applicable] |
|
|
1067
|
+
| **isCurrent** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1068
|
+
| **attemptNumber** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
906
1069
|
| **createdFrom** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
907
1070
|
| **createdTo** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1071
|
+
| **updatedFrom** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1072
|
+
| **updatedTo** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1073
|
+
| **hasScormErrors** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1074
|
+
| **sortBy** | `created_at`, `updated_at`, `attempt_number` | | [Optional] [Defaults to `'updated_at'`] [Enum: created_at, updated_at, attempt_number] |
|
|
1075
|
+
| **sortDirection** | `asc`, `desc` | | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
|
|
908
1076
|
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
909
1077
|
| **pageSize** | `number` | | [Optional] [Defaults to `20`] |
|
|
910
1078
|
|
|
@@ -996,6 +1164,155 @@ No authorization required
|
|
|
996
1164
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
997
1165
|
|
|
998
1166
|
|
|
1167
|
+
## getResourceSessionScormApiLogs
|
|
1168
|
+
|
|
1169
|
+
> GetResourceSessionScormApiLogs getResourceSessionScormApiLogs(sessionId, method, element, errorsOnly, page, pageSize)
|
|
1170
|
+
|
|
1171
|
+
Get SCORM runtime logs for a resource session
|
|
1172
|
+
|
|
1173
|
+
### Example
|
|
1174
|
+
|
|
1175
|
+
```ts
|
|
1176
|
+
import {
|
|
1177
|
+
Configuration,
|
|
1178
|
+
PlayerApi,
|
|
1179
|
+
} from '@easyedu/js-lsm-api';
|
|
1180
|
+
import type { GetResourceSessionScormApiLogsRequest } from '@easyedu/js-lsm-api';
|
|
1181
|
+
|
|
1182
|
+
async function example() {
|
|
1183
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1184
|
+
const api = new PlayerApi();
|
|
1185
|
+
|
|
1186
|
+
const body = {
|
|
1187
|
+
// string
|
|
1188
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1189
|
+
// 'Initialize' | 'GetValue' | 'SetValue' | 'Commit' | 'Terminate' (optional)
|
|
1190
|
+
method: method_example,
|
|
1191
|
+
// string (optional)
|
|
1192
|
+
element: element_example,
|
|
1193
|
+
// boolean (optional)
|
|
1194
|
+
errorsOnly: true,
|
|
1195
|
+
// number (optional)
|
|
1196
|
+
page: 56,
|
|
1197
|
+
// number (optional)
|
|
1198
|
+
pageSize: 56,
|
|
1199
|
+
} satisfies GetResourceSessionScormApiLogsRequest;
|
|
1200
|
+
|
|
1201
|
+
try {
|
|
1202
|
+
const data = await api.getResourceSessionScormApiLogs(body);
|
|
1203
|
+
console.log(data);
|
|
1204
|
+
} catch (error) {
|
|
1205
|
+
console.error(error);
|
|
1206
|
+
}
|
|
1207
|
+
}
|
|
1208
|
+
|
|
1209
|
+
// Run the test
|
|
1210
|
+
example().catch(console.error);
|
|
1211
|
+
```
|
|
1212
|
+
|
|
1213
|
+
### Parameters
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
| Name | Type | Description | Notes |
|
|
1217
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1218
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1219
|
+
| **method** | `Initialize`, `GetValue`, `SetValue`, `Commit`, `Terminate` | | [Optional] [Defaults to `undefined`] [Enum: Initialize, GetValue, SetValue, Commit, Terminate] |
|
|
1220
|
+
| **element** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1221
|
+
| **errorsOnly** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
1222
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
1223
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `50`] |
|
|
1224
|
+
|
|
1225
|
+
### Return type
|
|
1226
|
+
|
|
1227
|
+
[**GetResourceSessionScormApiLogs**](GetResourceSessionScormApiLogs.md)
|
|
1228
|
+
|
|
1229
|
+
### Authorization
|
|
1230
|
+
|
|
1231
|
+
No authorization required
|
|
1232
|
+
|
|
1233
|
+
### HTTP request headers
|
|
1234
|
+
|
|
1235
|
+
- **Content-Type**: Not defined
|
|
1236
|
+
- **Accept**: `application/json`
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
### HTTP response details
|
|
1240
|
+
| Status code | Description | Response headers |
|
|
1241
|
+
|-------------|-------------|------------------|
|
|
1242
|
+
| **200** | Resource session SCORM runtime logs | - |
|
|
1243
|
+
| **400** | Resource session is not SCORM | - |
|
|
1244
|
+
| **404** | Resource session not found | - |
|
|
1245
|
+
|
|
1246
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
## getResourceSessionScormData
|
|
1250
|
+
|
|
1251
|
+
> GetResourceSessionScormData getResourceSessionScormData(sessionId)
|
|
1252
|
+
|
|
1253
|
+
Get SCORM CMI data for a resource session
|
|
1254
|
+
|
|
1255
|
+
### Example
|
|
1256
|
+
|
|
1257
|
+
```ts
|
|
1258
|
+
import {
|
|
1259
|
+
Configuration,
|
|
1260
|
+
PlayerApi,
|
|
1261
|
+
} from '@easyedu/js-lsm-api';
|
|
1262
|
+
import type { GetResourceSessionScormDataRequest } from '@easyedu/js-lsm-api';
|
|
1263
|
+
|
|
1264
|
+
async function example() {
|
|
1265
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1266
|
+
const api = new PlayerApi();
|
|
1267
|
+
|
|
1268
|
+
const body = {
|
|
1269
|
+
// string
|
|
1270
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1271
|
+
} satisfies GetResourceSessionScormDataRequest;
|
|
1272
|
+
|
|
1273
|
+
try {
|
|
1274
|
+
const data = await api.getResourceSessionScormData(body);
|
|
1275
|
+
console.log(data);
|
|
1276
|
+
} catch (error) {
|
|
1277
|
+
console.error(error);
|
|
1278
|
+
}
|
|
1279
|
+
}
|
|
1280
|
+
|
|
1281
|
+
// Run the test
|
|
1282
|
+
example().catch(console.error);
|
|
1283
|
+
```
|
|
1284
|
+
|
|
1285
|
+
### Parameters
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
| Name | Type | Description | Notes |
|
|
1289
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1290
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1291
|
+
|
|
1292
|
+
### Return type
|
|
1293
|
+
|
|
1294
|
+
[**GetResourceSessionScormData**](GetResourceSessionScormData.md)
|
|
1295
|
+
|
|
1296
|
+
### Authorization
|
|
1297
|
+
|
|
1298
|
+
No authorization required
|
|
1299
|
+
|
|
1300
|
+
### HTTP request headers
|
|
1301
|
+
|
|
1302
|
+
- **Content-Type**: Not defined
|
|
1303
|
+
- **Accept**: `application/json`
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
### HTTP response details
|
|
1307
|
+
| Status code | Description | Response headers |
|
|
1308
|
+
|-------------|-------------|------------------|
|
|
1309
|
+
| **200** | Resource session SCORM data | - |
|
|
1310
|
+
| **400** | Resource session is not SCORM | - |
|
|
1311
|
+
| **404** | Resource session not found | - |
|
|
1312
|
+
|
|
1313
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1314
|
+
|
|
1315
|
+
|
|
999
1316
|
## getScormAsset
|
|
1000
1317
|
|
|
1001
1318
|
> getScormAsset(contentId, assetPath)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PostCourseLibraryQuizSession
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`retake` | boolean
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PostCourseLibraryQuizSession } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"retake": null,
|
|
19
|
+
} satisfies PostCourseLibraryQuizSession
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostCourseLibraryQuizSession
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
|
|
2
|
+
# PostLibraryQuiz
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`description` | string
|
|
11
|
+
`questionSelectionMethod` | [QuestionSelectionMethod](QuestionSelectionMethod.md)
|
|
12
|
+
`maxQuestions` | number
|
|
13
|
+
`passingScore` | number
|
|
14
|
+
`timeLimitMinutes` | number
|
|
15
|
+
`randomizeQuestions` | boolean
|
|
16
|
+
`randomizeAnswers` | boolean
|
|
17
|
+
`showResults` | boolean
|
|
18
|
+
`showCorrectAnswers` | boolean
|
|
19
|
+
`allowReview` | boolean
|
|
20
|
+
`requireAllQuestions` | boolean
|
|
21
|
+
`settings` | { [key: string]: any; }
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import type { PostLibraryQuiz } from '@easyedu/js-lsm-api'
|
|
27
|
+
|
|
28
|
+
// TODO: Update the object below with actual values
|
|
29
|
+
const example = {
|
|
30
|
+
"name": null,
|
|
31
|
+
"description": null,
|
|
32
|
+
"questionSelectionMethod": null,
|
|
33
|
+
"maxQuestions": null,
|
|
34
|
+
"passingScore": null,
|
|
35
|
+
"timeLimitMinutes": null,
|
|
36
|
+
"randomizeQuestions": null,
|
|
37
|
+
"randomizeAnswers": null,
|
|
38
|
+
"showResults": null,
|
|
39
|
+
"showCorrectAnswers": null,
|
|
40
|
+
"allowReview": null,
|
|
41
|
+
"requireAllQuestions": null,
|
|
42
|
+
"settings": null,
|
|
43
|
+
} satisfies PostLibraryQuiz
|
|
44
|
+
|
|
45
|
+
console.log(example)
|
|
46
|
+
|
|
47
|
+
// Convert the instance to a JSON string
|
|
48
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
49
|
+
console.log(exampleJSON)
|
|
50
|
+
|
|
51
|
+
// Parse the JSON string back to an object
|
|
52
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostLibraryQuiz
|
|
53
|
+
console.log(exampleParsed)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
57
|
+
|
|
58
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PostLibraryQuizSession
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`restart` | boolean
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PostLibraryQuizSession } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"restart": null,
|
|
19
|
+
} satisfies PostLibraryQuizSession
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostLibraryQuizSession
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PostLibraryQuizVersion
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`changeNotes` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PostLibraryQuizVersion } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"changeNotes": null,
|
|
19
|
+
} satisfies PostLibraryQuizVersion
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostLibraryQuizVersion
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PutLibraryQuiz
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`description` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PutLibraryQuiz } from '@easyedu/js-lsm-api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"name": null,
|
|
20
|
+
"description": null,
|
|
21
|
+
} satisfies PutLibraryQuiz
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutLibraryQuiz
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PutLibraryQuizCriteria
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`criteria` | [Array<LibraryQuizCriterion>](LibraryQuizCriterion.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PutLibraryQuizCriteria } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"criteria": null,
|
|
19
|
+
} satisfies PutLibraryQuizCriteria
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutLibraryQuizCriteria
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PutLibraryQuizQuestions
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`questions` | [Array<LibraryQuizQuestionInput>](LibraryQuizQuestionInput.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PutLibraryQuizQuestions } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"questions": null,
|
|
19
|
+
} satisfies PutLibraryQuizQuestions
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutLibraryQuizQuestions
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PutLibraryQuizSessionAnswer
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`answer` | { [key: string]: any; }
|
|
10
|
+
`autoSave` | boolean
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PutLibraryQuizSessionAnswer } from '@easyedu/js-lsm-api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"answer": null,
|
|
20
|
+
"autoSave": null,
|
|
21
|
+
} satisfies PutLibraryQuizSessionAnswer
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutLibraryQuizSessionAnswer
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|