@easyedu/js-lsm-api 1.91.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 +50 -0
- package/README.md +52 -2
- package/dist/apis/ContentLibraryQuizApi.d.ts +451 -0
- package/dist/apis/ContentLibraryQuizApi.js +1162 -0
- package/dist/apis/PlayerApi.d.ts +15 -0
- package/dist/apis/PlayerApi.js +44 -0
- 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 +15 -0
- package/dist/esm/apis/PlayerApi.js +44 -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/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/index.d.ts +24 -0
- package/dist/esm/models/index.js +24 -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/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/index.d.ts +24 -0
- package/dist/models/index.js +24 -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/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 +66 -0
- 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/package.json +1 -1
- package/src/apis/ContentLibraryQuizApi.ts +1624 -0
- package/src/apis/PlayerApi.ts +53 -0
- 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/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/index.ts +24 -0
|
@@ -0,0 +1,1780 @@
|
|
|
1
|
+
# ContentLibraryQuizApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**deleteLibraryQuizVersion**](ContentLibraryQuizApi.md#deletelibraryquizversion) | **DELETE** /content-library/quizzes/{quizId}/versions/{versionId} | Discard an unreferenced draft quiz version |
|
|
8
|
+
| [**getLibraryQuiz**](ContentLibraryQuizApi.md#getlibraryquiz) | **GET** /content-library/quizzes/{quizId} | Get a reusable quiz and version history |
|
|
9
|
+
| [**getLibraryQuizAnalytics**](ContentLibraryQuizApi.md#getlibraryquizanalytics) | **GET** /content-library/quizzes/{quizId}/analytics | Get live attempt analytics for a reusable quiz |
|
|
10
|
+
| [**getLibraryQuizCriteria**](ContentLibraryQuizApi.md#getlibraryquizcriteria) | **GET** /content-library/quizzes/{quizId}/versions/{versionId}/criteria | Get question-selection criteria for a quiz version |
|
|
11
|
+
| [**getLibraryQuizList**](ContentLibraryQuizApi.md#getlibraryquizlist) | **GET** /content-library/quizzes | List reusable quizzes |
|
|
12
|
+
| [**getLibraryQuizQuestions**](ContentLibraryQuizApi.md#getlibraryquizquestions) | **GET** /content-library/quizzes/{quizId}/versions/{versionId}/questions | Get manual questions or the published criteria pool |
|
|
13
|
+
| [**getLibraryQuizSession**](ContentLibraryQuizApi.md#getlibraryquizsession) | **GET** /quiz/sessions/{sessionId} | Get a reusable quiz session |
|
|
14
|
+
| [**getLibraryQuizSessionList**](ContentLibraryQuizApi.md#getlibraryquizsessionlist) | **GET** /quiz/sessions | List reusable quiz sessions in the selected portal |
|
|
15
|
+
| [**getLibraryQuizSessionResults**](ContentLibraryQuizApi.md#getlibraryquizsessionresults) | **GET** /quiz/sessions/{sessionId}/results | Get reusable quiz session results |
|
|
16
|
+
| [**getLibraryQuizUsage**](ContentLibraryQuizApi.md#getlibraryquizusage) | **GET** /content-library/quizzes/{quizId}/usage | Get course and learner usage for a reusable quiz |
|
|
17
|
+
| [**getLibraryQuizVersion**](ContentLibraryQuizApi.md#getlibraryquizversion) | **GET** /content-library/quizzes/{quizId}/versions/{versionId} | Get a reusable quiz version |
|
|
18
|
+
| [**postCourseLibraryQuizSession**](ContentLibraryQuizApi.md#postcourselibraryquizsession) | **POST** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/quiz-sessions | Start or resume a live attempt for a course-pinned quiz version |
|
|
19
|
+
| [**postLibraryQuiz**](ContentLibraryQuizApi.md#postlibraryquiz) | **POST** /content-library/quizzes | Create a reusable quiz and its first draft version |
|
|
20
|
+
| [**postLibraryQuizArchive**](ContentLibraryQuizApi.md#postlibraryquizarchive) | **POST** /content-library/quizzes/{quizId}/archive | Archive a reusable quiz |
|
|
21
|
+
| [**postLibraryQuizSession**](ContentLibraryQuizApi.md#postlibraryquizsession) | **POST** /content-library/quizzes/{quizId}/versions/{versionId}/sessions | Start or resume a sandbox attempt for an exact quiz version |
|
|
22
|
+
| [**postLibraryQuizSessionSubmit**](ContentLibraryQuizApi.md#postlibraryquizsessionsubmit) | **POST** /quiz/sessions/{sessionId}/submit | Submit and grade a reusable quiz session |
|
|
23
|
+
| [**postLibraryQuizVersion**](ContentLibraryQuizApi.md#postlibraryquizversion) | **POST** /content-library/quizzes/{quizId}/versions | Create the next draft quiz version |
|
|
24
|
+
| [**postLibraryQuizVersionArchive**](ContentLibraryQuizApi.md#postlibraryquizversionarchive) | **POST** /content-library/quizzes/{quizId}/versions/{versionId}/archive | Archive a published reusable quiz version |
|
|
25
|
+
| [**postLibraryQuizVersionPublish**](ContentLibraryQuizApi.md#postlibraryquizversionpublish) | **POST** /content-library/quizzes/{quizId}/versions/{versionId}/publish | Publish an immutable reusable quiz version |
|
|
26
|
+
| [**putLibraryQuiz**](ContentLibraryQuizApi.md#putlibraryquiz) | **PUT** /content-library/quizzes/{quizId} | Update reusable quiz library metadata |
|
|
27
|
+
| [**putLibraryQuizCriteria**](ContentLibraryQuizApi.md#putlibraryquizcriteria) | **PUT** /content-library/quizzes/{quizId}/versions/{versionId}/criteria | Replace question-selection criteria on a draft quiz version |
|
|
28
|
+
| [**putLibraryQuizQuestions**](ContentLibraryQuizApi.md#putlibraryquizquestions) | **PUT** /content-library/quizzes/{quizId}/versions/{versionId}/questions | Replace manual questions on a draft quiz version |
|
|
29
|
+
| [**putLibraryQuizSessionAnswer**](ContentLibraryQuizApi.md#putlibraryquizsessionanswer) | **PUT** /quiz/sessions/{sessionId}/answers/{sessionQuestionId} | Save an answer using version-snapshot identifiers |
|
|
30
|
+
| [**putLibraryQuizSessionGrade**](ContentLibraryQuizApi.md#putlibraryquizsessiongrade) | **PUT** /quiz/sessions/{sessionId}/answers/{sessionQuestionId}/grade | Manually grade a reusable quiz session answer |
|
|
31
|
+
| [**putLibraryQuizVersion**](ContentLibraryQuizApi.md#putlibraryquizversion) | **PUT** /content-library/quizzes/{quizId}/versions/{versionId} | Edit a draft reusable quiz version |
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
## deleteLibraryQuizVersion
|
|
36
|
+
|
|
37
|
+
> deleteLibraryQuizVersion(quizId, versionId)
|
|
38
|
+
|
|
39
|
+
Discard an unreferenced draft quiz version
|
|
40
|
+
|
|
41
|
+
### Example
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
import {
|
|
45
|
+
Configuration,
|
|
46
|
+
ContentLibraryQuizApi,
|
|
47
|
+
} from '@easyedu/js-lsm-api';
|
|
48
|
+
import type { DeleteLibraryQuizVersionRequest } from '@easyedu/js-lsm-api';
|
|
49
|
+
|
|
50
|
+
async function example() {
|
|
51
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
52
|
+
const api = new ContentLibraryQuizApi();
|
|
53
|
+
|
|
54
|
+
const body = {
|
|
55
|
+
// string
|
|
56
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
57
|
+
// string
|
|
58
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
59
|
+
} satisfies DeleteLibraryQuizVersionRequest;
|
|
60
|
+
|
|
61
|
+
try {
|
|
62
|
+
const data = await api.deleteLibraryQuizVersion(body);
|
|
63
|
+
console.log(data);
|
|
64
|
+
} catch (error) {
|
|
65
|
+
console.error(error);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// Run the test
|
|
70
|
+
example().catch(console.error);
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
| Name | Type | Description | Notes |
|
|
77
|
+
|------------- | ------------- | ------------- | -------------|
|
|
78
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
79
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
80
|
+
|
|
81
|
+
### Return type
|
|
82
|
+
|
|
83
|
+
`void` (Empty response body)
|
|
84
|
+
|
|
85
|
+
### Authorization
|
|
86
|
+
|
|
87
|
+
No authorization required
|
|
88
|
+
|
|
89
|
+
### HTTP request headers
|
|
90
|
+
|
|
91
|
+
- **Content-Type**: Not defined
|
|
92
|
+
- **Accept**: Not defined
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
### HTTP response details
|
|
96
|
+
| Status code | Description | Response headers |
|
|
97
|
+
|-------------|-------------|------------------|
|
|
98
|
+
| **204** | Draft discarded | - |
|
|
99
|
+
| **409** | Only unreferenced drafts may be discarded | - |
|
|
100
|
+
|
|
101
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
## getLibraryQuiz
|
|
105
|
+
|
|
106
|
+
> GetLibraryQuiz getLibraryQuiz(quizId)
|
|
107
|
+
|
|
108
|
+
Get a reusable quiz and version history
|
|
109
|
+
|
|
110
|
+
### Example
|
|
111
|
+
|
|
112
|
+
```ts
|
|
113
|
+
import {
|
|
114
|
+
Configuration,
|
|
115
|
+
ContentLibraryQuizApi,
|
|
116
|
+
} from '@easyedu/js-lsm-api';
|
|
117
|
+
import type { GetLibraryQuizRequest } from '@easyedu/js-lsm-api';
|
|
118
|
+
|
|
119
|
+
async function example() {
|
|
120
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
121
|
+
const api = new ContentLibraryQuizApi();
|
|
122
|
+
|
|
123
|
+
const body = {
|
|
124
|
+
// string
|
|
125
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
126
|
+
} satisfies GetLibraryQuizRequest;
|
|
127
|
+
|
|
128
|
+
try {
|
|
129
|
+
const data = await api.getLibraryQuiz(body);
|
|
130
|
+
console.log(data);
|
|
131
|
+
} catch (error) {
|
|
132
|
+
console.error(error);
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
// Run the test
|
|
137
|
+
example().catch(console.error);
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Parameters
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
| Name | Type | Description | Notes |
|
|
144
|
+
|------------- | ------------- | ------------- | -------------|
|
|
145
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
146
|
+
|
|
147
|
+
### Return type
|
|
148
|
+
|
|
149
|
+
[**GetLibraryQuiz**](GetLibraryQuiz.md)
|
|
150
|
+
|
|
151
|
+
### Authorization
|
|
152
|
+
|
|
153
|
+
No authorization required
|
|
154
|
+
|
|
155
|
+
### HTTP request headers
|
|
156
|
+
|
|
157
|
+
- **Content-Type**: Not defined
|
|
158
|
+
- **Accept**: `application/json`
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### HTTP response details
|
|
162
|
+
| Status code | Description | Response headers |
|
|
163
|
+
|-------------|-------------|------------------|
|
|
164
|
+
| **200** | Reusable quiz | - |
|
|
165
|
+
| **404** | Quiz not found | - |
|
|
166
|
+
|
|
167
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
## getLibraryQuizAnalytics
|
|
171
|
+
|
|
172
|
+
> GetLibraryQuizAnalytics getLibraryQuizAnalytics(quizId, courseId, courseVersionId, itemId)
|
|
173
|
+
|
|
174
|
+
Get live attempt analytics for a reusable quiz
|
|
175
|
+
|
|
176
|
+
### Example
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
import {
|
|
180
|
+
Configuration,
|
|
181
|
+
ContentLibraryQuizApi,
|
|
182
|
+
} from '@easyedu/js-lsm-api';
|
|
183
|
+
import type { GetLibraryQuizAnalyticsRequest } from '@easyedu/js-lsm-api';
|
|
184
|
+
|
|
185
|
+
async function example() {
|
|
186
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
187
|
+
const api = new ContentLibraryQuizApi();
|
|
188
|
+
|
|
189
|
+
const body = {
|
|
190
|
+
// string
|
|
191
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
192
|
+
// string (optional)
|
|
193
|
+
courseId: courseId_example,
|
|
194
|
+
// string (optional)
|
|
195
|
+
courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
196
|
+
// string (optional)
|
|
197
|
+
itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
198
|
+
} satisfies GetLibraryQuizAnalyticsRequest;
|
|
199
|
+
|
|
200
|
+
try {
|
|
201
|
+
const data = await api.getLibraryQuizAnalytics(body);
|
|
202
|
+
console.log(data);
|
|
203
|
+
} catch (error) {
|
|
204
|
+
console.error(error);
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
// Run the test
|
|
209
|
+
example().catch(console.error);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
| Name | Type | Description | Notes |
|
|
216
|
+
|------------- | ------------- | ------------- | -------------|
|
|
217
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
218
|
+
| **courseId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
219
|
+
| **courseVersionId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
220
|
+
| **itemId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
221
|
+
|
|
222
|
+
### Return type
|
|
223
|
+
|
|
224
|
+
[**GetLibraryQuizAnalytics**](GetLibraryQuizAnalytics.md)
|
|
225
|
+
|
|
226
|
+
### Authorization
|
|
227
|
+
|
|
228
|
+
No authorization required
|
|
229
|
+
|
|
230
|
+
### HTTP request headers
|
|
231
|
+
|
|
232
|
+
- **Content-Type**: Not defined
|
|
233
|
+
- **Accept**: `application/json`
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
### HTTP response details
|
|
237
|
+
| Status code | Description | Response headers |
|
|
238
|
+
|-------------|-------------|------------------|
|
|
239
|
+
| **200** | Quiz analytics | - |
|
|
240
|
+
|
|
241
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
## getLibraryQuizCriteria
|
|
245
|
+
|
|
246
|
+
> Array<LibraryQuizCriterion> getLibraryQuizCriteria(quizId, versionId)
|
|
247
|
+
|
|
248
|
+
Get question-selection criteria for a quiz version
|
|
249
|
+
|
|
250
|
+
### Example
|
|
251
|
+
|
|
252
|
+
```ts
|
|
253
|
+
import {
|
|
254
|
+
Configuration,
|
|
255
|
+
ContentLibraryQuizApi,
|
|
256
|
+
} from '@easyedu/js-lsm-api';
|
|
257
|
+
import type { GetLibraryQuizCriteriaRequest } from '@easyedu/js-lsm-api';
|
|
258
|
+
|
|
259
|
+
async function example() {
|
|
260
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
261
|
+
const api = new ContentLibraryQuizApi();
|
|
262
|
+
|
|
263
|
+
const body = {
|
|
264
|
+
// string
|
|
265
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
266
|
+
// string
|
|
267
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
268
|
+
} satisfies GetLibraryQuizCriteriaRequest;
|
|
269
|
+
|
|
270
|
+
try {
|
|
271
|
+
const data = await api.getLibraryQuizCriteria(body);
|
|
272
|
+
console.log(data);
|
|
273
|
+
} catch (error) {
|
|
274
|
+
console.error(error);
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
// Run the test
|
|
279
|
+
example().catch(console.error);
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### Parameters
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
| Name | Type | Description | Notes |
|
|
286
|
+
|------------- | ------------- | ------------- | -------------|
|
|
287
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
288
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
289
|
+
|
|
290
|
+
### Return type
|
|
291
|
+
|
|
292
|
+
[**Array<LibraryQuizCriterion>**](LibraryQuizCriterion.md)
|
|
293
|
+
|
|
294
|
+
### Authorization
|
|
295
|
+
|
|
296
|
+
No authorization required
|
|
297
|
+
|
|
298
|
+
### HTTP request headers
|
|
299
|
+
|
|
300
|
+
- **Content-Type**: Not defined
|
|
301
|
+
- **Accept**: `application/json`
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
### HTTP response details
|
|
305
|
+
| Status code | Description | Response headers |
|
|
306
|
+
|-------------|-------------|------------------|
|
|
307
|
+
| **200** | Quiz version criteria | - |
|
|
308
|
+
|
|
309
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
## getLibraryQuizList
|
|
313
|
+
|
|
314
|
+
> GetLibraryQuizList getLibraryQuizList(search, includeArchived, page, pageSize)
|
|
315
|
+
|
|
316
|
+
List reusable quizzes
|
|
317
|
+
|
|
318
|
+
### Example
|
|
319
|
+
|
|
320
|
+
```ts
|
|
321
|
+
import {
|
|
322
|
+
Configuration,
|
|
323
|
+
ContentLibraryQuizApi,
|
|
324
|
+
} from '@easyedu/js-lsm-api';
|
|
325
|
+
import type { GetLibraryQuizListRequest } from '@easyedu/js-lsm-api';
|
|
326
|
+
|
|
327
|
+
async function example() {
|
|
328
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
329
|
+
const api = new ContentLibraryQuizApi();
|
|
330
|
+
|
|
331
|
+
const body = {
|
|
332
|
+
// string (optional)
|
|
333
|
+
search: search_example,
|
|
334
|
+
// boolean (optional)
|
|
335
|
+
includeArchived: true,
|
|
336
|
+
// number (optional)
|
|
337
|
+
page: 56,
|
|
338
|
+
// number (optional)
|
|
339
|
+
pageSize: 56,
|
|
340
|
+
} satisfies GetLibraryQuizListRequest;
|
|
341
|
+
|
|
342
|
+
try {
|
|
343
|
+
const data = await api.getLibraryQuizList(body);
|
|
344
|
+
console.log(data);
|
|
345
|
+
} catch (error) {
|
|
346
|
+
console.error(error);
|
|
347
|
+
}
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
// Run the test
|
|
351
|
+
example().catch(console.error);
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
### Parameters
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
| Name | Type | Description | Notes |
|
|
358
|
+
|------------- | ------------- | ------------- | -------------|
|
|
359
|
+
| **search** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
360
|
+
| **includeArchived** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
361
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
362
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `20`] |
|
|
363
|
+
|
|
364
|
+
### Return type
|
|
365
|
+
|
|
366
|
+
[**GetLibraryQuizList**](GetLibraryQuizList.md)
|
|
367
|
+
|
|
368
|
+
### Authorization
|
|
369
|
+
|
|
370
|
+
No authorization required
|
|
371
|
+
|
|
372
|
+
### HTTP request headers
|
|
373
|
+
|
|
374
|
+
- **Content-Type**: Not defined
|
|
375
|
+
- **Accept**: `application/json`
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
### HTTP response details
|
|
379
|
+
| Status code | Description | Response headers |
|
|
380
|
+
|-------------|-------------|------------------|
|
|
381
|
+
| **200** | Reusable quizzes | - |
|
|
382
|
+
|
|
383
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
## getLibraryQuizQuestions
|
|
387
|
+
|
|
388
|
+
> Array<LibraryQuizQuestion> getLibraryQuizQuestions(quizId, versionId)
|
|
389
|
+
|
|
390
|
+
Get manual questions or the published criteria pool
|
|
391
|
+
|
|
392
|
+
### Example
|
|
393
|
+
|
|
394
|
+
```ts
|
|
395
|
+
import {
|
|
396
|
+
Configuration,
|
|
397
|
+
ContentLibraryQuizApi,
|
|
398
|
+
} from '@easyedu/js-lsm-api';
|
|
399
|
+
import type { GetLibraryQuizQuestionsRequest } from '@easyedu/js-lsm-api';
|
|
400
|
+
|
|
401
|
+
async function example() {
|
|
402
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
403
|
+
const api = new ContentLibraryQuizApi();
|
|
404
|
+
|
|
405
|
+
const body = {
|
|
406
|
+
// string
|
|
407
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
408
|
+
// string
|
|
409
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
410
|
+
} satisfies GetLibraryQuizQuestionsRequest;
|
|
411
|
+
|
|
412
|
+
try {
|
|
413
|
+
const data = await api.getLibraryQuizQuestions(body);
|
|
414
|
+
console.log(data);
|
|
415
|
+
} catch (error) {
|
|
416
|
+
console.error(error);
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
// Run the test
|
|
421
|
+
example().catch(console.error);
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### Parameters
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
| Name | Type | Description | Notes |
|
|
428
|
+
|------------- | ------------- | ------------- | -------------|
|
|
429
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
430
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
431
|
+
|
|
432
|
+
### Return type
|
|
433
|
+
|
|
434
|
+
[**Array<LibraryQuizQuestion>**](LibraryQuizQuestion.md)
|
|
435
|
+
|
|
436
|
+
### Authorization
|
|
437
|
+
|
|
438
|
+
No authorization required
|
|
439
|
+
|
|
440
|
+
### HTTP request headers
|
|
441
|
+
|
|
442
|
+
- **Content-Type**: Not defined
|
|
443
|
+
- **Accept**: `application/json`
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
### HTTP response details
|
|
447
|
+
| Status code | Description | Response headers |
|
|
448
|
+
|-------------|-------------|------------------|
|
|
449
|
+
| **200** | Quiz version questions | - |
|
|
450
|
+
|
|
451
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
## getLibraryQuizSession
|
|
455
|
+
|
|
456
|
+
> GetLibraryQuizSession getLibraryQuizSession(sessionId)
|
|
457
|
+
|
|
458
|
+
Get a reusable quiz session
|
|
459
|
+
|
|
460
|
+
### Example
|
|
461
|
+
|
|
462
|
+
```ts
|
|
463
|
+
import {
|
|
464
|
+
Configuration,
|
|
465
|
+
ContentLibraryQuizApi,
|
|
466
|
+
} from '@easyedu/js-lsm-api';
|
|
467
|
+
import type { GetLibraryQuizSessionRequest } from '@easyedu/js-lsm-api';
|
|
468
|
+
|
|
469
|
+
async function example() {
|
|
470
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
471
|
+
const api = new ContentLibraryQuizApi();
|
|
472
|
+
|
|
473
|
+
const body = {
|
|
474
|
+
// string
|
|
475
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
476
|
+
} satisfies GetLibraryQuizSessionRequest;
|
|
477
|
+
|
|
478
|
+
try {
|
|
479
|
+
const data = await api.getLibraryQuizSession(body);
|
|
480
|
+
console.log(data);
|
|
481
|
+
} catch (error) {
|
|
482
|
+
console.error(error);
|
|
483
|
+
}
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
// Run the test
|
|
487
|
+
example().catch(console.error);
|
|
488
|
+
```
|
|
489
|
+
|
|
490
|
+
### Parameters
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
| Name | Type | Description | Notes |
|
|
494
|
+
|------------- | ------------- | ------------- | -------------|
|
|
495
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
496
|
+
|
|
497
|
+
### Return type
|
|
498
|
+
|
|
499
|
+
[**GetLibraryQuizSession**](GetLibraryQuizSession.md)
|
|
500
|
+
|
|
501
|
+
### Authorization
|
|
502
|
+
|
|
503
|
+
No authorization required
|
|
504
|
+
|
|
505
|
+
### HTTP request headers
|
|
506
|
+
|
|
507
|
+
- **Content-Type**: Not defined
|
|
508
|
+
- **Accept**: `application/json`
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
### HTTP response details
|
|
512
|
+
| Status code | Description | Response headers |
|
|
513
|
+
|-------------|-------------|------------------|
|
|
514
|
+
| **200** | Quiz session | - |
|
|
515
|
+
|
|
516
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
## getLibraryQuizSessionList
|
|
520
|
+
|
|
521
|
+
> GetLibraryQuizSessionList getLibraryQuizSessionList(userId, quizId, quizVersionId, courseId, courseVersionId, itemId, environment, status, page, pageSize)
|
|
522
|
+
|
|
523
|
+
List reusable quiz sessions in the selected portal
|
|
524
|
+
|
|
525
|
+
### Example
|
|
526
|
+
|
|
527
|
+
```ts
|
|
528
|
+
import {
|
|
529
|
+
Configuration,
|
|
530
|
+
ContentLibraryQuizApi,
|
|
531
|
+
} from '@easyedu/js-lsm-api';
|
|
532
|
+
import type { GetLibraryQuizSessionListRequest } from '@easyedu/js-lsm-api';
|
|
533
|
+
|
|
534
|
+
async function example() {
|
|
535
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
536
|
+
const api = new ContentLibraryQuizApi();
|
|
537
|
+
|
|
538
|
+
const body = {
|
|
539
|
+
// string (optional)
|
|
540
|
+
userId: userId_example,
|
|
541
|
+
// string (optional)
|
|
542
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
543
|
+
// string (optional)
|
|
544
|
+
quizVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
545
|
+
// string (optional)
|
|
546
|
+
courseId: courseId_example,
|
|
547
|
+
// string (optional)
|
|
548
|
+
courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
549
|
+
// string (optional)
|
|
550
|
+
itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
551
|
+
// ResourceSessionEnvironment (optional)
|
|
552
|
+
environment: ...,
|
|
553
|
+
// string (optional)
|
|
554
|
+
status: status_example,
|
|
555
|
+
// number (optional)
|
|
556
|
+
page: 56,
|
|
557
|
+
// number (optional)
|
|
558
|
+
pageSize: 56,
|
|
559
|
+
} satisfies GetLibraryQuizSessionListRequest;
|
|
560
|
+
|
|
561
|
+
try {
|
|
562
|
+
const data = await api.getLibraryQuizSessionList(body);
|
|
563
|
+
console.log(data);
|
|
564
|
+
} catch (error) {
|
|
565
|
+
console.error(error);
|
|
566
|
+
}
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
// Run the test
|
|
570
|
+
example().catch(console.error);
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
### Parameters
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
| Name | Type | Description | Notes |
|
|
577
|
+
|------------- | ------------- | ------------- | -------------|
|
|
578
|
+
| **userId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
579
|
+
| **quizId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
580
|
+
| **quizVersionId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
581
|
+
| **courseId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
582
|
+
| **courseVersionId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
583
|
+
| **itemId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
584
|
+
| **environment** | `ResourceSessionEnvironment` | | [Optional] [Defaults to `undefined`] [Enum: live, demo] |
|
|
585
|
+
| **status** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
586
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
587
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `20`] |
|
|
588
|
+
|
|
589
|
+
### Return type
|
|
590
|
+
|
|
591
|
+
[**GetLibraryQuizSessionList**](GetLibraryQuizSessionList.md)
|
|
592
|
+
|
|
593
|
+
### Authorization
|
|
594
|
+
|
|
595
|
+
No authorization required
|
|
596
|
+
|
|
597
|
+
### HTTP request headers
|
|
598
|
+
|
|
599
|
+
- **Content-Type**: Not defined
|
|
600
|
+
- **Accept**: `application/json`
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
### HTTP response details
|
|
604
|
+
| Status code | Description | Response headers |
|
|
605
|
+
|-------------|-------------|------------------|
|
|
606
|
+
| **200** | Quiz sessions | - |
|
|
607
|
+
|
|
608
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
## getLibraryQuizSessionResults
|
|
612
|
+
|
|
613
|
+
> GetLibraryQuizResult getLibraryQuizSessionResults(sessionId)
|
|
614
|
+
|
|
615
|
+
Get reusable quiz session results
|
|
616
|
+
|
|
617
|
+
### Example
|
|
618
|
+
|
|
619
|
+
```ts
|
|
620
|
+
import {
|
|
621
|
+
Configuration,
|
|
622
|
+
ContentLibraryQuizApi,
|
|
623
|
+
} from '@easyedu/js-lsm-api';
|
|
624
|
+
import type { GetLibraryQuizSessionResultsRequest } from '@easyedu/js-lsm-api';
|
|
625
|
+
|
|
626
|
+
async function example() {
|
|
627
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
628
|
+
const api = new ContentLibraryQuizApi();
|
|
629
|
+
|
|
630
|
+
const body = {
|
|
631
|
+
// string
|
|
632
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
633
|
+
} satisfies GetLibraryQuizSessionResultsRequest;
|
|
634
|
+
|
|
635
|
+
try {
|
|
636
|
+
const data = await api.getLibraryQuizSessionResults(body);
|
|
637
|
+
console.log(data);
|
|
638
|
+
} catch (error) {
|
|
639
|
+
console.error(error);
|
|
640
|
+
}
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
// Run the test
|
|
644
|
+
example().catch(console.error);
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
### Parameters
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
| Name | Type | Description | Notes |
|
|
651
|
+
|------------- | ------------- | ------------- | -------------|
|
|
652
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
653
|
+
|
|
654
|
+
### Return type
|
|
655
|
+
|
|
656
|
+
[**GetLibraryQuizResult**](GetLibraryQuizResult.md)
|
|
657
|
+
|
|
658
|
+
### Authorization
|
|
659
|
+
|
|
660
|
+
No authorization required
|
|
661
|
+
|
|
662
|
+
### HTTP request headers
|
|
663
|
+
|
|
664
|
+
- **Content-Type**: Not defined
|
|
665
|
+
- **Accept**: `application/json`
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
### HTTP response details
|
|
669
|
+
| Status code | Description | Response headers |
|
|
670
|
+
|-------------|-------------|------------------|
|
|
671
|
+
| **200** | Quiz result | - |
|
|
672
|
+
|
|
673
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
## getLibraryQuizUsage
|
|
677
|
+
|
|
678
|
+
> GetLibraryQuizUsage getLibraryQuizUsage(quizId)
|
|
679
|
+
|
|
680
|
+
Get course and learner usage for a reusable quiz
|
|
681
|
+
|
|
682
|
+
### Example
|
|
683
|
+
|
|
684
|
+
```ts
|
|
685
|
+
import {
|
|
686
|
+
Configuration,
|
|
687
|
+
ContentLibraryQuizApi,
|
|
688
|
+
} from '@easyedu/js-lsm-api';
|
|
689
|
+
import type { GetLibraryQuizUsageRequest } from '@easyedu/js-lsm-api';
|
|
690
|
+
|
|
691
|
+
async function example() {
|
|
692
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
693
|
+
const api = new ContentLibraryQuizApi();
|
|
694
|
+
|
|
695
|
+
const body = {
|
|
696
|
+
// string
|
|
697
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
698
|
+
} satisfies GetLibraryQuizUsageRequest;
|
|
699
|
+
|
|
700
|
+
try {
|
|
701
|
+
const data = await api.getLibraryQuizUsage(body);
|
|
702
|
+
console.log(data);
|
|
703
|
+
} catch (error) {
|
|
704
|
+
console.error(error);
|
|
705
|
+
}
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
// Run the test
|
|
709
|
+
example().catch(console.error);
|
|
710
|
+
```
|
|
711
|
+
|
|
712
|
+
### Parameters
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
| Name | Type | Description | Notes |
|
|
716
|
+
|------------- | ------------- | ------------- | -------------|
|
|
717
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
718
|
+
|
|
719
|
+
### Return type
|
|
720
|
+
|
|
721
|
+
[**GetLibraryQuizUsage**](GetLibraryQuizUsage.md)
|
|
722
|
+
|
|
723
|
+
### Authorization
|
|
724
|
+
|
|
725
|
+
No authorization required
|
|
726
|
+
|
|
727
|
+
### HTTP request headers
|
|
728
|
+
|
|
729
|
+
- **Content-Type**: Not defined
|
|
730
|
+
- **Accept**: `application/json`
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
### HTTP response details
|
|
734
|
+
| Status code | Description | Response headers |
|
|
735
|
+
|-------------|-------------|------------------|
|
|
736
|
+
| **200** | Quiz usage | - |
|
|
737
|
+
|
|
738
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
## getLibraryQuizVersion
|
|
742
|
+
|
|
743
|
+
> GetLibraryQuizVersion getLibraryQuizVersion(quizId, versionId)
|
|
744
|
+
|
|
745
|
+
Get a reusable quiz version
|
|
746
|
+
|
|
747
|
+
### Example
|
|
748
|
+
|
|
749
|
+
```ts
|
|
750
|
+
import {
|
|
751
|
+
Configuration,
|
|
752
|
+
ContentLibraryQuizApi,
|
|
753
|
+
} from '@easyedu/js-lsm-api';
|
|
754
|
+
import type { GetLibraryQuizVersionRequest } from '@easyedu/js-lsm-api';
|
|
755
|
+
|
|
756
|
+
async function example() {
|
|
757
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
758
|
+
const api = new ContentLibraryQuizApi();
|
|
759
|
+
|
|
760
|
+
const body = {
|
|
761
|
+
// string
|
|
762
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
763
|
+
// string
|
|
764
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
765
|
+
} satisfies GetLibraryQuizVersionRequest;
|
|
766
|
+
|
|
767
|
+
try {
|
|
768
|
+
const data = await api.getLibraryQuizVersion(body);
|
|
769
|
+
console.log(data);
|
|
770
|
+
} catch (error) {
|
|
771
|
+
console.error(error);
|
|
772
|
+
}
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
// Run the test
|
|
776
|
+
example().catch(console.error);
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### Parameters
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
| Name | Type | Description | Notes |
|
|
783
|
+
|------------- | ------------- | ------------- | -------------|
|
|
784
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
785
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
786
|
+
|
|
787
|
+
### Return type
|
|
788
|
+
|
|
789
|
+
[**GetLibraryQuizVersion**](GetLibraryQuizVersion.md)
|
|
790
|
+
|
|
791
|
+
### Authorization
|
|
792
|
+
|
|
793
|
+
No authorization required
|
|
794
|
+
|
|
795
|
+
### HTTP request headers
|
|
796
|
+
|
|
797
|
+
- **Content-Type**: Not defined
|
|
798
|
+
- **Accept**: `application/json`
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
### HTTP response details
|
|
802
|
+
| Status code | Description | Response headers |
|
|
803
|
+
|-------------|-------------|------------------|
|
|
804
|
+
| **200** | Quiz version | - |
|
|
805
|
+
|
|
806
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
## postCourseLibraryQuizSession
|
|
810
|
+
|
|
811
|
+
> GetLibraryQuizSession postCourseLibraryQuizSession(courseId, courseVersionId, itemId, postCourseLibraryQuizSession)
|
|
812
|
+
|
|
813
|
+
Start or resume a live attempt for a course-pinned quiz version
|
|
814
|
+
|
|
815
|
+
### Example
|
|
816
|
+
|
|
817
|
+
```ts
|
|
818
|
+
import {
|
|
819
|
+
Configuration,
|
|
820
|
+
ContentLibraryQuizApi,
|
|
821
|
+
} from '@easyedu/js-lsm-api';
|
|
822
|
+
import type { PostCourseLibraryQuizSessionRequest } from '@easyedu/js-lsm-api';
|
|
823
|
+
|
|
824
|
+
async function example() {
|
|
825
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
826
|
+
const api = new ContentLibraryQuizApi();
|
|
827
|
+
|
|
828
|
+
const body = {
|
|
829
|
+
// string
|
|
830
|
+
courseId: courseId_example,
|
|
831
|
+
// string
|
|
832
|
+
courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
833
|
+
// string
|
|
834
|
+
itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
835
|
+
// PostCourseLibraryQuizSession (optional)
|
|
836
|
+
postCourseLibraryQuizSession: ...,
|
|
837
|
+
} satisfies PostCourseLibraryQuizSessionRequest;
|
|
838
|
+
|
|
839
|
+
try {
|
|
840
|
+
const data = await api.postCourseLibraryQuizSession(body);
|
|
841
|
+
console.log(data);
|
|
842
|
+
} catch (error) {
|
|
843
|
+
console.error(error);
|
|
844
|
+
}
|
|
845
|
+
}
|
|
846
|
+
|
|
847
|
+
// Run the test
|
|
848
|
+
example().catch(console.error);
|
|
849
|
+
```
|
|
850
|
+
|
|
851
|
+
### Parameters
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
| Name | Type | Description | Notes |
|
|
855
|
+
|------------- | ------------- | ------------- | -------------|
|
|
856
|
+
| **courseId** | `string` | | [Defaults to `undefined`] |
|
|
857
|
+
| **courseVersionId** | `string` | | [Defaults to `undefined`] |
|
|
858
|
+
| **itemId** | `string` | | [Defaults to `undefined`] |
|
|
859
|
+
| **postCourseLibraryQuizSession** | [PostCourseLibraryQuizSession](PostCourseLibraryQuizSession.md) | | [Optional] |
|
|
860
|
+
|
|
861
|
+
### Return type
|
|
862
|
+
|
|
863
|
+
[**GetLibraryQuizSession**](GetLibraryQuizSession.md)
|
|
864
|
+
|
|
865
|
+
### Authorization
|
|
866
|
+
|
|
867
|
+
No authorization required
|
|
868
|
+
|
|
869
|
+
### HTTP request headers
|
|
870
|
+
|
|
871
|
+
- **Content-Type**: `application/json`
|
|
872
|
+
- **Accept**: `application/json`
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
### HTTP response details
|
|
876
|
+
| Status code | Description | Response headers |
|
|
877
|
+
|-------------|-------------|------------------|
|
|
878
|
+
| **200** | Current or newly created live quiz session | - |
|
|
879
|
+
| **403** | Learner is not assigned to the pinned course version | - |
|
|
880
|
+
| **409** | Maximum attempts reached | - |
|
|
881
|
+
|
|
882
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
## postLibraryQuiz
|
|
886
|
+
|
|
887
|
+
> GetLibraryQuiz postLibraryQuiz(postLibraryQuiz)
|
|
888
|
+
|
|
889
|
+
Create a reusable quiz and its first draft version
|
|
890
|
+
|
|
891
|
+
### Example
|
|
892
|
+
|
|
893
|
+
```ts
|
|
894
|
+
import {
|
|
895
|
+
Configuration,
|
|
896
|
+
ContentLibraryQuizApi,
|
|
897
|
+
} from '@easyedu/js-lsm-api';
|
|
898
|
+
import type { PostLibraryQuizRequest } from '@easyedu/js-lsm-api';
|
|
899
|
+
|
|
900
|
+
async function example() {
|
|
901
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
902
|
+
const api = new ContentLibraryQuizApi();
|
|
903
|
+
|
|
904
|
+
const body = {
|
|
905
|
+
// PostLibraryQuiz
|
|
906
|
+
postLibraryQuiz: ...,
|
|
907
|
+
} satisfies PostLibraryQuizRequest;
|
|
908
|
+
|
|
909
|
+
try {
|
|
910
|
+
const data = await api.postLibraryQuiz(body);
|
|
911
|
+
console.log(data);
|
|
912
|
+
} catch (error) {
|
|
913
|
+
console.error(error);
|
|
914
|
+
}
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
// Run the test
|
|
918
|
+
example().catch(console.error);
|
|
919
|
+
```
|
|
920
|
+
|
|
921
|
+
### Parameters
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
| Name | Type | Description | Notes |
|
|
925
|
+
|------------- | ------------- | ------------- | -------------|
|
|
926
|
+
| **postLibraryQuiz** | [PostLibraryQuiz](PostLibraryQuiz.md) | | |
|
|
927
|
+
|
|
928
|
+
### Return type
|
|
929
|
+
|
|
930
|
+
[**GetLibraryQuiz**](GetLibraryQuiz.md)
|
|
931
|
+
|
|
932
|
+
### Authorization
|
|
933
|
+
|
|
934
|
+
No authorization required
|
|
935
|
+
|
|
936
|
+
### HTTP request headers
|
|
937
|
+
|
|
938
|
+
- **Content-Type**: `application/json`
|
|
939
|
+
- **Accept**: `application/json`
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
### HTTP response details
|
|
943
|
+
| Status code | Description | Response headers |
|
|
944
|
+
|-------------|-------------|------------------|
|
|
945
|
+
| **201** | Reusable quiz created | - |
|
|
946
|
+
| **400** | Invalid quiz | - |
|
|
947
|
+
|
|
948
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
## postLibraryQuizArchive
|
|
952
|
+
|
|
953
|
+
> GetLibraryQuiz postLibraryQuizArchive(quizId)
|
|
954
|
+
|
|
955
|
+
Archive a reusable quiz
|
|
956
|
+
|
|
957
|
+
### Example
|
|
958
|
+
|
|
959
|
+
```ts
|
|
960
|
+
import {
|
|
961
|
+
Configuration,
|
|
962
|
+
ContentLibraryQuizApi,
|
|
963
|
+
} from '@easyedu/js-lsm-api';
|
|
964
|
+
import type { PostLibraryQuizArchiveRequest } from '@easyedu/js-lsm-api';
|
|
965
|
+
|
|
966
|
+
async function example() {
|
|
967
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
968
|
+
const api = new ContentLibraryQuizApi();
|
|
969
|
+
|
|
970
|
+
const body = {
|
|
971
|
+
// string
|
|
972
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
973
|
+
} satisfies PostLibraryQuizArchiveRequest;
|
|
974
|
+
|
|
975
|
+
try {
|
|
976
|
+
const data = await api.postLibraryQuizArchive(body);
|
|
977
|
+
console.log(data);
|
|
978
|
+
} catch (error) {
|
|
979
|
+
console.error(error);
|
|
980
|
+
}
|
|
981
|
+
}
|
|
982
|
+
|
|
983
|
+
// Run the test
|
|
984
|
+
example().catch(console.error);
|
|
985
|
+
```
|
|
986
|
+
|
|
987
|
+
### Parameters
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
| Name | Type | Description | Notes |
|
|
991
|
+
|------------- | ------------- | ------------- | -------------|
|
|
992
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
993
|
+
|
|
994
|
+
### Return type
|
|
995
|
+
|
|
996
|
+
[**GetLibraryQuiz**](GetLibraryQuiz.md)
|
|
997
|
+
|
|
998
|
+
### Authorization
|
|
999
|
+
|
|
1000
|
+
No authorization required
|
|
1001
|
+
|
|
1002
|
+
### HTTP request headers
|
|
1003
|
+
|
|
1004
|
+
- **Content-Type**: Not defined
|
|
1005
|
+
- **Accept**: `application/json`
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
### HTTP response details
|
|
1009
|
+
| Status code | Description | Response headers |
|
|
1010
|
+
|-------------|-------------|------------------|
|
|
1011
|
+
| **200** | Archived quiz | - |
|
|
1012
|
+
|
|
1013
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
## postLibraryQuizSession
|
|
1017
|
+
|
|
1018
|
+
> GetLibraryQuizSession postLibraryQuizSession(quizId, versionId, postLibraryQuizSession)
|
|
1019
|
+
|
|
1020
|
+
Start or resume a sandbox attempt for an exact quiz version
|
|
1021
|
+
|
|
1022
|
+
### Example
|
|
1023
|
+
|
|
1024
|
+
```ts
|
|
1025
|
+
import {
|
|
1026
|
+
Configuration,
|
|
1027
|
+
ContentLibraryQuizApi,
|
|
1028
|
+
} from '@easyedu/js-lsm-api';
|
|
1029
|
+
import type { PostLibraryQuizSessionRequest } from '@easyedu/js-lsm-api';
|
|
1030
|
+
|
|
1031
|
+
async function example() {
|
|
1032
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1033
|
+
const api = new ContentLibraryQuizApi();
|
|
1034
|
+
|
|
1035
|
+
const body = {
|
|
1036
|
+
// string
|
|
1037
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1038
|
+
// string
|
|
1039
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1040
|
+
// PostLibraryQuizSession (optional)
|
|
1041
|
+
postLibraryQuizSession: ...,
|
|
1042
|
+
} satisfies PostLibraryQuizSessionRequest;
|
|
1043
|
+
|
|
1044
|
+
try {
|
|
1045
|
+
const data = await api.postLibraryQuizSession(body);
|
|
1046
|
+
console.log(data);
|
|
1047
|
+
} catch (error) {
|
|
1048
|
+
console.error(error);
|
|
1049
|
+
}
|
|
1050
|
+
}
|
|
1051
|
+
|
|
1052
|
+
// Run the test
|
|
1053
|
+
example().catch(console.error);
|
|
1054
|
+
```
|
|
1055
|
+
|
|
1056
|
+
### Parameters
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
| Name | Type | Description | Notes |
|
|
1060
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1061
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1062
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
1063
|
+
| **postLibraryQuizSession** | [PostLibraryQuizSession](PostLibraryQuizSession.md) | | [Optional] |
|
|
1064
|
+
|
|
1065
|
+
### Return type
|
|
1066
|
+
|
|
1067
|
+
[**GetLibraryQuizSession**](GetLibraryQuizSession.md)
|
|
1068
|
+
|
|
1069
|
+
### Authorization
|
|
1070
|
+
|
|
1071
|
+
No authorization required
|
|
1072
|
+
|
|
1073
|
+
### HTTP request headers
|
|
1074
|
+
|
|
1075
|
+
- **Content-Type**: `application/json`
|
|
1076
|
+
- **Accept**: `application/json`
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
### HTTP response details
|
|
1080
|
+
| Status code | Description | Response headers |
|
|
1081
|
+
|-------------|-------------|------------------|
|
|
1082
|
+
| **200** | Current or newly restarted sandbox quiz session | - |
|
|
1083
|
+
| **404** | Quiz version not found | - |
|
|
1084
|
+
|
|
1085
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
## postLibraryQuizSessionSubmit
|
|
1089
|
+
|
|
1090
|
+
> GetLibraryQuizResult postLibraryQuizSessionSubmit(sessionId)
|
|
1091
|
+
|
|
1092
|
+
Submit and grade a reusable quiz session
|
|
1093
|
+
|
|
1094
|
+
### Example
|
|
1095
|
+
|
|
1096
|
+
```ts
|
|
1097
|
+
import {
|
|
1098
|
+
Configuration,
|
|
1099
|
+
ContentLibraryQuizApi,
|
|
1100
|
+
} from '@easyedu/js-lsm-api';
|
|
1101
|
+
import type { PostLibraryQuizSessionSubmitRequest } from '@easyedu/js-lsm-api';
|
|
1102
|
+
|
|
1103
|
+
async function example() {
|
|
1104
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1105
|
+
const api = new ContentLibraryQuizApi();
|
|
1106
|
+
|
|
1107
|
+
const body = {
|
|
1108
|
+
// string
|
|
1109
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1110
|
+
} satisfies PostLibraryQuizSessionSubmitRequest;
|
|
1111
|
+
|
|
1112
|
+
try {
|
|
1113
|
+
const data = await api.postLibraryQuizSessionSubmit(body);
|
|
1114
|
+
console.log(data);
|
|
1115
|
+
} catch (error) {
|
|
1116
|
+
console.error(error);
|
|
1117
|
+
}
|
|
1118
|
+
}
|
|
1119
|
+
|
|
1120
|
+
// Run the test
|
|
1121
|
+
example().catch(console.error);
|
|
1122
|
+
```
|
|
1123
|
+
|
|
1124
|
+
### Parameters
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
| Name | Type | Description | Notes |
|
|
1128
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1129
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1130
|
+
|
|
1131
|
+
### Return type
|
|
1132
|
+
|
|
1133
|
+
[**GetLibraryQuizResult**](GetLibraryQuizResult.md)
|
|
1134
|
+
|
|
1135
|
+
### Authorization
|
|
1136
|
+
|
|
1137
|
+
No authorization required
|
|
1138
|
+
|
|
1139
|
+
### HTTP request headers
|
|
1140
|
+
|
|
1141
|
+
- **Content-Type**: Not defined
|
|
1142
|
+
- **Accept**: `application/json`
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
### HTTP response details
|
|
1146
|
+
| Status code | Description | Response headers |
|
|
1147
|
+
|-------------|-------------|------------------|
|
|
1148
|
+
| **200** | Quiz result | - |
|
|
1149
|
+
|
|
1150
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
## postLibraryQuizVersion
|
|
1154
|
+
|
|
1155
|
+
> GetLibraryQuizVersion postLibraryQuizVersion(quizId, postLibraryQuizVersion)
|
|
1156
|
+
|
|
1157
|
+
Create the next draft quiz version
|
|
1158
|
+
|
|
1159
|
+
### Example
|
|
1160
|
+
|
|
1161
|
+
```ts
|
|
1162
|
+
import {
|
|
1163
|
+
Configuration,
|
|
1164
|
+
ContentLibraryQuizApi,
|
|
1165
|
+
} from '@easyedu/js-lsm-api';
|
|
1166
|
+
import type { PostLibraryQuizVersionRequest } from '@easyedu/js-lsm-api';
|
|
1167
|
+
|
|
1168
|
+
async function example() {
|
|
1169
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1170
|
+
const api = new ContentLibraryQuizApi();
|
|
1171
|
+
|
|
1172
|
+
const body = {
|
|
1173
|
+
// string
|
|
1174
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1175
|
+
// PostLibraryQuizVersion (optional)
|
|
1176
|
+
postLibraryQuizVersion: ...,
|
|
1177
|
+
} satisfies PostLibraryQuizVersionRequest;
|
|
1178
|
+
|
|
1179
|
+
try {
|
|
1180
|
+
const data = await api.postLibraryQuizVersion(body);
|
|
1181
|
+
console.log(data);
|
|
1182
|
+
} catch (error) {
|
|
1183
|
+
console.error(error);
|
|
1184
|
+
}
|
|
1185
|
+
}
|
|
1186
|
+
|
|
1187
|
+
// Run the test
|
|
1188
|
+
example().catch(console.error);
|
|
1189
|
+
```
|
|
1190
|
+
|
|
1191
|
+
### Parameters
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
| Name | Type | Description | Notes |
|
|
1195
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1196
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1197
|
+
| **postLibraryQuizVersion** | [PostLibraryQuizVersion](PostLibraryQuizVersion.md) | | [Optional] |
|
|
1198
|
+
|
|
1199
|
+
### Return type
|
|
1200
|
+
|
|
1201
|
+
[**GetLibraryQuizVersion**](GetLibraryQuizVersion.md)
|
|
1202
|
+
|
|
1203
|
+
### Authorization
|
|
1204
|
+
|
|
1205
|
+
No authorization required
|
|
1206
|
+
|
|
1207
|
+
### HTTP request headers
|
|
1208
|
+
|
|
1209
|
+
- **Content-Type**: `application/json`
|
|
1210
|
+
- **Accept**: `application/json`
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
### HTTP response details
|
|
1214
|
+
| Status code | Description | Response headers |
|
|
1215
|
+
|-------------|-------------|------------------|
|
|
1216
|
+
| **201** | Draft quiz version created | - |
|
|
1217
|
+
| **409** | Quiz already has a draft | - |
|
|
1218
|
+
|
|
1219
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
## postLibraryQuizVersionArchive
|
|
1223
|
+
|
|
1224
|
+
> GetLibraryQuizVersion postLibraryQuizVersionArchive(quizId, versionId)
|
|
1225
|
+
|
|
1226
|
+
Archive a published reusable quiz version
|
|
1227
|
+
|
|
1228
|
+
### Example
|
|
1229
|
+
|
|
1230
|
+
```ts
|
|
1231
|
+
import {
|
|
1232
|
+
Configuration,
|
|
1233
|
+
ContentLibraryQuizApi,
|
|
1234
|
+
} from '@easyedu/js-lsm-api';
|
|
1235
|
+
import type { PostLibraryQuizVersionArchiveRequest } from '@easyedu/js-lsm-api';
|
|
1236
|
+
|
|
1237
|
+
async function example() {
|
|
1238
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1239
|
+
const api = new ContentLibraryQuizApi();
|
|
1240
|
+
|
|
1241
|
+
const body = {
|
|
1242
|
+
// string
|
|
1243
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1244
|
+
// string
|
|
1245
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1246
|
+
} satisfies PostLibraryQuizVersionArchiveRequest;
|
|
1247
|
+
|
|
1248
|
+
try {
|
|
1249
|
+
const data = await api.postLibraryQuizVersionArchive(body);
|
|
1250
|
+
console.log(data);
|
|
1251
|
+
} catch (error) {
|
|
1252
|
+
console.error(error);
|
|
1253
|
+
}
|
|
1254
|
+
}
|
|
1255
|
+
|
|
1256
|
+
// Run the test
|
|
1257
|
+
example().catch(console.error);
|
|
1258
|
+
```
|
|
1259
|
+
|
|
1260
|
+
### Parameters
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
| Name | Type | Description | Notes |
|
|
1264
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1265
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1266
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
1267
|
+
|
|
1268
|
+
### Return type
|
|
1269
|
+
|
|
1270
|
+
[**GetLibraryQuizVersion**](GetLibraryQuizVersion.md)
|
|
1271
|
+
|
|
1272
|
+
### Authorization
|
|
1273
|
+
|
|
1274
|
+
No authorization required
|
|
1275
|
+
|
|
1276
|
+
### HTTP request headers
|
|
1277
|
+
|
|
1278
|
+
- **Content-Type**: Not defined
|
|
1279
|
+
- **Accept**: `application/json`
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
### HTTP response details
|
|
1283
|
+
| Status code | Description | Response headers |
|
|
1284
|
+
|-------------|-------------|------------------|
|
|
1285
|
+
| **200** | Archived quiz version | - |
|
|
1286
|
+
|
|
1287
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
## postLibraryQuizVersionPublish
|
|
1291
|
+
|
|
1292
|
+
> GetLibraryQuizVersion postLibraryQuizVersionPublish(quizId, versionId)
|
|
1293
|
+
|
|
1294
|
+
Publish an immutable reusable quiz version
|
|
1295
|
+
|
|
1296
|
+
### Example
|
|
1297
|
+
|
|
1298
|
+
```ts
|
|
1299
|
+
import {
|
|
1300
|
+
Configuration,
|
|
1301
|
+
ContentLibraryQuizApi,
|
|
1302
|
+
} from '@easyedu/js-lsm-api';
|
|
1303
|
+
import type { PostLibraryQuizVersionPublishRequest } from '@easyedu/js-lsm-api';
|
|
1304
|
+
|
|
1305
|
+
async function example() {
|
|
1306
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1307
|
+
const api = new ContentLibraryQuizApi();
|
|
1308
|
+
|
|
1309
|
+
const body = {
|
|
1310
|
+
// string
|
|
1311
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1312
|
+
// string
|
|
1313
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1314
|
+
} satisfies PostLibraryQuizVersionPublishRequest;
|
|
1315
|
+
|
|
1316
|
+
try {
|
|
1317
|
+
const data = await api.postLibraryQuizVersionPublish(body);
|
|
1318
|
+
console.log(data);
|
|
1319
|
+
} catch (error) {
|
|
1320
|
+
console.error(error);
|
|
1321
|
+
}
|
|
1322
|
+
}
|
|
1323
|
+
|
|
1324
|
+
// Run the test
|
|
1325
|
+
example().catch(console.error);
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
### Parameters
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
| Name | Type | Description | Notes |
|
|
1332
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1333
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1334
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
1335
|
+
|
|
1336
|
+
### Return type
|
|
1337
|
+
|
|
1338
|
+
[**GetLibraryQuizVersion**](GetLibraryQuizVersion.md)
|
|
1339
|
+
|
|
1340
|
+
### Authorization
|
|
1341
|
+
|
|
1342
|
+
No authorization required
|
|
1343
|
+
|
|
1344
|
+
### HTTP request headers
|
|
1345
|
+
|
|
1346
|
+
- **Content-Type**: Not defined
|
|
1347
|
+
- **Accept**: `application/json`
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
### HTTP response details
|
|
1351
|
+
| Status code | Description | Response headers |
|
|
1352
|
+
|-------------|-------------|------------------|
|
|
1353
|
+
| **200** | Published quiz version | - |
|
|
1354
|
+
|
|
1355
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
## putLibraryQuiz
|
|
1359
|
+
|
|
1360
|
+
> GetLibraryQuiz putLibraryQuiz(quizId, putLibraryQuiz)
|
|
1361
|
+
|
|
1362
|
+
Update reusable quiz library metadata
|
|
1363
|
+
|
|
1364
|
+
### Example
|
|
1365
|
+
|
|
1366
|
+
```ts
|
|
1367
|
+
import {
|
|
1368
|
+
Configuration,
|
|
1369
|
+
ContentLibraryQuizApi,
|
|
1370
|
+
} from '@easyedu/js-lsm-api';
|
|
1371
|
+
import type { PutLibraryQuizRequest } from '@easyedu/js-lsm-api';
|
|
1372
|
+
|
|
1373
|
+
async function example() {
|
|
1374
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1375
|
+
const api = new ContentLibraryQuizApi();
|
|
1376
|
+
|
|
1377
|
+
const body = {
|
|
1378
|
+
// string
|
|
1379
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1380
|
+
// PutLibraryQuiz
|
|
1381
|
+
putLibraryQuiz: ...,
|
|
1382
|
+
} satisfies PutLibraryQuizRequest;
|
|
1383
|
+
|
|
1384
|
+
try {
|
|
1385
|
+
const data = await api.putLibraryQuiz(body);
|
|
1386
|
+
console.log(data);
|
|
1387
|
+
} catch (error) {
|
|
1388
|
+
console.error(error);
|
|
1389
|
+
}
|
|
1390
|
+
}
|
|
1391
|
+
|
|
1392
|
+
// Run the test
|
|
1393
|
+
example().catch(console.error);
|
|
1394
|
+
```
|
|
1395
|
+
|
|
1396
|
+
### Parameters
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
| Name | Type | Description | Notes |
|
|
1400
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1401
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1402
|
+
| **putLibraryQuiz** | [PutLibraryQuiz](PutLibraryQuiz.md) | | |
|
|
1403
|
+
|
|
1404
|
+
### Return type
|
|
1405
|
+
|
|
1406
|
+
[**GetLibraryQuiz**](GetLibraryQuiz.md)
|
|
1407
|
+
|
|
1408
|
+
### Authorization
|
|
1409
|
+
|
|
1410
|
+
No authorization required
|
|
1411
|
+
|
|
1412
|
+
### HTTP request headers
|
|
1413
|
+
|
|
1414
|
+
- **Content-Type**: `application/json`
|
|
1415
|
+
- **Accept**: `application/json`
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
### HTTP response details
|
|
1419
|
+
| Status code | Description | Response headers |
|
|
1420
|
+
|-------------|-------------|------------------|
|
|
1421
|
+
| **200** | Reusable quiz updated | - |
|
|
1422
|
+
|
|
1423
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
## putLibraryQuizCriteria
|
|
1427
|
+
|
|
1428
|
+
> Array<LibraryQuizCriterion> putLibraryQuizCriteria(quizId, versionId, putLibraryQuizCriteria)
|
|
1429
|
+
|
|
1430
|
+
Replace question-selection criteria on a draft quiz version
|
|
1431
|
+
|
|
1432
|
+
### Example
|
|
1433
|
+
|
|
1434
|
+
```ts
|
|
1435
|
+
import {
|
|
1436
|
+
Configuration,
|
|
1437
|
+
ContentLibraryQuizApi,
|
|
1438
|
+
} from '@easyedu/js-lsm-api';
|
|
1439
|
+
import type { PutLibraryQuizCriteriaRequest } from '@easyedu/js-lsm-api';
|
|
1440
|
+
|
|
1441
|
+
async function example() {
|
|
1442
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1443
|
+
const api = new ContentLibraryQuizApi();
|
|
1444
|
+
|
|
1445
|
+
const body = {
|
|
1446
|
+
// string
|
|
1447
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1448
|
+
// string
|
|
1449
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1450
|
+
// PutLibraryQuizCriteria
|
|
1451
|
+
putLibraryQuizCriteria: ...,
|
|
1452
|
+
} satisfies PutLibraryQuizCriteriaRequest;
|
|
1453
|
+
|
|
1454
|
+
try {
|
|
1455
|
+
const data = await api.putLibraryQuizCriteria(body);
|
|
1456
|
+
console.log(data);
|
|
1457
|
+
} catch (error) {
|
|
1458
|
+
console.error(error);
|
|
1459
|
+
}
|
|
1460
|
+
}
|
|
1461
|
+
|
|
1462
|
+
// Run the test
|
|
1463
|
+
example().catch(console.error);
|
|
1464
|
+
```
|
|
1465
|
+
|
|
1466
|
+
### Parameters
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
| Name | Type | Description | Notes |
|
|
1470
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1471
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1472
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
1473
|
+
| **putLibraryQuizCriteria** | [PutLibraryQuizCriteria](PutLibraryQuizCriteria.md) | | |
|
|
1474
|
+
|
|
1475
|
+
### Return type
|
|
1476
|
+
|
|
1477
|
+
[**Array<LibraryQuizCriterion>**](LibraryQuizCriterion.md)
|
|
1478
|
+
|
|
1479
|
+
### Authorization
|
|
1480
|
+
|
|
1481
|
+
No authorization required
|
|
1482
|
+
|
|
1483
|
+
### HTTP request headers
|
|
1484
|
+
|
|
1485
|
+
- **Content-Type**: `application/json`
|
|
1486
|
+
- **Accept**: `application/json`
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
### HTTP response details
|
|
1490
|
+
| Status code | Description | Response headers |
|
|
1491
|
+
|-------------|-------------|------------------|
|
|
1492
|
+
| **200** | Updated quiz version criteria | - |
|
|
1493
|
+
|
|
1494
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
## putLibraryQuizQuestions
|
|
1498
|
+
|
|
1499
|
+
> Array<LibraryQuizQuestion> putLibraryQuizQuestions(quizId, versionId, putLibraryQuizQuestions)
|
|
1500
|
+
|
|
1501
|
+
Replace manual questions on a draft quiz version
|
|
1502
|
+
|
|
1503
|
+
### Example
|
|
1504
|
+
|
|
1505
|
+
```ts
|
|
1506
|
+
import {
|
|
1507
|
+
Configuration,
|
|
1508
|
+
ContentLibraryQuizApi,
|
|
1509
|
+
} from '@easyedu/js-lsm-api';
|
|
1510
|
+
import type { PutLibraryQuizQuestionsRequest } from '@easyedu/js-lsm-api';
|
|
1511
|
+
|
|
1512
|
+
async function example() {
|
|
1513
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1514
|
+
const api = new ContentLibraryQuizApi();
|
|
1515
|
+
|
|
1516
|
+
const body = {
|
|
1517
|
+
// string
|
|
1518
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1519
|
+
// string
|
|
1520
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1521
|
+
// PutLibraryQuizQuestions
|
|
1522
|
+
putLibraryQuizQuestions: ...,
|
|
1523
|
+
} satisfies PutLibraryQuizQuestionsRequest;
|
|
1524
|
+
|
|
1525
|
+
try {
|
|
1526
|
+
const data = await api.putLibraryQuizQuestions(body);
|
|
1527
|
+
console.log(data);
|
|
1528
|
+
} catch (error) {
|
|
1529
|
+
console.error(error);
|
|
1530
|
+
}
|
|
1531
|
+
}
|
|
1532
|
+
|
|
1533
|
+
// Run the test
|
|
1534
|
+
example().catch(console.error);
|
|
1535
|
+
```
|
|
1536
|
+
|
|
1537
|
+
### Parameters
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
| Name | Type | Description | Notes |
|
|
1541
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1542
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1543
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
1544
|
+
| **putLibraryQuizQuestions** | [PutLibraryQuizQuestions](PutLibraryQuizQuestions.md) | | |
|
|
1545
|
+
|
|
1546
|
+
### Return type
|
|
1547
|
+
|
|
1548
|
+
[**Array<LibraryQuizQuestion>**](LibraryQuizQuestion.md)
|
|
1549
|
+
|
|
1550
|
+
### Authorization
|
|
1551
|
+
|
|
1552
|
+
No authorization required
|
|
1553
|
+
|
|
1554
|
+
### HTTP request headers
|
|
1555
|
+
|
|
1556
|
+
- **Content-Type**: `application/json`
|
|
1557
|
+
- **Accept**: `application/json`
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
### HTTP response details
|
|
1561
|
+
| Status code | Description | Response headers |
|
|
1562
|
+
|-------------|-------------|------------------|
|
|
1563
|
+
| **200** | Updated quiz version questions | - |
|
|
1564
|
+
|
|
1565
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
## putLibraryQuizSessionAnswer
|
|
1569
|
+
|
|
1570
|
+
> GetLibraryQuizSession putLibraryQuizSessionAnswer(sessionId, sessionQuestionId, putLibraryQuizSessionAnswer)
|
|
1571
|
+
|
|
1572
|
+
Save an answer using version-snapshot identifiers
|
|
1573
|
+
|
|
1574
|
+
### Example
|
|
1575
|
+
|
|
1576
|
+
```ts
|
|
1577
|
+
import {
|
|
1578
|
+
Configuration,
|
|
1579
|
+
ContentLibraryQuizApi,
|
|
1580
|
+
} from '@easyedu/js-lsm-api';
|
|
1581
|
+
import type { PutLibraryQuizSessionAnswerRequest } from '@easyedu/js-lsm-api';
|
|
1582
|
+
|
|
1583
|
+
async function example() {
|
|
1584
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1585
|
+
const api = new ContentLibraryQuizApi();
|
|
1586
|
+
|
|
1587
|
+
const body = {
|
|
1588
|
+
// string
|
|
1589
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1590
|
+
// string
|
|
1591
|
+
sessionQuestionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1592
|
+
// PutLibraryQuizSessionAnswer
|
|
1593
|
+
putLibraryQuizSessionAnswer: ...,
|
|
1594
|
+
} satisfies PutLibraryQuizSessionAnswerRequest;
|
|
1595
|
+
|
|
1596
|
+
try {
|
|
1597
|
+
const data = await api.putLibraryQuizSessionAnswer(body);
|
|
1598
|
+
console.log(data);
|
|
1599
|
+
} catch (error) {
|
|
1600
|
+
console.error(error);
|
|
1601
|
+
}
|
|
1602
|
+
}
|
|
1603
|
+
|
|
1604
|
+
// Run the test
|
|
1605
|
+
example().catch(console.error);
|
|
1606
|
+
```
|
|
1607
|
+
|
|
1608
|
+
### Parameters
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
| Name | Type | Description | Notes |
|
|
1612
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1613
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1614
|
+
| **sessionQuestionId** | `string` | | [Defaults to `undefined`] |
|
|
1615
|
+
| **putLibraryQuizSessionAnswer** | [PutLibraryQuizSessionAnswer](PutLibraryQuizSessionAnswer.md) | | |
|
|
1616
|
+
|
|
1617
|
+
### Return type
|
|
1618
|
+
|
|
1619
|
+
[**GetLibraryQuizSession**](GetLibraryQuizSession.md)
|
|
1620
|
+
|
|
1621
|
+
### Authorization
|
|
1622
|
+
|
|
1623
|
+
No authorization required
|
|
1624
|
+
|
|
1625
|
+
### HTTP request headers
|
|
1626
|
+
|
|
1627
|
+
- **Content-Type**: `application/json`
|
|
1628
|
+
- **Accept**: `application/json`
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
### HTTP response details
|
|
1632
|
+
| Status code | Description | Response headers |
|
|
1633
|
+
|-------------|-------------|------------------|
|
|
1634
|
+
| **200** | Updated quiz session | - |
|
|
1635
|
+
|
|
1636
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
## putLibraryQuizSessionGrade
|
|
1640
|
+
|
|
1641
|
+
> GetLibraryQuizResult putLibraryQuizSessionGrade(sessionId, sessionQuestionId, putLibraryQuizSessionGrade)
|
|
1642
|
+
|
|
1643
|
+
Manually grade a reusable quiz session answer
|
|
1644
|
+
|
|
1645
|
+
### Example
|
|
1646
|
+
|
|
1647
|
+
```ts
|
|
1648
|
+
import {
|
|
1649
|
+
Configuration,
|
|
1650
|
+
ContentLibraryQuizApi,
|
|
1651
|
+
} from '@easyedu/js-lsm-api';
|
|
1652
|
+
import type { PutLibraryQuizSessionGradeRequest } from '@easyedu/js-lsm-api';
|
|
1653
|
+
|
|
1654
|
+
async function example() {
|
|
1655
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1656
|
+
const api = new ContentLibraryQuizApi();
|
|
1657
|
+
|
|
1658
|
+
const body = {
|
|
1659
|
+
// string
|
|
1660
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1661
|
+
// string
|
|
1662
|
+
sessionQuestionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1663
|
+
// PutLibraryQuizSessionGrade
|
|
1664
|
+
putLibraryQuizSessionGrade: ...,
|
|
1665
|
+
} satisfies PutLibraryQuizSessionGradeRequest;
|
|
1666
|
+
|
|
1667
|
+
try {
|
|
1668
|
+
const data = await api.putLibraryQuizSessionGrade(body);
|
|
1669
|
+
console.log(data);
|
|
1670
|
+
} catch (error) {
|
|
1671
|
+
console.error(error);
|
|
1672
|
+
}
|
|
1673
|
+
}
|
|
1674
|
+
|
|
1675
|
+
// Run the test
|
|
1676
|
+
example().catch(console.error);
|
|
1677
|
+
```
|
|
1678
|
+
|
|
1679
|
+
### Parameters
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
| Name | Type | Description | Notes |
|
|
1683
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1684
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1685
|
+
| **sessionQuestionId** | `string` | | [Defaults to `undefined`] |
|
|
1686
|
+
| **putLibraryQuizSessionGrade** | [PutLibraryQuizSessionGrade](PutLibraryQuizSessionGrade.md) | | |
|
|
1687
|
+
|
|
1688
|
+
### Return type
|
|
1689
|
+
|
|
1690
|
+
[**GetLibraryQuizResult**](GetLibraryQuizResult.md)
|
|
1691
|
+
|
|
1692
|
+
### Authorization
|
|
1693
|
+
|
|
1694
|
+
No authorization required
|
|
1695
|
+
|
|
1696
|
+
### HTTP request headers
|
|
1697
|
+
|
|
1698
|
+
- **Content-Type**: `application/json`
|
|
1699
|
+
- **Accept**: `application/json`
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
### HTTP response details
|
|
1703
|
+
| Status code | Description | Response headers |
|
|
1704
|
+
|-------------|-------------|------------------|
|
|
1705
|
+
| **200** | Updated quiz result | - |
|
|
1706
|
+
|
|
1707
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
## putLibraryQuizVersion
|
|
1711
|
+
|
|
1712
|
+
> GetLibraryQuizVersion putLibraryQuizVersion(quizId, versionId, putLibraryQuizVersion)
|
|
1713
|
+
|
|
1714
|
+
Edit a draft reusable quiz version
|
|
1715
|
+
|
|
1716
|
+
### Example
|
|
1717
|
+
|
|
1718
|
+
```ts
|
|
1719
|
+
import {
|
|
1720
|
+
Configuration,
|
|
1721
|
+
ContentLibraryQuizApi,
|
|
1722
|
+
} from '@easyedu/js-lsm-api';
|
|
1723
|
+
import type { PutLibraryQuizVersionRequest } from '@easyedu/js-lsm-api';
|
|
1724
|
+
|
|
1725
|
+
async function example() {
|
|
1726
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1727
|
+
const api = new ContentLibraryQuizApi();
|
|
1728
|
+
|
|
1729
|
+
const body = {
|
|
1730
|
+
// string
|
|
1731
|
+
quizId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1732
|
+
// string
|
|
1733
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1734
|
+
// PutLibraryQuizVersion
|
|
1735
|
+
putLibraryQuizVersion: ...,
|
|
1736
|
+
} satisfies PutLibraryQuizVersionRequest;
|
|
1737
|
+
|
|
1738
|
+
try {
|
|
1739
|
+
const data = await api.putLibraryQuizVersion(body);
|
|
1740
|
+
console.log(data);
|
|
1741
|
+
} catch (error) {
|
|
1742
|
+
console.error(error);
|
|
1743
|
+
}
|
|
1744
|
+
}
|
|
1745
|
+
|
|
1746
|
+
// Run the test
|
|
1747
|
+
example().catch(console.error);
|
|
1748
|
+
```
|
|
1749
|
+
|
|
1750
|
+
### Parameters
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
| Name | Type | Description | Notes |
|
|
1754
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1755
|
+
| **quizId** | `string` | | [Defaults to `undefined`] |
|
|
1756
|
+
| **versionId** | `string` | | [Defaults to `undefined`] |
|
|
1757
|
+
| **putLibraryQuizVersion** | [PutLibraryQuizVersion](PutLibraryQuizVersion.md) | | |
|
|
1758
|
+
|
|
1759
|
+
### Return type
|
|
1760
|
+
|
|
1761
|
+
[**GetLibraryQuizVersion**](GetLibraryQuizVersion.md)
|
|
1762
|
+
|
|
1763
|
+
### Authorization
|
|
1764
|
+
|
|
1765
|
+
No authorization required
|
|
1766
|
+
|
|
1767
|
+
### HTTP request headers
|
|
1768
|
+
|
|
1769
|
+
- **Content-Type**: `application/json`
|
|
1770
|
+
- **Accept**: `application/json`
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
### HTTP response details
|
|
1774
|
+
| Status code | Description | Response headers |
|
|
1775
|
+
|-------------|-------------|------------------|
|
|
1776
|
+
| **200** | Updated draft quiz version | - |
|
|
1777
|
+
| **409** | Published and archived versions are immutable | - |
|
|
1778
|
+
|
|
1779
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1780
|
+
|