@easyedu/js-lsm-api 1.89.0 → 1.91.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 +28 -0
- package/README.md +24 -2
- package/dist/apis/ContentLibraryApi.d.ts +19 -0
- package/dist/apis/ContentLibraryApi.js +47 -0
- package/dist/apis/PlayerApi.d.ts +187 -0
- package/dist/apis/PlayerApi.js +401 -1
- package/dist/esm/apis/ContentLibraryApi.d.ts +19 -0
- package/dist/esm/apis/ContentLibraryApi.js +47 -0
- package/dist/esm/apis/PlayerApi.d.ts +187 -0
- package/dist/esm/apis/PlayerApi.js +400 -0
- package/dist/esm/models/GetCourseVersionItemSession.d.ts +7 -0
- package/dist/esm/models/GetCourseVersionItemSession.js +5 -0
- package/dist/esm/models/GetResourceSession.d.ts +191 -0
- package/dist/esm/models/GetResourceSession.js +128 -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/GetResourceSessionList.d.ts +57 -0
- package/dist/esm/models/GetResourceSessionList.js +60 -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/PostResourceVersionSession.d.ts +32 -0
- package/dist/esm/models/PostResourceVersionSession.js +41 -0
- package/dist/esm/models/ResourceSessionEnvironment.d.ts +25 -0
- package/dist/esm/models/ResourceSessionEnvironment.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 +14 -0
- package/dist/esm/models/index.js +14 -0
- package/dist/models/GetCourseVersionItemSession.d.ts +7 -0
- package/dist/models/GetCourseVersionItemSession.js +5 -0
- package/dist/models/GetResourceSession.d.ts +191 -0
- package/dist/models/GetResourceSession.js +135 -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/GetResourceSessionList.d.ts +57 -0
- package/dist/models/GetResourceSessionList.js +67 -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/PostResourceVersionSession.d.ts +32 -0
- package/dist/models/PostResourceVersionSession.js +48 -0
- package/dist/models/ResourceSessionEnvironment.d.ts +25 -0
- package/dist/models/ResourceSessionEnvironment.js +51 -0
- package/dist/models/ResourceSessionScormApiLogItem.d.ts +79 -0
- package/dist/models/ResourceSessionScormApiLogItem.js +81 -0
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/docs/ContentLibraryApi.md +73 -0
- package/docs/GetCourseVersionItemSession.md +2 -0
- package/docs/GetResourceSession.md +87 -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/GetResourceSessionList.md +43 -0
- package/docs/GetResourceSessionScormApiLogs.md +43 -0
- package/docs/GetResourceSessionScormData.md +49 -0
- package/docs/GetResourceSessionScormDataActivity.md +38 -0
- package/docs/PlayerApi.md +547 -0
- package/docs/PostResourceVersionSession.md +35 -0
- package/docs/ResourceSessionEnvironment.md +33 -0
- package/docs/ResourceSessionScormApiLogItem.md +47 -0
- package/package.json +1 -1
- package/src/apis/ContentLibraryApi.ts +72 -0
- package/src/apis/PlayerApi.ts +558 -0
- package/src/models/GetCourseVersionItemSession.ts +16 -0
- package/src/models/GetResourceSession.ts +313 -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/GetResourceSessionList.ts +110 -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/PostResourceVersionSession.ts +65 -0
- package/src/models/ResourceSessionEnvironment.ts +53 -0
- package/src/models/ResourceSessionScormApiLogItem.ts +132 -0
- package/src/models/index.ts +14 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
|
|
2
|
+
# GetResourceSessionScormApiLogs
|
|
3
|
+
|
|
4
|
+
A filtered page of SCORM runtime calls for a resource session.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`page` | number
|
|
11
|
+
`pageSize` | number
|
|
12
|
+
`totalPages` | number
|
|
13
|
+
`totalItems` | number
|
|
14
|
+
`items` | [Array<ResourceSessionScormApiLogItem>](ResourceSessionScormApiLogItem.md)
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { GetResourceSessionScormApiLogs } from '@easyedu/js-lsm-api'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"page": null,
|
|
24
|
+
"pageSize": null,
|
|
25
|
+
"totalPages": null,
|
|
26
|
+
"totalItems": null,
|
|
27
|
+
"items": null,
|
|
28
|
+
} satisfies GetResourceSessionScormApiLogs
|
|
29
|
+
|
|
30
|
+
console.log(example)
|
|
31
|
+
|
|
32
|
+
// Convert the instance to a JSON string
|
|
33
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
34
|
+
console.log(exampleJSON)
|
|
35
|
+
|
|
36
|
+
// Parse the JSON string back to an object
|
|
37
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionScormApiLogs
|
|
38
|
+
console.log(exampleParsed)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
42
|
+
|
|
43
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
|
|
2
|
+
# GetResourceSessionScormData
|
|
3
|
+
|
|
4
|
+
Current SCORM CMI state for a reusable resource session.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`scormVersion` | string
|
|
12
|
+
`createdAt` | number
|
|
13
|
+
`updatedAt` | number
|
|
14
|
+
`initializedAt` | number
|
|
15
|
+
`terminatedAt` | number
|
|
16
|
+
`activity` | [GetResourceSessionScormDataActivity](GetResourceSessionScormDataActivity.md)
|
|
17
|
+
`cmiData` | { [key: string]: string; }
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { GetResourceSessionScormData } from '@easyedu/js-lsm-api'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"id": null,
|
|
27
|
+
"scormVersion": null,
|
|
28
|
+
"createdAt": null,
|
|
29
|
+
"updatedAt": null,
|
|
30
|
+
"initializedAt": null,
|
|
31
|
+
"terminatedAt": null,
|
|
32
|
+
"activity": null,
|
|
33
|
+
"cmiData": null,
|
|
34
|
+
} satisfies GetResourceSessionScormData
|
|
35
|
+
|
|
36
|
+
console.log(example)
|
|
37
|
+
|
|
38
|
+
// Convert the instance to a JSON string
|
|
39
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
40
|
+
console.log(exampleJSON)
|
|
41
|
+
|
|
42
|
+
// Parse the JSON string back to an object
|
|
43
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionScormData
|
|
44
|
+
console.log(exampleParsed)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
48
|
+
|
|
49
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# GetResourceSessionScormDataActivity
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`identifier` | string
|
|
10
|
+
`name` | string
|
|
11
|
+
`launchPath` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { GetResourceSessionScormDataActivity } from '@easyedu/js-lsm-api'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"identifier": null,
|
|
21
|
+
"name": null,
|
|
22
|
+
"launchPath": null,
|
|
23
|
+
} satisfies GetResourceSessionScormDataActivity
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionScormDataActivity
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
package/docs/PlayerApi.md
CHANGED
|
@@ -14,12 +14,19 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
14
14
|
| [**getPdfPlayer**](PlayerApi.md#getpdfplayer) | **GET** /pdf/session/{sessionId}/player | PDF player HTML page |
|
|
15
15
|
| [**getQuizPlayer**](PlayerApi.md#getquizplayer) | **GET** /quiz/session/{sessionId}/player | Quiz player HTML page |
|
|
16
16
|
| [**getResourceScormValue**](PlayerApi.md#getresourcescormvalue) | **GET** /resource/sessions/{sessionId}/get-value | Read a CMI value from a reusable SCORM resource session |
|
|
17
|
+
| [**getResourceSession**](PlayerApi.md#getresourcesession) | **GET** /resource/sessions/{sessionId} | Get a resource session |
|
|
18
|
+
| [**getResourceSessionAsset**](PlayerApi.md#getresourcesessionasset) | **GET** /resource/sessions/{sessionId}/asset/{assetPath} | Stream an asset pinned to a resource session |
|
|
19
|
+
| [**getResourceSessionDiagnostics**](PlayerApi.md#getresourcesessiondiagnostics) | **GET** /resource/sessions/{sessionId}/diagnostics | Get administrator diagnostics for a resource session |
|
|
20
|
+
| [**getResourceSessionList**](PlayerApi.md#getresourcesessionlist) | **GET** /resource/sessions | List resource sessions for the selected portal |
|
|
17
21
|
| [**getResourceSessionPlayer**](PlayerApi.md#getresourcesessionplayer) | **GET** /resource/sessions/{sessionId}/player | Serve the player for a version-pinned reusable resource session |
|
|
22
|
+
| [**getResourceSessionScormApiLogs**](PlayerApi.md#getresourcesessionscormapilogs) | **GET** /resource/sessions/{sessionId}/api-logs | Get SCORM runtime logs for a resource session |
|
|
23
|
+
| [**getResourceSessionScormData**](PlayerApi.md#getresourcesessionscormdata) | **GET** /resource/sessions/{sessionId}/scorm-data | Get SCORM CMI data for a resource session |
|
|
18
24
|
| [**getScormAsset**](PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset |
|
|
19
25
|
| [**getScormPlayer**](PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page |
|
|
20
26
|
| [**getVideoAsset**](PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset |
|
|
21
27
|
| [**getVideoPlayer**](PlayerApi.md#getvideoplayer) | **GET** /video/session/{sessionId}/player | Video player HTML page |
|
|
22
28
|
| [**initializeResourceScormSession**](PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session |
|
|
29
|
+
| [**postResourceSessionComplete**](PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session |
|
|
23
30
|
| [**setResourceScormValue**](PlayerApi.md#setresourcescormvalue) | **POST** /resource/sessions/{sessionId}/set-value | Store a CMI value in a reusable SCORM resource session |
|
|
24
31
|
| [**terminateResourceScormSession**](PlayerApi.md#terminateresourcescormsession) | **POST** /resource/sessions/{sessionId}/terminate | Terminate a reusable SCORM resource session |
|
|
25
32
|
|
|
@@ -700,6 +707,331 @@ No authorization required
|
|
|
700
707
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
701
708
|
|
|
702
709
|
|
|
710
|
+
## getResourceSession
|
|
711
|
+
|
|
712
|
+
> GetResourceSession getResourceSession(sessionId)
|
|
713
|
+
|
|
714
|
+
Get a resource session
|
|
715
|
+
|
|
716
|
+
### Example
|
|
717
|
+
|
|
718
|
+
```ts
|
|
719
|
+
import {
|
|
720
|
+
Configuration,
|
|
721
|
+
PlayerApi,
|
|
722
|
+
} from '@easyedu/js-lsm-api';
|
|
723
|
+
import type { GetResourceSessionRequest } from '@easyedu/js-lsm-api';
|
|
724
|
+
|
|
725
|
+
async function example() {
|
|
726
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
727
|
+
const api = new PlayerApi();
|
|
728
|
+
|
|
729
|
+
const body = {
|
|
730
|
+
// string
|
|
731
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
732
|
+
} satisfies GetResourceSessionRequest;
|
|
733
|
+
|
|
734
|
+
try {
|
|
735
|
+
const data = await api.getResourceSession(body);
|
|
736
|
+
console.log(data);
|
|
737
|
+
} catch (error) {
|
|
738
|
+
console.error(error);
|
|
739
|
+
}
|
|
740
|
+
}
|
|
741
|
+
|
|
742
|
+
// Run the test
|
|
743
|
+
example().catch(console.error);
|
|
744
|
+
```
|
|
745
|
+
|
|
746
|
+
### Parameters
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
| Name | Type | Description | Notes |
|
|
750
|
+
|------------- | ------------- | ------------- | -------------|
|
|
751
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
752
|
+
|
|
753
|
+
### Return type
|
|
754
|
+
|
|
755
|
+
[**GetResourceSession**](GetResourceSession.md)
|
|
756
|
+
|
|
757
|
+
### Authorization
|
|
758
|
+
|
|
759
|
+
No authorization required
|
|
760
|
+
|
|
761
|
+
### HTTP request headers
|
|
762
|
+
|
|
763
|
+
- **Content-Type**: Not defined
|
|
764
|
+
- **Accept**: `application/json`
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
### HTTP response details
|
|
768
|
+
| Status code | Description | Response headers |
|
|
769
|
+
|-------------|-------------|------------------|
|
|
770
|
+
| **200** | Resource session | - |
|
|
771
|
+
| **404** | Resource session not found | - |
|
|
772
|
+
|
|
773
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
## getResourceSessionAsset
|
|
777
|
+
|
|
778
|
+
> Blob getResourceSessionAsset(sessionId, assetPath)
|
|
779
|
+
|
|
780
|
+
Stream an asset pinned to a resource session
|
|
781
|
+
|
|
782
|
+
### Example
|
|
783
|
+
|
|
784
|
+
```ts
|
|
785
|
+
import {
|
|
786
|
+
Configuration,
|
|
787
|
+
PlayerApi,
|
|
788
|
+
} from '@easyedu/js-lsm-api';
|
|
789
|
+
import type { GetResourceSessionAssetRequest } from '@easyedu/js-lsm-api';
|
|
790
|
+
|
|
791
|
+
async function example() {
|
|
792
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
793
|
+
const api = new PlayerApi();
|
|
794
|
+
|
|
795
|
+
const body = {
|
|
796
|
+
// string
|
|
797
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
798
|
+
// string
|
|
799
|
+
assetPath: assetPath_example,
|
|
800
|
+
} satisfies GetResourceSessionAssetRequest;
|
|
801
|
+
|
|
802
|
+
try {
|
|
803
|
+
const data = await api.getResourceSessionAsset(body);
|
|
804
|
+
console.log(data);
|
|
805
|
+
} catch (error) {
|
|
806
|
+
console.error(error);
|
|
807
|
+
}
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
// Run the test
|
|
811
|
+
example().catch(console.error);
|
|
812
|
+
```
|
|
813
|
+
|
|
814
|
+
### Parameters
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
| Name | Type | Description | Notes |
|
|
818
|
+
|------------- | ------------- | ------------- | -------------|
|
|
819
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
820
|
+
| **assetPath** | `string` | | [Defaults to `undefined`] |
|
|
821
|
+
|
|
822
|
+
### Return type
|
|
823
|
+
|
|
824
|
+
**Blob**
|
|
825
|
+
|
|
826
|
+
### Authorization
|
|
827
|
+
|
|
828
|
+
No authorization required
|
|
829
|
+
|
|
830
|
+
### HTTP request headers
|
|
831
|
+
|
|
832
|
+
- **Content-Type**: Not defined
|
|
833
|
+
- **Accept**: `application/octet-stream`
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
### HTTP response details
|
|
837
|
+
| Status code | Description | Response headers |
|
|
838
|
+
|-------------|-------------|------------------|
|
|
839
|
+
| **200** | Resource bytes | - |
|
|
840
|
+
|
|
841
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
## getResourceSessionDiagnostics
|
|
845
|
+
|
|
846
|
+
> GetResourceSessionDiagnostics getResourceSessionDiagnostics(sessionId)
|
|
847
|
+
|
|
848
|
+
Get administrator diagnostics for a resource session
|
|
849
|
+
|
|
850
|
+
### Example
|
|
851
|
+
|
|
852
|
+
```ts
|
|
853
|
+
import {
|
|
854
|
+
Configuration,
|
|
855
|
+
PlayerApi,
|
|
856
|
+
} from '@easyedu/js-lsm-api';
|
|
857
|
+
import type { GetResourceSessionDiagnosticsRequest } from '@easyedu/js-lsm-api';
|
|
858
|
+
|
|
859
|
+
async function example() {
|
|
860
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
861
|
+
const api = new PlayerApi();
|
|
862
|
+
|
|
863
|
+
const body = {
|
|
864
|
+
// string
|
|
865
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
866
|
+
} satisfies GetResourceSessionDiagnosticsRequest;
|
|
867
|
+
|
|
868
|
+
try {
|
|
869
|
+
const data = await api.getResourceSessionDiagnostics(body);
|
|
870
|
+
console.log(data);
|
|
871
|
+
} catch (error) {
|
|
872
|
+
console.error(error);
|
|
873
|
+
}
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
// Run the test
|
|
877
|
+
example().catch(console.error);
|
|
878
|
+
```
|
|
879
|
+
|
|
880
|
+
### Parameters
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
| Name | Type | Description | Notes |
|
|
884
|
+
|------------- | ------------- | ------------- | -------------|
|
|
885
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
886
|
+
|
|
887
|
+
### Return type
|
|
888
|
+
|
|
889
|
+
[**GetResourceSessionDiagnostics**](GetResourceSessionDiagnostics.md)
|
|
890
|
+
|
|
891
|
+
### Authorization
|
|
892
|
+
|
|
893
|
+
No authorization required
|
|
894
|
+
|
|
895
|
+
### HTTP request headers
|
|
896
|
+
|
|
897
|
+
- **Content-Type**: Not defined
|
|
898
|
+
- **Accept**: `application/json`
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
### HTTP response details
|
|
902
|
+
| Status code | Description | Response headers |
|
|
903
|
+
|-------------|-------------|------------------|
|
|
904
|
+
| **200** | Resource session diagnostics | - |
|
|
905
|
+
| **404** | Resource session not found | - |
|
|
906
|
+
|
|
907
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
## getResourceSessionList
|
|
911
|
+
|
|
912
|
+
> GetResourceSessionList getResourceSessionList(userId, resourceId, versionId, courseId, courseVersionId, itemId, resourceType, environment, completionStatus, gradeStatus, isCurrent, attemptNumber, createdFrom, createdTo, updatedFrom, updatedTo, hasScormErrors, sortBy, sortDirection, page, pageSize)
|
|
913
|
+
|
|
914
|
+
List resource sessions for the selected portal
|
|
915
|
+
|
|
916
|
+
### Example
|
|
917
|
+
|
|
918
|
+
```ts
|
|
919
|
+
import {
|
|
920
|
+
Configuration,
|
|
921
|
+
PlayerApi,
|
|
922
|
+
} from '@easyedu/js-lsm-api';
|
|
923
|
+
import type { GetResourceSessionListRequest } 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 (optional)
|
|
931
|
+
userId: userId_example,
|
|
932
|
+
// string (optional)
|
|
933
|
+
resourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
934
|
+
// string (optional)
|
|
935
|
+
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
936
|
+
// string (optional)
|
|
937
|
+
courseId: courseId_example,
|
|
938
|
+
// string (optional)
|
|
939
|
+
courseVersionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
940
|
+
// string (optional)
|
|
941
|
+
itemId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
942
|
+
// ResourceType (optional)
|
|
943
|
+
resourceType: ...,
|
|
944
|
+
// ResourceSessionEnvironment (optional)
|
|
945
|
+
environment: ...,
|
|
946
|
+
// 'not_attempted' | 'in_progress' | 'completed' (optional)
|
|
947
|
+
completionStatus: completionStatus_example,
|
|
948
|
+
// 'ungraded' | 'passed' | 'failed' | 'points_earned' | 'percentage_earned' | 'not_applicable' (optional)
|
|
949
|
+
gradeStatus: gradeStatus_example,
|
|
950
|
+
// boolean (optional)
|
|
951
|
+
isCurrent: true,
|
|
952
|
+
// number (optional)
|
|
953
|
+
attemptNumber: 56,
|
|
954
|
+
// number (optional)
|
|
955
|
+
createdFrom: 789,
|
|
956
|
+
// number (optional)
|
|
957
|
+
createdTo: 789,
|
|
958
|
+
// number (optional)
|
|
959
|
+
updatedFrom: 789,
|
|
960
|
+
// number (optional)
|
|
961
|
+
updatedTo: 789,
|
|
962
|
+
// boolean (optional)
|
|
963
|
+
hasScormErrors: true,
|
|
964
|
+
// 'created_at' | 'updated_at' | 'attempt_number' (optional)
|
|
965
|
+
sortBy: sortBy_example,
|
|
966
|
+
// 'asc' | 'desc' (optional)
|
|
967
|
+
sortDirection: sortDirection_example,
|
|
968
|
+
// number (optional)
|
|
969
|
+
page: 56,
|
|
970
|
+
// number (optional)
|
|
971
|
+
pageSize: 56,
|
|
972
|
+
} satisfies GetResourceSessionListRequest;
|
|
973
|
+
|
|
974
|
+
try {
|
|
975
|
+
const data = await api.getResourceSessionList(body);
|
|
976
|
+
console.log(data);
|
|
977
|
+
} catch (error) {
|
|
978
|
+
console.error(error);
|
|
979
|
+
}
|
|
980
|
+
}
|
|
981
|
+
|
|
982
|
+
// Run the test
|
|
983
|
+
example().catch(console.error);
|
|
984
|
+
```
|
|
985
|
+
|
|
986
|
+
### Parameters
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
| Name | Type | Description | Notes |
|
|
990
|
+
|------------- | ------------- | ------------- | -------------|
|
|
991
|
+
| **userId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
992
|
+
| **resourceId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
993
|
+
| **versionId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
994
|
+
| **courseId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
995
|
+
| **courseVersionId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
996
|
+
| **itemId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
997
|
+
| **resourceType** | `ResourceType` | | [Optional] [Defaults to `undefined`] [Enum: scorm, video, audio, image, pdf, powerpoint, file, link, rich_text] |
|
|
998
|
+
| **environment** | `ResourceSessionEnvironment` | | [Optional] [Defaults to `undefined`] [Enum: live, demo] |
|
|
999
|
+
| **completionStatus** | `not_attempted`, `in_progress`, `completed` | | [Optional] [Defaults to `undefined`] [Enum: not_attempted, in_progress, completed] |
|
|
1000
|
+
| **gradeStatus** | `ungraded`, `passed`, `failed`, `points_earned`, `percentage_earned`, `not_applicable` | | [Optional] [Defaults to `undefined`] [Enum: ungraded, passed, failed, points_earned, percentage_earned, not_applicable] |
|
|
1001
|
+
| **isCurrent** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1002
|
+
| **attemptNumber** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1003
|
+
| **createdFrom** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1004
|
+
| **createdTo** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1005
|
+
| **updatedFrom** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1006
|
+
| **updatedTo** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1007
|
+
| **hasScormErrors** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1008
|
+
| **sortBy** | `created_at`, `updated_at`, `attempt_number` | | [Optional] [Defaults to `'updated_at'`] [Enum: created_at, updated_at, attempt_number] |
|
|
1009
|
+
| **sortDirection** | `asc`, `desc` | | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
|
|
1010
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
1011
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `20`] |
|
|
1012
|
+
|
|
1013
|
+
### Return type
|
|
1014
|
+
|
|
1015
|
+
[**GetResourceSessionList**](GetResourceSessionList.md)
|
|
1016
|
+
|
|
1017
|
+
### Authorization
|
|
1018
|
+
|
|
1019
|
+
No authorization required
|
|
1020
|
+
|
|
1021
|
+
### HTTP request headers
|
|
1022
|
+
|
|
1023
|
+
- **Content-Type**: Not defined
|
|
1024
|
+
- **Accept**: `application/json`
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
### HTTP response details
|
|
1028
|
+
| Status code | Description | Response headers |
|
|
1029
|
+
|-------------|-------------|------------------|
|
|
1030
|
+
| **200** | Resource sessions | - |
|
|
1031
|
+
|
|
1032
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1033
|
+
|
|
1034
|
+
|
|
703
1035
|
## getResourceSessionPlayer
|
|
704
1036
|
|
|
705
1037
|
> string getResourceSessionPlayer(sessionId)
|
|
@@ -766,6 +1098,155 @@ No authorization required
|
|
|
766
1098
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
767
1099
|
|
|
768
1100
|
|
|
1101
|
+
## getResourceSessionScormApiLogs
|
|
1102
|
+
|
|
1103
|
+
> GetResourceSessionScormApiLogs getResourceSessionScormApiLogs(sessionId, method, element, errorsOnly, page, pageSize)
|
|
1104
|
+
|
|
1105
|
+
Get SCORM runtime logs for a resource session
|
|
1106
|
+
|
|
1107
|
+
### Example
|
|
1108
|
+
|
|
1109
|
+
```ts
|
|
1110
|
+
import {
|
|
1111
|
+
Configuration,
|
|
1112
|
+
PlayerApi,
|
|
1113
|
+
} from '@easyedu/js-lsm-api';
|
|
1114
|
+
import type { GetResourceSessionScormApiLogsRequest } from '@easyedu/js-lsm-api';
|
|
1115
|
+
|
|
1116
|
+
async function example() {
|
|
1117
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1118
|
+
const api = new PlayerApi();
|
|
1119
|
+
|
|
1120
|
+
const body = {
|
|
1121
|
+
// string
|
|
1122
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1123
|
+
// 'Initialize' | 'GetValue' | 'SetValue' | 'Commit' | 'Terminate' (optional)
|
|
1124
|
+
method: method_example,
|
|
1125
|
+
// string (optional)
|
|
1126
|
+
element: element_example,
|
|
1127
|
+
// boolean (optional)
|
|
1128
|
+
errorsOnly: true,
|
|
1129
|
+
// number (optional)
|
|
1130
|
+
page: 56,
|
|
1131
|
+
// number (optional)
|
|
1132
|
+
pageSize: 56,
|
|
1133
|
+
} satisfies GetResourceSessionScormApiLogsRequest;
|
|
1134
|
+
|
|
1135
|
+
try {
|
|
1136
|
+
const data = await api.getResourceSessionScormApiLogs(body);
|
|
1137
|
+
console.log(data);
|
|
1138
|
+
} catch (error) {
|
|
1139
|
+
console.error(error);
|
|
1140
|
+
}
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
// Run the test
|
|
1144
|
+
example().catch(console.error);
|
|
1145
|
+
```
|
|
1146
|
+
|
|
1147
|
+
### Parameters
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
| Name | Type | Description | Notes |
|
|
1151
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1152
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1153
|
+
| **method** | `Initialize`, `GetValue`, `SetValue`, `Commit`, `Terminate` | | [Optional] [Defaults to `undefined`] [Enum: Initialize, GetValue, SetValue, Commit, Terminate] |
|
|
1154
|
+
| **element** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1155
|
+
| **errorsOnly** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
1156
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
1157
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `50`] |
|
|
1158
|
+
|
|
1159
|
+
### Return type
|
|
1160
|
+
|
|
1161
|
+
[**GetResourceSessionScormApiLogs**](GetResourceSessionScormApiLogs.md)
|
|
1162
|
+
|
|
1163
|
+
### Authorization
|
|
1164
|
+
|
|
1165
|
+
No authorization required
|
|
1166
|
+
|
|
1167
|
+
### HTTP request headers
|
|
1168
|
+
|
|
1169
|
+
- **Content-Type**: Not defined
|
|
1170
|
+
- **Accept**: `application/json`
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
### HTTP response details
|
|
1174
|
+
| Status code | Description | Response headers |
|
|
1175
|
+
|-------------|-------------|------------------|
|
|
1176
|
+
| **200** | Resource session SCORM runtime logs | - |
|
|
1177
|
+
| **400** | Resource session is not SCORM | - |
|
|
1178
|
+
| **404** | Resource session not found | - |
|
|
1179
|
+
|
|
1180
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
## getResourceSessionScormData
|
|
1184
|
+
|
|
1185
|
+
> GetResourceSessionScormData getResourceSessionScormData(sessionId)
|
|
1186
|
+
|
|
1187
|
+
Get SCORM CMI data for a resource session
|
|
1188
|
+
|
|
1189
|
+
### Example
|
|
1190
|
+
|
|
1191
|
+
```ts
|
|
1192
|
+
import {
|
|
1193
|
+
Configuration,
|
|
1194
|
+
PlayerApi,
|
|
1195
|
+
} from '@easyedu/js-lsm-api';
|
|
1196
|
+
import type { GetResourceSessionScormDataRequest } from '@easyedu/js-lsm-api';
|
|
1197
|
+
|
|
1198
|
+
async function example() {
|
|
1199
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1200
|
+
const api = new PlayerApi();
|
|
1201
|
+
|
|
1202
|
+
const body = {
|
|
1203
|
+
// string
|
|
1204
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1205
|
+
} satisfies GetResourceSessionScormDataRequest;
|
|
1206
|
+
|
|
1207
|
+
try {
|
|
1208
|
+
const data = await api.getResourceSessionScormData(body);
|
|
1209
|
+
console.log(data);
|
|
1210
|
+
} catch (error) {
|
|
1211
|
+
console.error(error);
|
|
1212
|
+
}
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
// Run the test
|
|
1216
|
+
example().catch(console.error);
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
### Parameters
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
| Name | Type | Description | Notes |
|
|
1223
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1224
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1225
|
+
|
|
1226
|
+
### Return type
|
|
1227
|
+
|
|
1228
|
+
[**GetResourceSessionScormData**](GetResourceSessionScormData.md)
|
|
1229
|
+
|
|
1230
|
+
### Authorization
|
|
1231
|
+
|
|
1232
|
+
No authorization required
|
|
1233
|
+
|
|
1234
|
+
### HTTP request headers
|
|
1235
|
+
|
|
1236
|
+
- **Content-Type**: Not defined
|
|
1237
|
+
- **Accept**: `application/json`
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
### HTTP response details
|
|
1241
|
+
| Status code | Description | Response headers |
|
|
1242
|
+
|-------------|-------------|------------------|
|
|
1243
|
+
| **200** | Resource session SCORM data | - |
|
|
1244
|
+
| **400** | Resource session is not SCORM | - |
|
|
1245
|
+
| **404** | Resource session not found | - |
|
|
1246
|
+
|
|
1247
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1248
|
+
|
|
1249
|
+
|
|
769
1250
|
## getScormAsset
|
|
770
1251
|
|
|
771
1252
|
> getScormAsset(contentId, assetPath)
|
|
@@ -1104,6 +1585,72 @@ No authorization required
|
|
|
1104
1585
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1105
1586
|
|
|
1106
1587
|
|
|
1588
|
+
## postResourceSessionComplete
|
|
1589
|
+
|
|
1590
|
+
> GetResourceSession postResourceSessionComplete(sessionId)
|
|
1591
|
+
|
|
1592
|
+
Complete a non-SCORM resource session
|
|
1593
|
+
|
|
1594
|
+
### Example
|
|
1595
|
+
|
|
1596
|
+
```ts
|
|
1597
|
+
import {
|
|
1598
|
+
Configuration,
|
|
1599
|
+
PlayerApi,
|
|
1600
|
+
} from '@easyedu/js-lsm-api';
|
|
1601
|
+
import type { PostResourceSessionCompleteRequest } from '@easyedu/js-lsm-api';
|
|
1602
|
+
|
|
1603
|
+
async function example() {
|
|
1604
|
+
console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
|
|
1605
|
+
const api = new PlayerApi();
|
|
1606
|
+
|
|
1607
|
+
const body = {
|
|
1608
|
+
// string
|
|
1609
|
+
sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1610
|
+
} satisfies PostResourceSessionCompleteRequest;
|
|
1611
|
+
|
|
1612
|
+
try {
|
|
1613
|
+
const data = await api.postResourceSessionComplete(body);
|
|
1614
|
+
console.log(data);
|
|
1615
|
+
} catch (error) {
|
|
1616
|
+
console.error(error);
|
|
1617
|
+
}
|
|
1618
|
+
}
|
|
1619
|
+
|
|
1620
|
+
// Run the test
|
|
1621
|
+
example().catch(console.error);
|
|
1622
|
+
```
|
|
1623
|
+
|
|
1624
|
+
### Parameters
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
| Name | Type | Description | Notes |
|
|
1628
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1629
|
+
| **sessionId** | `string` | | [Defaults to `undefined`] |
|
|
1630
|
+
|
|
1631
|
+
### Return type
|
|
1632
|
+
|
|
1633
|
+
[**GetResourceSession**](GetResourceSession.md)
|
|
1634
|
+
|
|
1635
|
+
### Authorization
|
|
1636
|
+
|
|
1637
|
+
No authorization required
|
|
1638
|
+
|
|
1639
|
+
### HTTP request headers
|
|
1640
|
+
|
|
1641
|
+
- **Content-Type**: Not defined
|
|
1642
|
+
- **Accept**: `application/json`
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
### HTTP response details
|
|
1646
|
+
| Status code | Description | Response headers |
|
|
1647
|
+
|-------------|-------------|------------------|
|
|
1648
|
+
| **200** | Completed resource session | - |
|
|
1649
|
+
| **400** | SCORM sessions complete through their runtime | - |
|
|
1650
|
+
|
|
1651
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1652
|
+
|
|
1653
|
+
|
|
1107
1654
|
## setResourceScormValue
|
|
1108
1655
|
|
|
1109
1656
|
> ScormSetValueResponse setResourceScormValue(sessionId, scormSetValueRequest)
|