edmentum-client 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CODEOWNERS +5 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +65 -0
- data/README.md +58 -0
- data/Rakefile +8 -0
- data/docs/EdApiModelsActivity.md +13 -0
- data/docs/EdApiModelsActivityProgress.md +10 -0
- data/docs/EdApiModelsActivityScore.md +11 -0
- data/docs/EdApiModelsActivityTimeOnTask.md +11 -0
- data/docs/EdApiModelsClass.md +22 -0
- data/docs/EdApiModelsClassDetail.md +24 -0
- data/docs/EdApiModelsClassStatus.md +10 -0
- data/docs/EdApiModelsClassTransfer.md +9 -0
- data/docs/EdApiModelsClassUserStatus.md +11 -0
- data/docs/EdApiModelsCoursewareClassLearnerGrade.md +11 -0
- data/docs/EdApiModelsCreateUser.md +19 -0
- data/docs/EdApiModelsExactPathClass.md +18 -0
- data/docs/EdApiModelsExactPathClassLearner.md +14 -0
- data/docs/EdApiModelsExactPathLearningPathProgressReport.md +10 -0
- data/docs/EdApiModelsExactPathLearningPathProgressReportQuery.md +10 -0
- data/docs/EdApiModelsFamilyContactLearner.md +13 -0
- data/docs/EdApiModelsFamilyContactLearnerCreate.md +13 -0
- data/docs/EdApiModelsFamilyContactPassword.md +8 -0
- data/docs/EdApiModelsLearningPathProgressRow.md +24 -0
- data/docs/EdApiModelsLocation.md +11 -0
- data/docs/EdApiModelsLocationStructure.md +13 -0
- data/docs/EdApiModelsMessage.md +14 -0
- data/docs/EdApiModelsPassword.md +8 -0
- data/docs/EdApiModelsProgram.md +13 -0
- data/docs/EdApiModelsProgramAlertSummary.md +10 -0
- data/docs/EdApiModelsResourceNode.md +13 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsActivity.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsActivityProgress.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsActivityScore.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsActivityTimeOnTask.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsCoursewareClassLearnerGrade.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsFamilyContactLearner.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsLocation.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsProgram.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsResourceNode.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsUserClassAssignment.md +9 -0
- data/docs/EdApiModelsResultsWithCountEdApiModelsUserProgramAlertSummary.md +9 -0
- data/docs/EdApiModelsUser.md +19 -0
- data/docs/EdApiModelsUserClassAssignment.md +22 -0
- data/docs/EdApiModelsUserProgramAlertSummary.md +9 -0
- data/docs/EdApiPageableResultsWithCountEdApiModelsClass.md +10 -0
- data/docs/EdApiPageableResultsWithCountEdApiModelsClassDetail.md +10 -0
- data/docs/EdApiPageableResultsWithCountEdApiModelsMessage.md +10 -0
- data/docs/EdApiPageableResultsWithCountEdApiModelsUser.md +10 -0
- data/docs/EdApiPageableResultsWithCountEdCoreDomainReportingUserTimeOnSystem.md +10 -0
- data/docs/EdCoreDomainReportingUserTimeOnSystem.md +10 -0
- data/docs/EdPersonalizedLearningDomainLocationsLocation.md +9 -0
- data/docs/V20AdministrationCenterApi.md +985 -0
- data/docs/V20CoursewareApi.md +1078 -0
- data/docs/V20ExactPathApi.md +387 -0
- data/git_push.sh +55 -0
- data/lib/edmentum_client/api/v20_administration_center_api.rb +1121 -0
- data/lib/edmentum_client/api/v20_courseware_api.rb +1230 -0
- data/lib/edmentum_client/api/v20_exact_path_api.rb +449 -0
- data/lib/edmentum_client/api_client.rb +391 -0
- data/lib/edmentum_client/api_error.rb +38 -0
- data/lib/edmentum_client/configuration.rb +217 -0
- data/lib/edmentum_client/models/ed_api_models_activity.rb +229 -0
- data/lib/edmentum_client/models/ed_api_models_activity_progress.rb +202 -0
- data/lib/edmentum_client/models/ed_api_models_activity_score.rb +211 -0
- data/lib/edmentum_client/models/ed_api_models_activity_time_on_task.rb +211 -0
- data/lib/edmentum_client/models/ed_api_models_class.rb +369 -0
- data/lib/edmentum_client/models/ed_api_models_class_detail.rb +391 -0
- data/lib/edmentum_client/models/ed_api_models_class_status.rb +207 -0
- data/lib/edmentum_client/models/ed_api_models_class_transfer.rb +203 -0
- data/lib/edmentum_client/models/ed_api_models_class_user_status.rb +216 -0
- data/lib/edmentum_client/models/ed_api_models_courseware_class_learner_grade.rb +211 -0
- data/lib/edmentum_client/models/ed_api_models_create_user.rb +375 -0
- data/lib/edmentum_client/models/ed_api_models_exact_path_class.rb +278 -0
- data/lib/edmentum_client/models/ed_api_models_exact_path_class_learner.rb +319 -0
- data/lib/edmentum_client/models/ed_api_models_exact_path_learning_path_progress_report.rb +204 -0
- data/lib/edmentum_client/models/ed_api_models_exact_path_learning_path_progress_report_query.rb +202 -0
- data/lib/edmentum_client/models/ed_api_models_family_contact_learner.rb +239 -0
- data/lib/edmentum_client/models/ed_api_models_family_contact_learner_create.rb +244 -0
- data/lib/edmentum_client/models/ed_api_models_family_contact_password.rb +189 -0
- data/lib/edmentum_client/models/ed_api_models_learning_path_progress_row.rb +328 -0
- data/lib/edmentum_client/models/ed_api_models_location.rb +211 -0
- data/lib/edmentum_client/models/ed_api_models_location_structure.rb +231 -0
- data/lib/edmentum_client/models/ed_api_models_message.rb +238 -0
- data/lib/edmentum_client/models/ed_api_models_password.rb +199 -0
- data/lib/edmentum_client/models/ed_api_models_program.rb +265 -0
- data/lib/edmentum_client/models/ed_api_models_program_alert_summary.rb +202 -0
- data/lib/edmentum_client/models/ed_api_models_resource_node.rb +231 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_activity.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_activity_progress.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_activity_score.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_activity_time_on_task.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_courseware_class_learner_grade.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_family_contact_learner.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_location.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_program.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_resource_node.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_user_class_assignment.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_results_with_count_ed_api_models_user_program_alert_summary.rb +195 -0
- data/lib/edmentum_client/models/ed_api_models_user.rb +357 -0
- data/lib/edmentum_client/models/ed_api_models_user_class_assignment.rb +384 -0
- data/lib/edmentum_client/models/ed_api_models_user_program_alert_summary.rb +193 -0
- data/lib/edmentum_client/models/ed_api_pageable_results_with_count_ed_api_models_class.rb +206 -0
- data/lib/edmentum_client/models/ed_api_pageable_results_with_count_ed_api_models_class_detail.rb +206 -0
- data/lib/edmentum_client/models/ed_api_pageable_results_with_count_ed_api_models_message.rb +206 -0
- data/lib/edmentum_client/models/ed_api_pageable_results_with_count_ed_api_models_user.rb +206 -0
- data/lib/edmentum_client/models/ed_api_pageable_results_with_count_ed_core_domain_reporting_user_time_on_system.rb +206 -0
- data/lib/edmentum_client/models/ed_core_domain_reporting_user_time_on_system.rb +202 -0
- data/lib/edmentum_client/models/ed_personalized_learning_domain_locations_location.rb +193 -0
- data/lib/edmentum_client/version.rb +15 -0
- data/lib/edmentum_client.rb +117 -0
- data/spec/api/v20_administration_center_api_spec.rb +275 -0
- data/spec/api/v20_courseware_api_spec.rb +299 -0
- data/spec/api/v20_exact_path_api_spec.rb +127 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/ed_api_models_activity_progress_spec.rb +53 -0
- data/spec/models/ed_api_models_activity_score_spec.rb +59 -0
- data/spec/models/ed_api_models_activity_spec.rb +71 -0
- data/spec/models/ed_api_models_activity_time_on_task_spec.rb +59 -0
- data/spec/models/ed_api_models_class_detail_spec.rb +137 -0
- data/spec/models/ed_api_models_class_spec.rb +125 -0
- data/spec/models/ed_api_models_class_status_spec.rb +53 -0
- data/spec/models/ed_api_models_class_transfer_spec.rb +47 -0
- data/spec/models/ed_api_models_class_user_status_spec.rb +59 -0
- data/spec/models/ed_api_models_courseware_class_learner_grade_spec.rb +59 -0
- data/spec/models/ed_api_models_create_user_spec.rb +111 -0
- data/spec/models/ed_api_models_exact_path_class_learner_spec.rb +85 -0
- data/spec/models/ed_api_models_exact_path_class_spec.rb +101 -0
- data/spec/models/ed_api_models_exact_path_learning_path_progress_report_query_spec.rb +53 -0
- data/spec/models/ed_api_models_exact_path_learning_path_progress_report_spec.rb +53 -0
- data/spec/models/ed_api_models_family_contact_learner_create_spec.rb +71 -0
- data/spec/models/ed_api_models_family_contact_learner_spec.rb +71 -0
- data/spec/models/ed_api_models_family_contact_password_spec.rb +41 -0
- data/spec/models/ed_api_models_learning_path_progress_row_spec.rb +137 -0
- data/spec/models/ed_api_models_location_spec.rb +59 -0
- data/spec/models/ed_api_models_location_structure_spec.rb +71 -0
- data/spec/models/ed_api_models_message_spec.rb +77 -0
- data/spec/models/ed_api_models_password_spec.rb +41 -0
- data/spec/models/ed_api_models_program_alert_summary_spec.rb +53 -0
- data/spec/models/ed_api_models_program_spec.rb +75 -0
- data/spec/models/ed_api_models_resource_node_spec.rb +71 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_activity_progress_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_activity_score_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_activity_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_activity_time_on_task_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_courseware_class_learner_grade_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_family_contact_learner_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_location_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_program_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_resource_node_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_user_class_assignment_spec.rb +47 -0
- data/spec/models/ed_api_models_results_with_count_ed_api_models_user_program_alert_summary_spec.rb +47 -0
- data/spec/models/ed_api_models_user_class_assignment_spec.rb +129 -0
- data/spec/models/ed_api_models_user_program_alert_summary_spec.rb +47 -0
- data/spec/models/ed_api_models_user_spec.rb +111 -0
- data/spec/models/ed_api_pageable_results_with_count_ed_api_models_class_detail_spec.rb +53 -0
- data/spec/models/ed_api_pageable_results_with_count_ed_api_models_class_spec.rb +53 -0
- data/spec/models/ed_api_pageable_results_with_count_ed_api_models_message_spec.rb +53 -0
- data/spec/models/ed_api_pageable_results_with_count_ed_api_models_user_spec.rb +53 -0
- data/spec/models/ed_api_pageable_results_with_count_ed_core_domain_reporting_user_time_on_system_spec.rb +53 -0
- data/spec/models/ed_core_domain_reporting_user_time_on_system_spec.rb +53 -0
- data/spec/models/ed_personalized_learning_domain_locations_location_spec.rb +47 -0
- data/spec/spec_helper.rb +111 -0
- metadata +442 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8847fba75f67e1b685b880e96348f9ccc74f1800375174f93d04afd5a0a26389
|
4
|
+
data.tar.gz: a503d99fffdfad4f018d4ed224e747fc67d4082afdd352db3d0b052cb5b83552
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 2a85bbf111026f7a32f4b6a972ce20259ec7c28b0735003bd6b1e549d21aa79341dc4c182c2bef6437004326ba05f7188ab9df8b159f333d06f118ddc67a65f2
|
7
|
+
data.tar.gz: 8dafd2753949e696fdff440da1a89b55b5bc10c013c7c7b8e6c72c4af9ac46c1d9c58746eb3aa1eebe31e72eafcf26c126306b9a175a533f8d73310f2a975681
|
data/CODEOWNERS
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
edmentum-client (1.0.0)
|
5
|
+
addressable (~> 2.3, >= 2.3.0)
|
6
|
+
json (~> 2.1, >= 2.1.0)
|
7
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
8
|
+
|
9
|
+
GEM
|
10
|
+
remote: https://rubygems.org/
|
11
|
+
specs:
|
12
|
+
ZenTest (4.12.1)
|
13
|
+
addressable (2.8.5)
|
14
|
+
public_suffix (>= 2.0.2, < 6.0)
|
15
|
+
autotest (4.4.6)
|
16
|
+
ZenTest (>= 4.4.1)
|
17
|
+
autotest-growl (0.2.16)
|
18
|
+
autotest-rails-pure (4.1.2)
|
19
|
+
crack (0.4.5)
|
20
|
+
rexml
|
21
|
+
diff-lcs (1.5.0)
|
22
|
+
ethon (0.16.0)
|
23
|
+
ffi (>= 1.15.0)
|
24
|
+
ffi (1.16.3)
|
25
|
+
hashdiff (1.0.1)
|
26
|
+
json (2.6.3)
|
27
|
+
public_suffix (5.0.3)
|
28
|
+
rake (12.3.3)
|
29
|
+
rexml (3.2.6)
|
30
|
+
rspec (3.12.0)
|
31
|
+
rspec-core (~> 3.12.0)
|
32
|
+
rspec-expectations (~> 3.12.0)
|
33
|
+
rspec-mocks (~> 3.12.0)
|
34
|
+
rspec-core (3.12.2)
|
35
|
+
rspec-support (~> 3.12.0)
|
36
|
+
rspec-expectations (3.12.3)
|
37
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
38
|
+
rspec-support (~> 3.12.0)
|
39
|
+
rspec-mocks (3.12.6)
|
40
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
41
|
+
rspec-support (~> 3.12.0)
|
42
|
+
rspec-support (3.12.1)
|
43
|
+
typhoeus (1.4.0)
|
44
|
+
ethon (>= 0.9.0)
|
45
|
+
vcr (3.0.3)
|
46
|
+
webmock (1.24.6)
|
47
|
+
addressable (>= 2.3.6)
|
48
|
+
crack (>= 0.3.2)
|
49
|
+
hashdiff
|
50
|
+
|
51
|
+
PLATFORMS
|
52
|
+
arm64-darwin-22
|
53
|
+
|
54
|
+
DEPENDENCIES
|
55
|
+
autotest (~> 4.4, >= 4.4.6)
|
56
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
57
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
58
|
+
edmentum-client!
|
59
|
+
rake (~> 12.3.3)
|
60
|
+
rspec (~> 3.6, >= 3.6.0)
|
61
|
+
vcr (~> 3.0, >= 3.0.1)
|
62
|
+
webmock (~> 1.24, >= 1.24.3)
|
63
|
+
|
64
|
+
BUNDLED WITH
|
65
|
+
2.4.19
|
data/README.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# edmentum-client-ruby
|
2
|
+
|
3
|
+
## What?
|
4
|
+
|
5
|
+
A ruby client that works with the Edmentum 2.0 APIs. Not official - built by StrongMind when we needed to interoperate
|
6
|
+
with Edmentum systems. Built using a swagger generator and then cleaned up to be suitable for usage.
|
7
|
+
|
8
|
+
## Where?
|
9
|
+
|
10
|
+
### Links
|
11
|
+
|
12
|
+
|
13
|
+
* [API Documentation](https://app.edmentum.com/api/help/index)
|
14
|
+
* [Github Repository](https://github.com/StrongMind/edmentum-client-ruby)
|
15
|
+
|
16
|
+
### CI/CD
|
17
|
+
|
18
|
+
* [https://github.com/StrongMind/edmentum-client-ruby/actions](https://github.com/StrongMind/project/actions)
|
19
|
+
|
20
|
+
## Local Install
|
21
|
+
|
22
|
+
To use in a project:
|
23
|
+
```shell
|
24
|
+
bundle add edmentum-client
|
25
|
+
```
|
26
|
+
|
27
|
+
To develop locally:
|
28
|
+
```shell
|
29
|
+
git clone https://github.com/StrongMind/edmentum-client-ruby.git
|
30
|
+
cd edmentum-client
|
31
|
+
bundle install
|
32
|
+
```
|
33
|
+
|
34
|
+
## Run tests locally
|
35
|
+
Tests are minimal due to auto-generation. We might add some in the future.
|
36
|
+
|
37
|
+
Uses rspec for testing. To run tests locally, for example:
|
38
|
+
```console
|
39
|
+
rspec
|
40
|
+
```
|
41
|
+
|
42
|
+
> Code owners can be found in [CODEOWNERS file](./CODEOWNERS)
|
43
|
+
|
44
|
+
## Usage
|
45
|
+
```ruby
|
46
|
+
require 'edmentum_client'
|
47
|
+
ec = ::EdmentumClient.configure do |config|
|
48
|
+
config.username = "mark.ng@strongmind.com@PRIMA" # Notice the PRIMA...this is the Account name
|
49
|
+
config.password = "YOUR REAL PASSWORD HERE"
|
50
|
+
config.client_id = "YOUR REAL ID HERE"
|
51
|
+
config.client_secret = "YOUR REAL SECRET HERE"
|
52
|
+
config.debugging = true
|
53
|
+
config.api_key['Authorization'] = ::EdmentumClient::Authentication.token(config)
|
54
|
+
end
|
55
|
+
|
56
|
+
aa = ::EdmentumClient::V20AdministrationCenterApi.new
|
57
|
+
aa.users_controller_get_users(100)
|
58
|
+
```
|
data/Rakefile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsActivity
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**resource_node_id** | **Integer** | | [optional]
|
7
|
+
**activity_title** | **String** | | [optional]
|
8
|
+
**sequence** | **Integer** | | [optional]
|
9
|
+
**gradetracker_category_id** | **Integer** | | [optional]
|
10
|
+
**gradetracker_category_name** | **String** | | [optional]
|
11
|
+
**gradetracker_possible_score** | **Float** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsActivityProgress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**learner_user_id** | **Integer** | | [optional]
|
7
|
+
**activities_completed** | **Integer** | | [optional]
|
8
|
+
**activities_total** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsActivityScore
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**resource_node_id** | **Integer** | | [optional]
|
7
|
+
**learner_user_id** | **Integer** | | [optional]
|
8
|
+
**score** | **Float** | | [optional]
|
9
|
+
**score_date** | **DateTime** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsActivityTimeOnTask
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**learner_user_id** | **Integer** | | [optional]
|
7
|
+
**date** | **DateTime** | | [optional]
|
8
|
+
**time_on_task** | **Integer** | | [optional]
|
9
|
+
**time_on_task_in_milliseconds** | **Integer** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsClass
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**program_id** | **Integer** | | [optional]
|
7
|
+
**resource_node_id** | **Integer** | |
|
8
|
+
**resource_version** | **Integer** | | [optional]
|
9
|
+
**resource_node_name** | **String** | | [optional]
|
10
|
+
**class_id** | **Integer** | | [optional]
|
11
|
+
**name** | **String** | |
|
12
|
+
**description** | **String** | | [optional]
|
13
|
+
**start_date** | **DateTime** | |
|
14
|
+
**end_date** | **DateTime** | | [optional]
|
15
|
+
**lock_assignment_on_due_date** | **BOOLEAN** | | [optional]
|
16
|
+
**allow_self_enroll** | **BOOLEAN** | | [optional]
|
17
|
+
**is_active** | **BOOLEAN** | |
|
18
|
+
**self_enroll_code** | **String** | | [optional]
|
19
|
+
**self_enroll_password** | **String** | | [optional]
|
20
|
+
**mastery_test_attempts** | **Integer** | | [optional]
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsClassDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**teachers** | **Array<Integer>** | | [optional]
|
7
|
+
**learners** | **Array<Integer>** | | [optional]
|
8
|
+
**program_id** | **Integer** | | [optional]
|
9
|
+
**resource_node_id** | **Integer** | |
|
10
|
+
**resource_version** | **Integer** | | [optional]
|
11
|
+
**resource_node_name** | **String** | | [optional]
|
12
|
+
**class_id** | **Integer** | | [optional]
|
13
|
+
**name** | **String** | |
|
14
|
+
**description** | **String** | | [optional]
|
15
|
+
**start_date** | **DateTime** | |
|
16
|
+
**end_date** | **DateTime** | | [optional]
|
17
|
+
**lock_assignment_on_due_date** | **BOOLEAN** | | [optional]
|
18
|
+
**allow_self_enroll** | **BOOLEAN** | | [optional]
|
19
|
+
**is_active** | **BOOLEAN** | |
|
20
|
+
**self_enroll_code** | **String** | | [optional]
|
21
|
+
**self_enroll_password** | **String** | | [optional]
|
22
|
+
**mastery_test_attempts** | **Integer** | | [optional]
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsClassStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**class_id** | **Integer** | | [optional]
|
7
|
+
**resource_node_id** | **Integer** | | [optional]
|
8
|
+
**is_locked** | **BOOLEAN** | |
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsClassUserStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**user_id** | **Integer** | | [optional]
|
7
|
+
**class_id** | **Integer** | | [optional]
|
8
|
+
**resource_node_id** | **Integer** | | [optional]
|
9
|
+
**is_locked** | **BOOLEAN** | |
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsCoursewareClassLearnerGrade
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**learner_user_id** | **Integer** | | [optional]
|
7
|
+
**current_grade** | **Float** | | [optional]
|
8
|
+
**course_grade** | **Float** | | [optional]
|
9
|
+
**on_target_grade** | **Float** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsCreateUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**plato_name** | **String** | |
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**middle_name** | **String** | | [optional]
|
10
|
+
**sis_id** | **String** | | [optional]
|
11
|
+
**state_id** | **String** | | [optional]
|
12
|
+
**federal_id** | **String** | | [optional]
|
13
|
+
**role** | **String** | |
|
14
|
+
**email_address** | **String** | | [optional]
|
15
|
+
**grade** | **Integer** | |
|
16
|
+
**is_active** | **BOOLEAN** | |
|
17
|
+
**password** | **String** | |
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsExactPathClass
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**class_id** | **Integer** | | [optional]
|
7
|
+
**program_id** | **Integer** | | [optional]
|
8
|
+
**class_expiration_date** | **DateTime** | | [optional]
|
9
|
+
**class_name** | **String** | | [optional]
|
10
|
+
**class_grade** | **Integer** | | [optional]
|
11
|
+
**description** | **String** | | [optional]
|
12
|
+
**closeout_reminder_date** | **DateTime** | | [optional]
|
13
|
+
**allow_self_enrollment** | **BOOLEAN** | | [optional]
|
14
|
+
**instructors** | **Array<Integer>** | | [optional]
|
15
|
+
**learners** | **Array<Integer>** | | [optional]
|
16
|
+
**location** | [**EdPersonalizedLearningDomainLocationsLocation**](EdPersonalizedLearningDomainLocationsLocation.md) | | [optional]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsExactPathClassLearner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**user_id** | **Integer** | |
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**grade** | **Integer** | |
|
10
|
+
**gender** | **Integer** | | [optional]
|
11
|
+
**birth_date** | **DateTime** | | [optional]
|
12
|
+
**is_active** | **BOOLEAN** | |
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsExactPathLearningPathProgressReport
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**class_id** | **Integer** | | [optional]
|
7
|
+
**class_name** | **String** | | [optional]
|
8
|
+
**learning_path_progress_records** | [**Array<EdApiModelsLearningPathProgressRow>**](EdApiModelsLearningPathProgressRow.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsExactPathLearningPathProgressReportQuery
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**subject_id** | **Integer** | | [optional]
|
7
|
+
**start_date** | **DateTime** | | [optional]
|
8
|
+
**end_date** | **DateTime** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsFamilyContactLearner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**family_contact_id** | **Integer** | | [optional]
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**email_address** | **String** | | [optional]
|
10
|
+
**relationship** | **String** | | [optional]
|
11
|
+
**opt_out_of_emails** | **BOOLEAN** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsFamilyContactLearnerCreate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**password** | **String** | |
|
7
|
+
**first_name** | **String** | |
|
8
|
+
**last_name** | **String** | |
|
9
|
+
**email_address** | **String** | | [optional]
|
10
|
+
**relationship** | **String** | | [optional]
|
11
|
+
**opt_out_of_emails** | **BOOLEAN** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsLearningPathProgressRow
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**activities_completed** | **Integer** | | [optional]
|
7
|
+
**grade** | **String** | | [optional]
|
8
|
+
**skills_attempted** | **Integer** | | [optional]
|
9
|
+
**skills_mastered_first_attempt** | **Integer** | | [optional]
|
10
|
+
**skills_mastered_second_attempt** | **Integer** | | [optional]
|
11
|
+
**skills_not_mastered** | **Integer** | | [optional]
|
12
|
+
**student_information_system_id** | **String** | | [optional]
|
13
|
+
**student_location** | **String** | | [optional]
|
14
|
+
**student_name** | **String** | | [optional]
|
15
|
+
**student_classes** | **String** | | [optional]
|
16
|
+
**time_on_task_learning_path_content_with_progress_check** | **String** | | [optional]
|
17
|
+
**time_on_task_learning_path_content_with_progress_check_as_string** | **String** | | [optional]
|
18
|
+
**total_system_time** | **String** | | [optional]
|
19
|
+
**total_system_time_as_string** | **String** | | [optional]
|
20
|
+
**last_use_date_language_arts** | **DateTime** | | [optional]
|
21
|
+
**last_use_date_mathematics** | **DateTime** | | [optional]
|
22
|
+
**last_use_date_reading** | **DateTime** | | [optional]
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsLocation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**location_name** | **String** | | [optional]
|
7
|
+
**location_id** | **Integer** | | [optional]
|
8
|
+
**parent_id** | **Integer** | | [optional]
|
9
|
+
**has_chidren** | **BOOLEAN** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsLocationStructure
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**has_children** | **BOOLEAN** | | [optional]
|
7
|
+
**children** | [**Array<EdApiModelsLocationStructure>**](EdApiModelsLocationStructure.md) | | [optional]
|
8
|
+
**location_name** | **String** | | [optional]
|
9
|
+
**location_id** | **Integer** | | [optional]
|
10
|
+
**parent_id** | **Integer** | | [optional]
|
11
|
+
**has_chidren** | **BOOLEAN** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**user_message_history_id** | **Integer** | | [optional]
|
7
|
+
**sender_user_id** | **Integer** | | [optional]
|
8
|
+
**recipient_user_id** | **Integer** | | [optional]
|
9
|
+
**recipient_class_id** | **Integer** | | [optional]
|
10
|
+
**message_subject** | **String** | | [optional]
|
11
|
+
**message_text** | **String** | | [optional]
|
12
|
+
**sent_date** | **DateTime** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsProgram
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**program_id** | **Integer** | | [optional]
|
7
|
+
**program_title** | **String** | | [optional]
|
8
|
+
**application** | **Integer** | | [optional]
|
9
|
+
**access_type** | **String** | | [optional]
|
10
|
+
**locations** | [**Array<EdApiModelsLocation>**](EdApiModelsLocation.md) | | [optional]
|
11
|
+
**is_eoa_program** | **BOOLEAN** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsProgramAlertSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**count_of_new_messages_and_announcements** | **Integer** | | [optional]
|
7
|
+
**count_of_locked_mastery_tests** | **Integer** | | [optional]
|
8
|
+
**count_of_ready_to_score_activities** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResourceNode
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**resource_name** | **String** | | [optional]
|
7
|
+
**resource_node_id** | **Integer** | | [optional]
|
8
|
+
**resource_version** | **Integer** | | [optional]
|
9
|
+
**resource_type** | **String** | | [optional]
|
10
|
+
**has_children** | **BOOLEAN** | | [optional]
|
11
|
+
**children** | [**Array<EdApiModelsResourceNode>**](EdApiModelsResourceNode.md) | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsActivity
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsActivity>**](EdApiModelsActivity.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsActivityProgress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsActivityProgress>**](EdApiModelsActivityProgress.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsActivityScore
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsActivityScore>**](EdApiModelsActivityScore.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsActivityTimeOnTask
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsActivityTimeOnTask>**](EdApiModelsActivityTimeOnTask.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsCoursewareClassLearnerGrade
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsCoursewareClassLearnerGrade>**](EdApiModelsCoursewareClassLearnerGrade.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsFamilyContactLearner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsFamilyContactLearner>**](EdApiModelsFamilyContactLearner.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsLocation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsLocation>**](EdApiModelsLocation.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsProgram
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsProgram>**](EdApiModelsProgram.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsResourceNode
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsResourceNode>**](EdApiModelsResourceNode.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# SwaggerClient::EdApiModelsResultsWithCountEdApiModelsUserClassAssignment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**results** | [**Array<EdApiModelsUserClassAssignment>**](EdApiModelsUserClassAssignment.md) | | [optional]
|
7
|
+
**count** | **Integer** | | [optional]
|
8
|
+
|
9
|
+
|