rustici_software_cloud_v2 1.0.0beta
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +7 -0
- data/LICENSE +201 -0
- data/README.md +283 -0
- data/Rakefile +8 -0
- data/docs/ActivityResultSchema.md +20 -0
- data/docs/ApplicationListSchema.md +8 -0
- data/docs/ApplicationManagementApi.md +570 -0
- data/docs/ApplicationSchema.md +9 -0
- data/docs/ApplicationToken.md +10 -0
- data/docs/AuthenticationApi.md +64 -0
- data/docs/CommentSchema.md +10 -0
- data/docs/CompletionAmountSchema.md +8 -0
- data/docs/CourseActivitySchema.md +15 -0
- data/docs/CourseApi.md +1459 -0
- data/docs/CourseListNonPagedSchema.md +8 -0
- data/docs/CourseListSchema.md +9 -0
- data/docs/CourseReferenceSchema.md +10 -0
- data/docs/CourseSchema.md +20 -0
- data/docs/CourseTagsBatchSchema.md +9 -0
- data/docs/CreateRegistrationSchema.md +17 -0
- data/docs/CredentialCreatedSchema.md +12 -0
- data/docs/CredentialListSchema.md +8 -0
- data/docs/CredentialRequestSchema.md +9 -0
- data/docs/CredentialSchema.md +12 -0
- data/docs/ImportFetchRequestSchema.md +8 -0
- data/docs/ImportJobResultSchema.md +11 -0
- data/docs/ImportResultSchema.md +11 -0
- data/docs/IntegerResultSchema.md +8 -0
- data/docs/ItemValuePairSchema.md +9 -0
- data/docs/LaunchHistoryListSchema.md +8 -0
- data/docs/LaunchHistorySchema.md +17 -0
- data/docs/LaunchLinkRequestSchema.md +17 -0
- data/docs/LaunchLinkSchema.md +8 -0
- data/docs/LearnerPreferenceSchema.md +11 -0
- data/docs/LearnerSchema.md +11 -0
- data/docs/LinkSchema.md +8 -0
- data/docs/MessageSchema.md +8 -0
- data/docs/MetadataSchema.md +14 -0
- data/docs/ObjectiveSchema.md +20 -0
- data/docs/PermissionsSchema.md +9 -0
- data/docs/PingApi.md +57 -0
- data/docs/PingSchema.md +8 -0
- data/docs/PostBackSchema.md +12 -0
- data/docs/RegistrationApi.md +1490 -0
- data/docs/RegistrationCompletion.md +7 -0
- data/docs/RegistrationListSchema.md +9 -0
- data/docs/RegistrationSchema.md +27 -0
- data/docs/RegistrationSuccess.md +7 -0
- data/docs/RegistrationTagsBatchSchema.md +9 -0
- data/docs/ResponseError.md +8 -0
- data/docs/RuntimeInteractionSchema.md +18 -0
- data/docs/RuntimeObjectiveSchema.md +16 -0
- data/docs/RuntimeSchema.md +27 -0
- data/docs/ScoreSchema.md +8 -0
- data/docs/SettingItem.md +12 -0
- data/docs/SettingListSchema.md +8 -0
- data/docs/SettingMetadata.md +15 -0
- data/docs/SettingMetadataValidValues.md +9 -0
- data/docs/SettingValidValue.md +9 -0
- data/docs/SettingsIndividualSchema.md +10 -0
- data/docs/SettingsPostSchema.md +8 -0
- data/docs/SharedDataEntrySchema.md +9 -0
- data/docs/StaticPropertiesSchema.md +13 -0
- data/docs/StringResultSchema.md +8 -0
- data/docs/TagListSchema.md +8 -0
- data/docs/TagPostSchema.md +7 -0
- data/docs/TitleSchema.md +8 -0
- data/docs/TokenRequestSchema.md +9 -0
- data/docs/XapiAccount.md +9 -0
- data/docs/XapiActivity.md +10 -0
- data/docs/XapiActivityDefinition.md +19 -0
- data/docs/XapiAgentGroup.md +14 -0
- data/docs/XapiAttachment.md +14 -0
- data/docs/XapiContext.md +16 -0
- data/docs/XapiContextActivity.md +11 -0
- data/docs/XapiInteractionComponent.md +9 -0
- data/docs/XapiResult.md +13 -0
- data/docs/XapiScore.md +11 -0
- data/docs/XapiStatement.md +20 -0
- data/docs/XapiStatementReference.md +9 -0
- data/docs/XapiStatementResult.md +9 -0
- data/docs/XapiVerb.md +9 -0
- data/git_push.sh +55 -0
- data/lib/rustici_software_cloud_v2.rb +116 -0
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +574 -0
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +87 -0
- data/lib/rustici_software_cloud_v2/api/course_api.rb +1469 -0
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +69 -0
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +1499 -0
- data/lib/rustici_software_cloud_v2/api_client.rb +389 -0
- data/lib/rustici_software_cloud_v2/api_error.rb +38 -0
- data/lib/rustici_software_cloud_v2/configuration.rb +237 -0
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +341 -0
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/application_token.rb +201 -0
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +201 -0
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +184 -0
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +289 -0
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +202 -0
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +328 -0
- data/lib/rustici_software_cloud_v2/models/course_tags_batch_schema.rb +204 -0
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +287 -0
- data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +223 -0
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +194 -0
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +223 -0
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +190 -0
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +244 -0
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +215 -0
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +192 -0
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +317 -0
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +282 -0
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +210 -0
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +216 -0
- data/lib/rustici_software_cloud_v2/models/link_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +239 -0
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +355 -0
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +195 -0
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +273 -0
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +31 -0
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +199 -0
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +360 -0
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +31 -0
- data/lib/rustici_software_cloud_v2/models/registration_tags_batch_schema.rb +204 -0
- data/lib/rustici_software_cloud_v2/models/response_error.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +311 -0
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +305 -0
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +398 -0
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +184 -0
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +256 -0
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +190 -0
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +294 -0
- data/lib/rustici_software_cloud_v2/models/setting_metadata_valid_values.rb +209 -0
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +193 -0
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +203 -0
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +192 -0
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +228 -0
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +188 -0
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +185 -0
- data/lib/rustici_software_cloud_v2/models/tag_post_schema.rb +174 -0
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +183 -0
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +203 -0
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +203 -0
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +209 -0
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +301 -0
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +279 -0
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +267 -0
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +258 -0
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +219 -0
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +200 -0
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +231 -0
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +211 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +294 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +205 -0
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +200 -0
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +200 -0
- data/lib/rustici_software_cloud_v2/version.rb +15 -0
- data/rustici_software_cloud_v2.gemspec +45 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/activity_result_schema_spec.rb +133 -0
- data/spec/models/application_list_schema_spec.rb +53 -0
- data/spec/models/application_schema_spec.rb +59 -0
- data/spec/models/application_token_spec.rb +65 -0
- data/spec/models/comment_schema_spec.rb +65 -0
- data/spec/models/completion_amount_schema_spec.rb +53 -0
- data/spec/models/course_activity_schema_spec.rb +99 -0
- data/spec/models/course_list_non_paged_schema_spec.rb +53 -0
- data/spec/models/course_list_schema_spec.rb +59 -0
- data/spec/models/course_reference_schema_spec.rb +65 -0
- data/spec/models/course_schema_spec.rb +129 -0
- data/spec/models/create_registration_schema_spec.rb +107 -0
- data/spec/models/credential_created_schema_spec.rb +77 -0
- data/spec/models/credential_list_schema_spec.rb +53 -0
- data/spec/models/credential_request_schema_spec.rb +59 -0
- data/spec/models/credential_schema_spec.rb +77 -0
- data/spec/models/import_fetch_request_schema_spec.rb +53 -0
- data/spec/models/import_job_result_schema_spec.rb +75 -0
- data/spec/models/import_result_schema_spec.rb +71 -0
- data/spec/models/integer_result_schema_spec.rb +53 -0
- data/spec/models/item_value_pair_schema_spec.rb +59 -0
- data/spec/models/launch_history_list_schema_spec.rb +53 -0
- data/spec/models/launch_history_schema_spec.rb +115 -0
- data/spec/models/launch_link_request_schema_spec.rb +107 -0
- data/spec/models/launch_link_schema_spec.rb +53 -0
- data/spec/models/learner_preference_schema_spec.rb +71 -0
- data/spec/models/learner_schema_spec.rb +71 -0
- data/spec/models/link_schema_spec.rb +53 -0
- data/spec/models/message_schema_spec.rb +53 -0
- data/spec/models/metadata_schema_spec.rb +89 -0
- data/spec/models/objective_schema_spec.rb +137 -0
- data/spec/models/permissions_schema_spec.rb +59 -0
- data/spec/models/ping_schema_spec.rb +53 -0
- data/spec/models/post_back_schema_spec.rb +85 -0
- data/spec/models/registration_completion_spec.rb +47 -0
- data/spec/models/registration_list_schema_spec.rb +59 -0
- data/spec/models/registration_schema_spec.rb +167 -0
- data/spec/models/registration_success_spec.rb +47 -0
- data/spec/models/response_error_spec.rb +53 -0
- data/spec/models/runtime_interaction_schema_spec.rb +117 -0
- data/spec/models/runtime_objective_schema_spec.rb +109 -0
- data/spec/models/runtime_schema_spec.rb +171 -0
- data/spec/models/score_schema_spec.rb +53 -0
- data/spec/models/setting_item_spec.rb +81 -0
- data/spec/models/setting_list_schema_spec.rb +53 -0
- data/spec/models/setting_metadata_spec.rb +99 -0
- data/spec/models/setting_metadata_valid_values_spec.rb +59 -0
- data/spec/models/settings_individual_schema_spec.rb +65 -0
- data/spec/models/settings_post_schema_spec.rb +53 -0
- data/spec/models/shared_data_entry_schema_spec.rb +59 -0
- data/spec/models/static_properties_schema_spec.rb +83 -0
- data/spec/models/string_result_schema_spec.rb +53 -0
- data/spec/models/title_schema_spec.rb +53 -0
- data/spec/models/token_request_schema_spec.rb +59 -0
- data/spec/spec_helper.rb +122 -0
- data/swagger-codegen.config +11 -0
- metadata +526 -0
@@ -0,0 +1,9 @@
|
|
1
|
+
# RusticiSoftwareCloudV2::ApplicationSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The application id for this application. | [optional]
|
7
|
+
**name** | **String** | The name of this application. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# RusticiSoftwareCloudV2::ApplicationToken
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**access_token** | **String** | | [optional]
|
7
|
+
**expires_in** | **Integer** | | [optional]
|
8
|
+
**token_type** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# RusticiSoftwareCloudV2::AuthenticationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_app_token**](AuthenticationApi.md#get_app_token) | **POST** /oauth/authenticate/application/token | Authenticates for a oauth token
|
8
|
+
|
9
|
+
|
10
|
+
# **get_app_token**
|
11
|
+
> ApplicationToken get_app_token(scope, opts)
|
12
|
+
|
13
|
+
Authenticates for a oauth token
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'rustici_software_cloud_v2'
|
19
|
+
# setup authorization
|
20
|
+
RusticiSoftwareCloudV2.configure do |config|
|
21
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
22
|
+
config.username = 'YOUR USERNAME'
|
23
|
+
config.password = 'YOUR PASSWORD'
|
24
|
+
end
|
25
|
+
|
26
|
+
api_instance = RusticiSoftwareCloudV2::AuthenticationApi.new
|
27
|
+
|
28
|
+
scope = 'scope_example' # String |
|
29
|
+
|
30
|
+
opts = {
|
31
|
+
expiration: 300 # Integer |
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Authenticates for a oauth token
|
36
|
+
result = api_instance.get_app_token(scope, opts)
|
37
|
+
p result
|
38
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
39
|
+
puts "Exception when calling AuthenticationApi->get_app_token: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**scope** | **String**| |
|
48
|
+
**expiration** | **Integer**| | [optional] [default to 300]
|
49
|
+
|
50
|
+
### Return type
|
51
|
+
|
52
|
+
[**ApplicationToken**](ApplicationToken.md)
|
53
|
+
|
54
|
+
### Authorization
|
55
|
+
|
56
|
+
[APP_NORMAL](../README.md#APP_NORMAL)
|
57
|
+
|
58
|
+
### HTTP request headers
|
59
|
+
|
60
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
61
|
+
- **Accept**: application/json
|
62
|
+
|
63
|
+
|
64
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# RusticiSoftwareCloudV2::CommentSchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**value** | **String** | | [optional]
|
7
|
+
**location** | **String** | | [optional]
|
8
|
+
**date_time** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# RusticiSoftwareCloudV2::CourseActivitySchema
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**external_identifier** | **String** | An arbitrary identifier that the external LMS system can associate with this LearningObject to track it as it isreused across courses | [optional]
|
7
|
+
**item_identifier** | **String** | The string which identifies this activity in the context of its course | [optional]
|
8
|
+
**resource_identifier** | **String** | The string which identifies this activity's resource in a course's manifest | [optional]
|
9
|
+
**activity_type** | **String** | The type of activity this is | [optional]
|
10
|
+
**href** | **String** | The web path used to launch this activity | [optional]
|
11
|
+
**scaled_passing_score** | **String** | The score required of a learner to pass this activity | [optional]
|
12
|
+
**title** | **String** | The title of the activity | [optional]
|
13
|
+
**children** | [**Array<CourseActivitySchema>**](CourseActivitySchema.md) | | [optional]
|
14
|
+
|
15
|
+
|
data/docs/CourseApi.md
ADDED
@@ -0,0 +1,1459 @@
|
|
1
|
+
# RusticiSoftwareCloudV2::CourseApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://cloud.scorm.com/api/v2/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**build_course_preview_launch_link**](CourseApi.md#build_course_preview_launch_link) | **POST** /courses/{courseId}/preview | Returns the launch link to use to preview this course
|
8
|
+
[**build_course_preview_launch_link_with_version**](CourseApi.md#build_course_preview_launch_link_with_version) | **POST** /courses/{courseId}/versions/{versionId}/preview | Returns the link to use to preview this course
|
9
|
+
[**create_fetch_and_import_course_job**](CourseApi.md#create_fetch_and_import_course_job) | **POST** /courses/importJobs | Start a job to fetch and import a course.
|
10
|
+
[**create_upload_and_import_course_job**](CourseApi.md#create_upload_and_import_course_job) | **POST** /courses/importJobs/upload | Upload a course and start an import job for it.
|
11
|
+
[**delete_course**](CourseApi.md#delete_course) | **DELETE** /courses/{courseId} | Delete `courseId`
|
12
|
+
[**delete_course_configuration_setting**](CourseApi.md#delete_course_configuration_setting) | **DELETE** /courses/{courseId}/configuration/{settingId} | Clears the `settingId` value for this course
|
13
|
+
[**delete_course_tags**](CourseApi.md#delete_course_tags) | **DELETE** /courses/{courseId}/tags | Delete tags for this course
|
14
|
+
[**delete_course_version**](CourseApi.md#delete_course_version) | **DELETE** /courses/{courseId}/versions/{versionId} | Delete version `versionId` of `courseId`
|
15
|
+
[**delete_course_version_configuration_setting**](CourseApi.md#delete_course_version_configuration_setting) | **DELETE** /courses/{courseId}/versions/{versionId}/configuration/{settingId} | Clears the `settingId` value for this course and version.
|
16
|
+
[**get_course**](CourseApi.md#get_course) | **GET** /courses/{courseId} | Get information about `courseId`
|
17
|
+
[**get_course_configuration**](CourseApi.md#get_course_configuration) | **GET** /courses/{courseId}/configuration | Returns all configuration settings for this course
|
18
|
+
[**get_course_statements**](CourseApi.md#get_course_statements) | **GET** /courses/{courseId}/xAPIStatements | Get xAPI statements for `courseId`
|
19
|
+
[**get_course_tags**](CourseApi.md#get_course_tags) | **GET** /courses/{courseId}/tags | Get the tags for this course
|
20
|
+
[**get_course_version_configuration**](CourseApi.md#get_course_version_configuration) | **GET** /courses/{courseId}/versions/{versionId}/configuration | Returns all configuration settings for this course and version.
|
21
|
+
[**get_course_version_info**](CourseApi.md#get_course_version_info) | **GET** /courses/{courseId}/versions/{versionId} | Get version `versionId` of `courseId`
|
22
|
+
[**get_course_version_statements**](CourseApi.md#get_course_version_statements) | **GET** /courses/{courseId}/versions/{versionId}/xAPIStatements | Get xAPI statements for version `versionId` of `courseId`
|
23
|
+
[**get_course_versions**](CourseApi.md#get_course_versions) | **GET** /courses/{courseId}/versions | Get all versions of `courseId`
|
24
|
+
[**get_courses**](CourseApi.md#get_courses) | **GET** /courses | Get all courses for `appId`
|
25
|
+
[**get_import_job_status**](CourseApi.md#get_import_job_status) | **GET** /courses/importJobs/{importJobId} | Check the status of an import job.
|
26
|
+
[**put_course_tags**](CourseApi.md#put_course_tags) | **PUT** /courses/{courseId}/tags | Set the tags for this course
|
27
|
+
[**put_course_tags_batch**](CourseApi.md#put_course_tags_batch) | **PUT** /courses/tags | Sets all of the provided tags on all of the provided courses
|
28
|
+
[**set_course_configuration**](CourseApi.md#set_course_configuration) | **POST** /courses/{courseId}/configuration | Set configuration settings for this course.
|
29
|
+
[**set_course_title**](CourseApi.md#set_course_title) | **PUT** /courses/{courseId}/title | Sets the course title for `courseId`
|
30
|
+
[**set_course_version_configuration**](CourseApi.md#set_course_version_configuration) | **POST** /courses/{courseId}/versions/{versionId}/configuration | Set configuration settings for this course and version.
|
31
|
+
|
32
|
+
|
33
|
+
# **build_course_preview_launch_link**
|
34
|
+
> LaunchLinkSchema build_course_preview_launch_link(course_id, launch_link_request, opts)
|
35
|
+
|
36
|
+
Returns the launch link to use to preview this course
|
37
|
+
|
38
|
+
### Example
|
39
|
+
```ruby
|
40
|
+
# load the gem
|
41
|
+
require 'rustici_software_cloud_v2'
|
42
|
+
# setup authorization
|
43
|
+
RusticiSoftwareCloudV2.configure do |config|
|
44
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
45
|
+
config.username = 'YOUR USERNAME'
|
46
|
+
config.password = 'YOUR PASSWORD'
|
47
|
+
|
48
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
49
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
50
|
+
end
|
51
|
+
|
52
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
53
|
+
|
54
|
+
course_id = 'course_id_example' # String |
|
55
|
+
|
56
|
+
launch_link_request = RusticiSoftwareCloudV2::LaunchLinkRequestSchema.new # LaunchLinkRequestSchema |
|
57
|
+
|
58
|
+
opts = {
|
59
|
+
css_url: 'css_url_example' # String |
|
60
|
+
}
|
61
|
+
|
62
|
+
begin
|
63
|
+
#Returns the launch link to use to preview this course
|
64
|
+
result = api_instance.build_course_preview_launch_link(course_id, launch_link_request, opts)
|
65
|
+
p result
|
66
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
67
|
+
puts "Exception when calling CourseApi->build_course_preview_launch_link: #{e}"
|
68
|
+
end
|
69
|
+
```
|
70
|
+
|
71
|
+
### Parameters
|
72
|
+
|
73
|
+
Name | Type | Description | Notes
|
74
|
+
------------- | ------------- | ------------- | -------------
|
75
|
+
**course_id** | **String**| |
|
76
|
+
**launch_link_request** | [**LaunchLinkRequestSchema**](LaunchLinkRequestSchema.md)| |
|
77
|
+
**css_url** | **String**| | [optional]
|
78
|
+
|
79
|
+
### Return type
|
80
|
+
|
81
|
+
[**LaunchLinkSchema**](LaunchLinkSchema.md)
|
82
|
+
|
83
|
+
### Authorization
|
84
|
+
|
85
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
86
|
+
|
87
|
+
### HTTP request headers
|
88
|
+
|
89
|
+
- **Content-Type**: application/json
|
90
|
+
- **Accept**: application/json
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
# **build_course_preview_launch_link_with_version**
|
95
|
+
> LaunchLinkSchema build_course_preview_launch_link_with_version(course_id, version_id, launch_link_request)
|
96
|
+
|
97
|
+
Returns the link to use to preview this course
|
98
|
+
|
99
|
+
### Example
|
100
|
+
```ruby
|
101
|
+
# load the gem
|
102
|
+
require 'rustici_software_cloud_v2'
|
103
|
+
# setup authorization
|
104
|
+
RusticiSoftwareCloudV2.configure do |config|
|
105
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
106
|
+
config.username = 'YOUR USERNAME'
|
107
|
+
config.password = 'YOUR PASSWORD'
|
108
|
+
|
109
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
110
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
114
|
+
|
115
|
+
course_id = 'course_id_example' # String |
|
116
|
+
|
117
|
+
version_id = 56 # Integer | The course version
|
118
|
+
|
119
|
+
launch_link_request = RusticiSoftwareCloudV2::LaunchLinkRequestSchema.new # LaunchLinkRequestSchema |
|
120
|
+
|
121
|
+
|
122
|
+
begin
|
123
|
+
#Returns the link to use to preview this course
|
124
|
+
result = api_instance.build_course_preview_launch_link_with_version(course_id, version_id, launch_link_request)
|
125
|
+
p result
|
126
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
127
|
+
puts "Exception when calling CourseApi->build_course_preview_launch_link_with_version: #{e}"
|
128
|
+
end
|
129
|
+
```
|
130
|
+
|
131
|
+
### Parameters
|
132
|
+
|
133
|
+
Name | Type | Description | Notes
|
134
|
+
------------- | ------------- | ------------- | -------------
|
135
|
+
**course_id** | **String**| |
|
136
|
+
**version_id** | **Integer**| The course version |
|
137
|
+
**launch_link_request** | [**LaunchLinkRequestSchema**](LaunchLinkRequestSchema.md)| |
|
138
|
+
|
139
|
+
### Return type
|
140
|
+
|
141
|
+
[**LaunchLinkSchema**](LaunchLinkSchema.md)
|
142
|
+
|
143
|
+
### Authorization
|
144
|
+
|
145
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
146
|
+
|
147
|
+
### HTTP request headers
|
148
|
+
|
149
|
+
- **Content-Type**: application/json
|
150
|
+
- **Accept**: application/json
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
# **create_fetch_and_import_course_job**
|
155
|
+
> StringResultSchema create_fetch_and_import_course_job(course_id, import_request, opts)
|
156
|
+
|
157
|
+
Start a job to fetch and import a course.
|
158
|
+
|
159
|
+
An import job will be started to fetch and import the referenced file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.\"
|
160
|
+
|
161
|
+
### Example
|
162
|
+
```ruby
|
163
|
+
# load the gem
|
164
|
+
require 'rustici_software_cloud_v2'
|
165
|
+
# setup authorization
|
166
|
+
RusticiSoftwareCloudV2.configure do |config|
|
167
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
168
|
+
config.username = 'YOUR USERNAME'
|
169
|
+
config.password = 'YOUR PASSWORD'
|
170
|
+
|
171
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
172
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
173
|
+
end
|
174
|
+
|
175
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
176
|
+
|
177
|
+
course_id = 'course_id_example' # String | A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
|
178
|
+
|
179
|
+
import_request = RusticiSoftwareCloudV2::ImportFetchRequestSchema.new # ImportFetchRequestSchema |
|
180
|
+
|
181
|
+
opts = {
|
182
|
+
may_create_new_version: false, # BOOLEAN | Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn't already exist.
|
183
|
+
postback_url: 'postback_url_example' # String | An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
|
184
|
+
}
|
185
|
+
|
186
|
+
begin
|
187
|
+
#Start a job to fetch and import a course.
|
188
|
+
result = api_instance.create_fetch_and_import_course_job(course_id, import_request, opts)
|
189
|
+
p result
|
190
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
191
|
+
puts "Exception when calling CourseApi->create_fetch_and_import_course_job: #{e}"
|
192
|
+
end
|
193
|
+
```
|
194
|
+
|
195
|
+
### Parameters
|
196
|
+
|
197
|
+
Name | Type | Description | Notes
|
198
|
+
------------- | ------------- | ------------- | -------------
|
199
|
+
**course_id** | **String**| A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use. |
|
200
|
+
**import_request** | [**ImportFetchRequestSchema**](ImportFetchRequestSchema.md)| |
|
201
|
+
**may_create_new_version** | **BOOLEAN**| Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn't already exist. | [optional] [default to false]
|
202
|
+
**postback_url** | **String**| An optional parameter that specifies a URL to send a postback to when the course has finished uploading. | [optional]
|
203
|
+
|
204
|
+
### Return type
|
205
|
+
|
206
|
+
[**StringResultSchema**](StringResultSchema.md)
|
207
|
+
|
208
|
+
### Authorization
|
209
|
+
|
210
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
211
|
+
|
212
|
+
### HTTP request headers
|
213
|
+
|
214
|
+
- **Content-Type**: application/json
|
215
|
+
- **Accept**: application/json
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
# **create_upload_and_import_course_job**
|
220
|
+
> StringResultSchema create_upload_and_import_course_job(course_id, , opts)
|
221
|
+
|
222
|
+
Upload a course and start an import job for it.
|
223
|
+
|
224
|
+
An import job will be started to import the posted file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.
|
225
|
+
|
226
|
+
### Example
|
227
|
+
```ruby
|
228
|
+
# load the gem
|
229
|
+
require 'rustici_software_cloud_v2'
|
230
|
+
# setup authorization
|
231
|
+
RusticiSoftwareCloudV2.configure do |config|
|
232
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
233
|
+
config.username = 'YOUR USERNAME'
|
234
|
+
config.password = 'YOUR PASSWORD'
|
235
|
+
|
236
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
237
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
238
|
+
end
|
239
|
+
|
240
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
241
|
+
|
242
|
+
course_id = 'course_id_example' # String | A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
|
243
|
+
|
244
|
+
opts = {
|
245
|
+
may_create_new_version: false, # BOOLEAN | Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn't already exist.
|
246
|
+
file: File.new('/path/to/file.txt'), # File | The zip file of the course contents to import.
|
247
|
+
postback_url: 'postback_url_example' # String | An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
|
248
|
+
}
|
249
|
+
|
250
|
+
begin
|
251
|
+
#Upload a course and start an import job for it.
|
252
|
+
result = api_instance.create_upload_and_import_course_job(course_id, , opts)
|
253
|
+
p result
|
254
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
255
|
+
puts "Exception when calling CourseApi->create_upload_and_import_course_job: #{e}"
|
256
|
+
end
|
257
|
+
```
|
258
|
+
|
259
|
+
### Parameters
|
260
|
+
|
261
|
+
Name | Type | Description | Notes
|
262
|
+
------------- | ------------- | ------------- | -------------
|
263
|
+
**course_id** | **String**| A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use. |
|
264
|
+
**may_create_new_version** | **BOOLEAN**| Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn't already exist. | [optional] [default to false]
|
265
|
+
**file** | **File**| The zip file of the course contents to import. | [optional]
|
266
|
+
**postback_url** | **String**| An optional parameter that specifies a URL to send a postback to when the course has finished uploading. | [optional]
|
267
|
+
|
268
|
+
### Return type
|
269
|
+
|
270
|
+
[**StringResultSchema**](StringResultSchema.md)
|
271
|
+
|
272
|
+
### Authorization
|
273
|
+
|
274
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
275
|
+
|
276
|
+
### HTTP request headers
|
277
|
+
|
278
|
+
- **Content-Type**: multipart/form-data
|
279
|
+
- **Accept**: application/json
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
# **delete_course**
|
284
|
+
> delete_course(course_id, )
|
285
|
+
|
286
|
+
Delete `courseId`
|
287
|
+
|
288
|
+
### Example
|
289
|
+
```ruby
|
290
|
+
# load the gem
|
291
|
+
require 'rustici_software_cloud_v2'
|
292
|
+
# setup authorization
|
293
|
+
RusticiSoftwareCloudV2.configure do |config|
|
294
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
295
|
+
config.username = 'YOUR USERNAME'
|
296
|
+
config.password = 'YOUR PASSWORD'
|
297
|
+
|
298
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
299
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
300
|
+
end
|
301
|
+
|
302
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
303
|
+
|
304
|
+
course_id = 'course_id_example' # String |
|
305
|
+
|
306
|
+
|
307
|
+
begin
|
308
|
+
#Delete `courseId`
|
309
|
+
api_instance.delete_course(course_id, )
|
310
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
311
|
+
puts "Exception when calling CourseApi->delete_course: #{e}"
|
312
|
+
end
|
313
|
+
```
|
314
|
+
|
315
|
+
### Parameters
|
316
|
+
|
317
|
+
Name | Type | Description | Notes
|
318
|
+
------------- | ------------- | ------------- | -------------
|
319
|
+
**course_id** | **String**| |
|
320
|
+
|
321
|
+
### Return type
|
322
|
+
|
323
|
+
nil (empty response body)
|
324
|
+
|
325
|
+
### Authorization
|
326
|
+
|
327
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
328
|
+
|
329
|
+
### HTTP request headers
|
330
|
+
|
331
|
+
- **Content-Type**: application/json
|
332
|
+
- **Accept**: application/json
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
# **delete_course_configuration_setting**
|
337
|
+
> delete_course_configuration_setting(course_id, setting_id)
|
338
|
+
|
339
|
+
Clears the `settingId` value for this course
|
340
|
+
|
341
|
+
### Example
|
342
|
+
```ruby
|
343
|
+
# load the gem
|
344
|
+
require 'rustici_software_cloud_v2'
|
345
|
+
# setup authorization
|
346
|
+
RusticiSoftwareCloudV2.configure do |config|
|
347
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
348
|
+
config.username = 'YOUR USERNAME'
|
349
|
+
config.password = 'YOUR PASSWORD'
|
350
|
+
|
351
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
352
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
353
|
+
end
|
354
|
+
|
355
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
356
|
+
|
357
|
+
course_id = 'course_id_example' # String |
|
358
|
+
|
359
|
+
setting_id = 'setting_id_example' # String |
|
360
|
+
|
361
|
+
|
362
|
+
begin
|
363
|
+
#Clears the `settingId` value for this course
|
364
|
+
api_instance.delete_course_configuration_setting(course_id, setting_id)
|
365
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
366
|
+
puts "Exception when calling CourseApi->delete_course_configuration_setting: #{e}"
|
367
|
+
end
|
368
|
+
```
|
369
|
+
|
370
|
+
### Parameters
|
371
|
+
|
372
|
+
Name | Type | Description | Notes
|
373
|
+
------------- | ------------- | ------------- | -------------
|
374
|
+
**course_id** | **String**| |
|
375
|
+
**setting_id** | **String**| |
|
376
|
+
|
377
|
+
### Return type
|
378
|
+
|
379
|
+
nil (empty response body)
|
380
|
+
|
381
|
+
### Authorization
|
382
|
+
|
383
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
384
|
+
|
385
|
+
### HTTP request headers
|
386
|
+
|
387
|
+
- **Content-Type**: application/json
|
388
|
+
- **Accept**: application/json
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
# **delete_course_tags**
|
393
|
+
> delete_course_tags(course_id, tags)
|
394
|
+
|
395
|
+
Delete tags for this course
|
396
|
+
|
397
|
+
### Example
|
398
|
+
```ruby
|
399
|
+
# load the gem
|
400
|
+
require 'rustici_software_cloud_v2'
|
401
|
+
# setup authorization
|
402
|
+
RusticiSoftwareCloudV2.configure do |config|
|
403
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
404
|
+
config.username = 'YOUR USERNAME'
|
405
|
+
config.password = 'YOUR PASSWORD'
|
406
|
+
|
407
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
408
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
409
|
+
end
|
410
|
+
|
411
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
412
|
+
|
413
|
+
course_id = 'course_id_example' # String |
|
414
|
+
|
415
|
+
tags = RusticiSoftwareCloudV2::TagListSchema.new # TagListSchema |
|
416
|
+
|
417
|
+
|
418
|
+
begin
|
419
|
+
#Delete tags for this course
|
420
|
+
api_instance.delete_course_tags(course_id, tags)
|
421
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
422
|
+
puts "Exception when calling CourseApi->delete_course_tags: #{e}"
|
423
|
+
end
|
424
|
+
```
|
425
|
+
|
426
|
+
### Parameters
|
427
|
+
|
428
|
+
Name | Type | Description | Notes
|
429
|
+
------------- | ------------- | ------------- | -------------
|
430
|
+
**course_id** | **String**| |
|
431
|
+
**tags** | [**TagListSchema**](TagListSchema.md)| |
|
432
|
+
|
433
|
+
### Return type
|
434
|
+
|
435
|
+
nil (empty response body)
|
436
|
+
|
437
|
+
### Authorization
|
438
|
+
|
439
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
440
|
+
|
441
|
+
### HTTP request headers
|
442
|
+
|
443
|
+
- **Content-Type**: application/json
|
444
|
+
- **Accept**: application/json
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
# **delete_course_version**
|
449
|
+
> delete_course_version(course_id, version_id, )
|
450
|
+
|
451
|
+
Delete version `versionId` of `courseId`
|
452
|
+
|
453
|
+
### Example
|
454
|
+
```ruby
|
455
|
+
# load the gem
|
456
|
+
require 'rustici_software_cloud_v2'
|
457
|
+
# setup authorization
|
458
|
+
RusticiSoftwareCloudV2.configure do |config|
|
459
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
460
|
+
config.username = 'YOUR USERNAME'
|
461
|
+
config.password = 'YOUR PASSWORD'
|
462
|
+
|
463
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
464
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
465
|
+
end
|
466
|
+
|
467
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
468
|
+
|
469
|
+
course_id = 'course_id_example' # String |
|
470
|
+
|
471
|
+
version_id = 56 # Integer | The course version
|
472
|
+
|
473
|
+
|
474
|
+
begin
|
475
|
+
#Delete version `versionId` of `courseId`
|
476
|
+
api_instance.delete_course_version(course_id, version_id, )
|
477
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
478
|
+
puts "Exception when calling CourseApi->delete_course_version: #{e}"
|
479
|
+
end
|
480
|
+
```
|
481
|
+
|
482
|
+
### Parameters
|
483
|
+
|
484
|
+
Name | Type | Description | Notes
|
485
|
+
------------- | ------------- | ------------- | -------------
|
486
|
+
**course_id** | **String**| |
|
487
|
+
**version_id** | **Integer**| The course version |
|
488
|
+
|
489
|
+
### Return type
|
490
|
+
|
491
|
+
nil (empty response body)
|
492
|
+
|
493
|
+
### Authorization
|
494
|
+
|
495
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
496
|
+
|
497
|
+
### HTTP request headers
|
498
|
+
|
499
|
+
- **Content-Type**: application/json
|
500
|
+
- **Accept**: application/json
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
# **delete_course_version_configuration_setting**
|
505
|
+
> delete_course_version_configuration_setting(course_id, version_id, setting_id)
|
506
|
+
|
507
|
+
Clears the `settingId` value for this course and version.
|
508
|
+
|
509
|
+
### Example
|
510
|
+
```ruby
|
511
|
+
# load the gem
|
512
|
+
require 'rustici_software_cloud_v2'
|
513
|
+
# setup authorization
|
514
|
+
RusticiSoftwareCloudV2.configure do |config|
|
515
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
516
|
+
config.username = 'YOUR USERNAME'
|
517
|
+
config.password = 'YOUR PASSWORD'
|
518
|
+
|
519
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
520
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
521
|
+
end
|
522
|
+
|
523
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
524
|
+
|
525
|
+
course_id = 'course_id_example' # String |
|
526
|
+
|
527
|
+
version_id = 56 # Integer | The course version
|
528
|
+
|
529
|
+
setting_id = 'setting_id_example' # String |
|
530
|
+
|
531
|
+
|
532
|
+
begin
|
533
|
+
#Clears the `settingId` value for this course and version.
|
534
|
+
api_instance.delete_course_version_configuration_setting(course_id, version_id, setting_id)
|
535
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
536
|
+
puts "Exception when calling CourseApi->delete_course_version_configuration_setting: #{e}"
|
537
|
+
end
|
538
|
+
```
|
539
|
+
|
540
|
+
### Parameters
|
541
|
+
|
542
|
+
Name | Type | Description | Notes
|
543
|
+
------------- | ------------- | ------------- | -------------
|
544
|
+
**course_id** | **String**| |
|
545
|
+
**version_id** | **Integer**| The course version |
|
546
|
+
**setting_id** | **String**| |
|
547
|
+
|
548
|
+
### Return type
|
549
|
+
|
550
|
+
nil (empty response body)
|
551
|
+
|
552
|
+
### Authorization
|
553
|
+
|
554
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
555
|
+
|
556
|
+
### HTTP request headers
|
557
|
+
|
558
|
+
- **Content-Type**: application/json
|
559
|
+
- **Accept**: application/json
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
# **get_course**
|
564
|
+
> CourseSchema get_course(course_id, , opts)
|
565
|
+
|
566
|
+
Get information about `courseId`
|
567
|
+
|
568
|
+
### Example
|
569
|
+
```ruby
|
570
|
+
# load the gem
|
571
|
+
require 'rustici_software_cloud_v2'
|
572
|
+
# setup authorization
|
573
|
+
RusticiSoftwareCloudV2.configure do |config|
|
574
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
575
|
+
config.username = 'YOUR USERNAME'
|
576
|
+
config.password = 'YOUR PASSWORD'
|
577
|
+
|
578
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
579
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
580
|
+
end
|
581
|
+
|
582
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
583
|
+
|
584
|
+
course_id = 'course_id_example' # String |
|
585
|
+
|
586
|
+
opts = {
|
587
|
+
include_registration_count: false, # BOOLEAN | Include the registration count in the results
|
588
|
+
include_course_metadata: false, # BOOLEAN | Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
|
589
|
+
}
|
590
|
+
|
591
|
+
begin
|
592
|
+
#Get information about `courseId`
|
593
|
+
result = api_instance.get_course(course_id, , opts)
|
594
|
+
p result
|
595
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
596
|
+
puts "Exception when calling CourseApi->get_course: #{e}"
|
597
|
+
end
|
598
|
+
```
|
599
|
+
|
600
|
+
### Parameters
|
601
|
+
|
602
|
+
Name | Type | Description | Notes
|
603
|
+
------------- | ------------- | ------------- | -------------
|
604
|
+
**course_id** | **String**| |
|
605
|
+
**include_registration_count** | **BOOLEAN**| Include the registration count in the results | [optional] [default to false]
|
606
|
+
**include_course_metadata** | **BOOLEAN**| Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. | [optional] [default to false]
|
607
|
+
|
608
|
+
### Return type
|
609
|
+
|
610
|
+
[**CourseSchema**](CourseSchema.md)
|
611
|
+
|
612
|
+
### Authorization
|
613
|
+
|
614
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
615
|
+
|
616
|
+
### HTTP request headers
|
617
|
+
|
618
|
+
- **Content-Type**: application/json
|
619
|
+
- **Accept**: application/json
|
620
|
+
|
621
|
+
|
622
|
+
|
623
|
+
# **get_course_configuration**
|
624
|
+
> SettingListSchema get_course_configuration(course_id, , opts)
|
625
|
+
|
626
|
+
Returns all configuration settings for this course
|
627
|
+
|
628
|
+
### Example
|
629
|
+
```ruby
|
630
|
+
# load the gem
|
631
|
+
require 'rustici_software_cloud_v2'
|
632
|
+
# setup authorization
|
633
|
+
RusticiSoftwareCloudV2.configure do |config|
|
634
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
635
|
+
config.username = 'YOUR USERNAME'
|
636
|
+
config.password = 'YOUR PASSWORD'
|
637
|
+
|
638
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
639
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
640
|
+
end
|
641
|
+
|
642
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
643
|
+
|
644
|
+
course_id = 'course_id_example' # String |
|
645
|
+
|
646
|
+
opts = {
|
647
|
+
include_metadata: false # BOOLEAN |
|
648
|
+
}
|
649
|
+
|
650
|
+
begin
|
651
|
+
#Returns all configuration settings for this course
|
652
|
+
result = api_instance.get_course_configuration(course_id, , opts)
|
653
|
+
p result
|
654
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
655
|
+
puts "Exception when calling CourseApi->get_course_configuration: #{e}"
|
656
|
+
end
|
657
|
+
```
|
658
|
+
|
659
|
+
### Parameters
|
660
|
+
|
661
|
+
Name | Type | Description | Notes
|
662
|
+
------------- | ------------- | ------------- | -------------
|
663
|
+
**course_id** | **String**| |
|
664
|
+
**include_metadata** | **BOOLEAN**| | [optional] [default to false]
|
665
|
+
|
666
|
+
### Return type
|
667
|
+
|
668
|
+
[**SettingListSchema**](SettingListSchema.md)
|
669
|
+
|
670
|
+
### Authorization
|
671
|
+
|
672
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
673
|
+
|
674
|
+
### HTTP request headers
|
675
|
+
|
676
|
+
- **Content-Type**: application/json
|
677
|
+
- **Accept**: application/json
|
678
|
+
|
679
|
+
|
680
|
+
|
681
|
+
# **get_course_statements**
|
682
|
+
> XapiStatementResult get_course_statements(course_id, , opts)
|
683
|
+
|
684
|
+
Get xAPI statements for `courseId`
|
685
|
+
|
686
|
+
### Example
|
687
|
+
```ruby
|
688
|
+
# load the gem
|
689
|
+
require 'rustici_software_cloud_v2'
|
690
|
+
# setup authorization
|
691
|
+
RusticiSoftwareCloudV2.configure do |config|
|
692
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
693
|
+
config.username = 'YOUR USERNAME'
|
694
|
+
config.password = 'YOUR PASSWORD'
|
695
|
+
|
696
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
697
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
698
|
+
end
|
699
|
+
|
700
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
701
|
+
|
702
|
+
course_id = 'course_id_example' # String |
|
703
|
+
|
704
|
+
opts = {
|
705
|
+
learner_id: 'learner_id_example', # String | Only entries for the specified learner id will be included.
|
706
|
+
since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
707
|
+
_until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
708
|
+
more: 'more_example', # String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
709
|
+
}
|
710
|
+
|
711
|
+
begin
|
712
|
+
#Get xAPI statements for `courseId`
|
713
|
+
result = api_instance.get_course_statements(course_id, , opts)
|
714
|
+
p result
|
715
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
716
|
+
puts "Exception when calling CourseApi->get_course_statements: #{e}"
|
717
|
+
end
|
718
|
+
```
|
719
|
+
|
720
|
+
### Parameters
|
721
|
+
|
722
|
+
Name | Type | Description | Notes
|
723
|
+
------------- | ------------- | ------------- | -------------
|
724
|
+
**course_id** | **String**| |
|
725
|
+
**learner_id** | **String**| Only entries for the specified learner id will be included. | [optional]
|
726
|
+
**since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
727
|
+
**_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
728
|
+
**more** | **String**| Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice. | [optional]
|
729
|
+
|
730
|
+
### Return type
|
731
|
+
|
732
|
+
[**XapiStatementResult**](XapiStatementResult.md)
|
733
|
+
|
734
|
+
### Authorization
|
735
|
+
|
736
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
737
|
+
|
738
|
+
### HTTP request headers
|
739
|
+
|
740
|
+
- **Content-Type**: application/json
|
741
|
+
- **Accept**: application/json
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
# **get_course_tags**
|
746
|
+
> TagListSchema get_course_tags(course_id, )
|
747
|
+
|
748
|
+
Get the tags for this course
|
749
|
+
|
750
|
+
### Example
|
751
|
+
```ruby
|
752
|
+
# load the gem
|
753
|
+
require 'rustici_software_cloud_v2'
|
754
|
+
# setup authorization
|
755
|
+
RusticiSoftwareCloudV2.configure do |config|
|
756
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
757
|
+
config.username = 'YOUR USERNAME'
|
758
|
+
config.password = 'YOUR PASSWORD'
|
759
|
+
|
760
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
761
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
762
|
+
end
|
763
|
+
|
764
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
765
|
+
|
766
|
+
course_id = 'course_id_example' # String |
|
767
|
+
|
768
|
+
|
769
|
+
begin
|
770
|
+
#Get the tags for this course
|
771
|
+
result = api_instance.get_course_tags(course_id, )
|
772
|
+
p result
|
773
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
774
|
+
puts "Exception when calling CourseApi->get_course_tags: #{e}"
|
775
|
+
end
|
776
|
+
```
|
777
|
+
|
778
|
+
### Parameters
|
779
|
+
|
780
|
+
Name | Type | Description | Notes
|
781
|
+
------------- | ------------- | ------------- | -------------
|
782
|
+
**course_id** | **String**| |
|
783
|
+
|
784
|
+
### Return type
|
785
|
+
|
786
|
+
[**TagListSchema**](TagListSchema.md)
|
787
|
+
|
788
|
+
### Authorization
|
789
|
+
|
790
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
791
|
+
|
792
|
+
### HTTP request headers
|
793
|
+
|
794
|
+
- **Content-Type**: application/json
|
795
|
+
- **Accept**: application/json
|
796
|
+
|
797
|
+
|
798
|
+
|
799
|
+
# **get_course_version_configuration**
|
800
|
+
> SettingListSchema get_course_version_configuration(course_id, version_id, , opts)
|
801
|
+
|
802
|
+
Returns all configuration settings for this course and version.
|
803
|
+
|
804
|
+
### Example
|
805
|
+
```ruby
|
806
|
+
# load the gem
|
807
|
+
require 'rustici_software_cloud_v2'
|
808
|
+
# setup authorization
|
809
|
+
RusticiSoftwareCloudV2.configure do |config|
|
810
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
811
|
+
config.username = 'YOUR USERNAME'
|
812
|
+
config.password = 'YOUR PASSWORD'
|
813
|
+
|
814
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
815
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
816
|
+
end
|
817
|
+
|
818
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
819
|
+
|
820
|
+
course_id = 'course_id_example' # String |
|
821
|
+
|
822
|
+
version_id = 56 # Integer | The course version
|
823
|
+
|
824
|
+
opts = {
|
825
|
+
include_metadata: false # BOOLEAN |
|
826
|
+
}
|
827
|
+
|
828
|
+
begin
|
829
|
+
#Returns all configuration settings for this course and version.
|
830
|
+
result = api_instance.get_course_version_configuration(course_id, version_id, , opts)
|
831
|
+
p result
|
832
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
833
|
+
puts "Exception when calling CourseApi->get_course_version_configuration: #{e}"
|
834
|
+
end
|
835
|
+
```
|
836
|
+
|
837
|
+
### Parameters
|
838
|
+
|
839
|
+
Name | Type | Description | Notes
|
840
|
+
------------- | ------------- | ------------- | -------------
|
841
|
+
**course_id** | **String**| |
|
842
|
+
**version_id** | **Integer**| The course version |
|
843
|
+
**include_metadata** | **BOOLEAN**| | [optional] [default to false]
|
844
|
+
|
845
|
+
### Return type
|
846
|
+
|
847
|
+
[**SettingListSchema**](SettingListSchema.md)
|
848
|
+
|
849
|
+
### Authorization
|
850
|
+
|
851
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
852
|
+
|
853
|
+
### HTTP request headers
|
854
|
+
|
855
|
+
- **Content-Type**: application/json
|
856
|
+
- **Accept**: application/json
|
857
|
+
|
858
|
+
|
859
|
+
|
860
|
+
# **get_course_version_info**
|
861
|
+
> CourseSchema get_course_version_info(course_id, version_id, , opts)
|
862
|
+
|
863
|
+
Get version `versionId` of `courseId`
|
864
|
+
|
865
|
+
### Example
|
866
|
+
```ruby
|
867
|
+
# load the gem
|
868
|
+
require 'rustici_software_cloud_v2'
|
869
|
+
# setup authorization
|
870
|
+
RusticiSoftwareCloudV2.configure do |config|
|
871
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
872
|
+
config.username = 'YOUR USERNAME'
|
873
|
+
config.password = 'YOUR PASSWORD'
|
874
|
+
|
875
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
876
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
877
|
+
end
|
878
|
+
|
879
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
880
|
+
|
881
|
+
course_id = 'course_id_example' # String |
|
882
|
+
|
883
|
+
version_id = 56 # Integer | The course version
|
884
|
+
|
885
|
+
opts = {
|
886
|
+
include_registration_count: false, # BOOLEAN | Include the registration count in the results
|
887
|
+
include_course_metadata: false, # BOOLEAN | Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
|
888
|
+
}
|
889
|
+
|
890
|
+
begin
|
891
|
+
#Get version `versionId` of `courseId`
|
892
|
+
result = api_instance.get_course_version_info(course_id, version_id, , opts)
|
893
|
+
p result
|
894
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
895
|
+
puts "Exception when calling CourseApi->get_course_version_info: #{e}"
|
896
|
+
end
|
897
|
+
```
|
898
|
+
|
899
|
+
### Parameters
|
900
|
+
|
901
|
+
Name | Type | Description | Notes
|
902
|
+
------------- | ------------- | ------------- | -------------
|
903
|
+
**course_id** | **String**| |
|
904
|
+
**version_id** | **Integer**| The course version |
|
905
|
+
**include_registration_count** | **BOOLEAN**| Include the registration count in the results | [optional] [default to false]
|
906
|
+
**include_course_metadata** | **BOOLEAN**| Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. | [optional] [default to false]
|
907
|
+
|
908
|
+
### Return type
|
909
|
+
|
910
|
+
[**CourseSchema**](CourseSchema.md)
|
911
|
+
|
912
|
+
### Authorization
|
913
|
+
|
914
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
915
|
+
|
916
|
+
### HTTP request headers
|
917
|
+
|
918
|
+
- **Content-Type**: application/json
|
919
|
+
- **Accept**: application/json
|
920
|
+
|
921
|
+
|
922
|
+
|
923
|
+
# **get_course_version_statements**
|
924
|
+
> XapiStatementResult get_course_version_statements(course_id, version_id, , opts)
|
925
|
+
|
926
|
+
Get xAPI statements for version `versionId` of `courseId`
|
927
|
+
|
928
|
+
### Example
|
929
|
+
```ruby
|
930
|
+
# load the gem
|
931
|
+
require 'rustici_software_cloud_v2'
|
932
|
+
# setup authorization
|
933
|
+
RusticiSoftwareCloudV2.configure do |config|
|
934
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
935
|
+
config.username = 'YOUR USERNAME'
|
936
|
+
config.password = 'YOUR PASSWORD'
|
937
|
+
|
938
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
939
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
940
|
+
end
|
941
|
+
|
942
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
943
|
+
|
944
|
+
course_id = 'course_id_example' # String |
|
945
|
+
|
946
|
+
version_id = 56 # Integer | The course version
|
947
|
+
|
948
|
+
opts = {
|
949
|
+
learner_id: 'learner_id_example', # String | Only entries for the specified learner id will be included.
|
950
|
+
since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
951
|
+
_until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
952
|
+
more: 'more_example', # String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
953
|
+
}
|
954
|
+
|
955
|
+
begin
|
956
|
+
#Get xAPI statements for version `versionId` of `courseId`
|
957
|
+
result = api_instance.get_course_version_statements(course_id, version_id, , opts)
|
958
|
+
p result
|
959
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
960
|
+
puts "Exception when calling CourseApi->get_course_version_statements: #{e}"
|
961
|
+
end
|
962
|
+
```
|
963
|
+
|
964
|
+
### Parameters
|
965
|
+
|
966
|
+
Name | Type | Description | Notes
|
967
|
+
------------- | ------------- | ------------- | -------------
|
968
|
+
**course_id** | **String**| |
|
969
|
+
**version_id** | **Integer**| The course version |
|
970
|
+
**learner_id** | **String**| Only entries for the specified learner id will be included. | [optional]
|
971
|
+
**since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
972
|
+
**_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
973
|
+
**more** | **String**| Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice. | [optional]
|
974
|
+
|
975
|
+
### Return type
|
976
|
+
|
977
|
+
[**XapiStatementResult**](XapiStatementResult.md)
|
978
|
+
|
979
|
+
### Authorization
|
980
|
+
|
981
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
982
|
+
|
983
|
+
### HTTP request headers
|
984
|
+
|
985
|
+
- **Content-Type**: application/json
|
986
|
+
- **Accept**: application/json
|
987
|
+
|
988
|
+
|
989
|
+
|
990
|
+
# **get_course_versions**
|
991
|
+
> CourseListNonPagedSchema get_course_versions(course_id, , opts)
|
992
|
+
|
993
|
+
Get all versions of `courseId`
|
994
|
+
|
995
|
+
### Example
|
996
|
+
```ruby
|
997
|
+
# load the gem
|
998
|
+
require 'rustici_software_cloud_v2'
|
999
|
+
# setup authorization
|
1000
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1001
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1002
|
+
config.username = 'YOUR USERNAME'
|
1003
|
+
config.password = 'YOUR PASSWORD'
|
1004
|
+
|
1005
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1006
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1010
|
+
|
1011
|
+
course_id = 'course_id_example' # String |
|
1012
|
+
|
1013
|
+
opts = {
|
1014
|
+
since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
1015
|
+
_until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
1016
|
+
include_registration_count: false, # BOOLEAN | Include the registration count in the results
|
1017
|
+
include_course_metadata: false, # BOOLEAN | Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
|
1018
|
+
}
|
1019
|
+
|
1020
|
+
begin
|
1021
|
+
#Get all versions of `courseId`
|
1022
|
+
result = api_instance.get_course_versions(course_id, , opts)
|
1023
|
+
p result
|
1024
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1025
|
+
puts "Exception when calling CourseApi->get_course_versions: #{e}"
|
1026
|
+
end
|
1027
|
+
```
|
1028
|
+
|
1029
|
+
### Parameters
|
1030
|
+
|
1031
|
+
Name | Type | Description | Notes
|
1032
|
+
------------- | ------------- | ------------- | -------------
|
1033
|
+
**course_id** | **String**| |
|
1034
|
+
**since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
1035
|
+
**_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
1036
|
+
**include_registration_count** | **BOOLEAN**| Include the registration count in the results | [optional] [default to false]
|
1037
|
+
**include_course_metadata** | **BOOLEAN**| Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. | [optional] [default to false]
|
1038
|
+
|
1039
|
+
### Return type
|
1040
|
+
|
1041
|
+
[**CourseListNonPagedSchema**](CourseListNonPagedSchema.md)
|
1042
|
+
|
1043
|
+
### Authorization
|
1044
|
+
|
1045
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1046
|
+
|
1047
|
+
### HTTP request headers
|
1048
|
+
|
1049
|
+
- **Content-Type**: application/json
|
1050
|
+
- **Accept**: application/json
|
1051
|
+
|
1052
|
+
|
1053
|
+
|
1054
|
+
# **get_courses**
|
1055
|
+
> CourseListSchema get_courses(opts)
|
1056
|
+
|
1057
|
+
Get all courses for `appId`
|
1058
|
+
|
1059
|
+
### Example
|
1060
|
+
```ruby
|
1061
|
+
# load the gem
|
1062
|
+
require 'rustici_software_cloud_v2'
|
1063
|
+
# setup authorization
|
1064
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1065
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1066
|
+
config.username = 'YOUR USERNAME'
|
1067
|
+
config.password = 'YOUR PASSWORD'
|
1068
|
+
|
1069
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1070
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1071
|
+
end
|
1072
|
+
|
1073
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1074
|
+
|
1075
|
+
opts = {
|
1076
|
+
more: 'more_example', # String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
|
1077
|
+
since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
1078
|
+
_until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
|
1079
|
+
filter: 'filter_example', # String | Optional string which filters results by a specified field (described by filterBy).
|
1080
|
+
filter_by: 'filter_by_example', # String | Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id.
|
1081
|
+
order_by: 'order_by_example', # String | Optional enum parameter for specifying the field and order by which to sort the results. Defaults to creation_date_desc.
|
1082
|
+
include_registration_count: false, # BOOLEAN | Include the registration count in the results
|
1083
|
+
include_course_metadata: false, # BOOLEAN | Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
|
1084
|
+
tags: ['tags_example'] # Array<String> |
|
1085
|
+
}
|
1086
|
+
|
1087
|
+
begin
|
1088
|
+
#Get all courses for `appId`
|
1089
|
+
result = api_instance.get_courses(opts)
|
1090
|
+
p result
|
1091
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1092
|
+
puts "Exception when calling CourseApi->get_courses: #{e}"
|
1093
|
+
end
|
1094
|
+
```
|
1095
|
+
|
1096
|
+
### Parameters
|
1097
|
+
|
1098
|
+
Name | Type | Description | Notes
|
1099
|
+
------------- | ------------- | ------------- | -------------
|
1100
|
+
**more** | **String**| Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice. | [optional]
|
1101
|
+
**since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
1102
|
+
**_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
|
1103
|
+
**filter** | **String**| Optional string which filters results by a specified field (described by filterBy). | [optional]
|
1104
|
+
**filter_by** | **String**| Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id. | [optional]
|
1105
|
+
**order_by** | **String**| Optional enum parameter for specifying the field and order by which to sort the results. Defaults to creation_date_desc. | [optional]
|
1106
|
+
**include_registration_count** | **BOOLEAN**| Include the registration count in the results | [optional] [default to false]
|
1107
|
+
**include_course_metadata** | **BOOLEAN**| Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. | [optional] [default to false]
|
1108
|
+
**tags** | [**Array<String>**](String.md)| | [optional]
|
1109
|
+
|
1110
|
+
### Return type
|
1111
|
+
|
1112
|
+
[**CourseListSchema**](CourseListSchema.md)
|
1113
|
+
|
1114
|
+
### Authorization
|
1115
|
+
|
1116
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1117
|
+
|
1118
|
+
### HTTP request headers
|
1119
|
+
|
1120
|
+
- **Content-Type**: application/json
|
1121
|
+
- **Accept**: application/json
|
1122
|
+
|
1123
|
+
|
1124
|
+
|
1125
|
+
# **get_import_job_status**
|
1126
|
+
> ImportJobResultSchema get_import_job_status(import_job_id)
|
1127
|
+
|
1128
|
+
Check the status of an import job.
|
1129
|
+
|
1130
|
+
### Example
|
1131
|
+
```ruby
|
1132
|
+
# load the gem
|
1133
|
+
require 'rustici_software_cloud_v2'
|
1134
|
+
# setup authorization
|
1135
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1136
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1137
|
+
config.username = 'YOUR USERNAME'
|
1138
|
+
config.password = 'YOUR PASSWORD'
|
1139
|
+
|
1140
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1141
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1145
|
+
|
1146
|
+
import_job_id = 'import_job_id_example' # String | Id received when the import job was submitted to the importJobs resource.
|
1147
|
+
|
1148
|
+
|
1149
|
+
begin
|
1150
|
+
#Check the status of an import job.
|
1151
|
+
result = api_instance.get_import_job_status(import_job_id)
|
1152
|
+
p result
|
1153
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1154
|
+
puts "Exception when calling CourseApi->get_import_job_status: #{e}"
|
1155
|
+
end
|
1156
|
+
```
|
1157
|
+
|
1158
|
+
### Parameters
|
1159
|
+
|
1160
|
+
Name | Type | Description | Notes
|
1161
|
+
------------- | ------------- | ------------- | -------------
|
1162
|
+
**import_job_id** | **String**| Id received when the import job was submitted to the importJobs resource. |
|
1163
|
+
|
1164
|
+
### Return type
|
1165
|
+
|
1166
|
+
[**ImportJobResultSchema**](ImportJobResultSchema.md)
|
1167
|
+
|
1168
|
+
### Authorization
|
1169
|
+
|
1170
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1171
|
+
|
1172
|
+
### HTTP request headers
|
1173
|
+
|
1174
|
+
- **Content-Type**: application/json
|
1175
|
+
- **Accept**: application/json
|
1176
|
+
|
1177
|
+
|
1178
|
+
|
1179
|
+
# **put_course_tags**
|
1180
|
+
> put_course_tags(course_id, tags)
|
1181
|
+
|
1182
|
+
Set the tags for this course
|
1183
|
+
|
1184
|
+
### Example
|
1185
|
+
```ruby
|
1186
|
+
# load the gem
|
1187
|
+
require 'rustici_software_cloud_v2'
|
1188
|
+
# setup authorization
|
1189
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1190
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1191
|
+
config.username = 'YOUR USERNAME'
|
1192
|
+
config.password = 'YOUR PASSWORD'
|
1193
|
+
|
1194
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1195
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1199
|
+
|
1200
|
+
course_id = 'course_id_example' # String |
|
1201
|
+
|
1202
|
+
tags = RusticiSoftwareCloudV2::TagListSchema.new # TagListSchema |
|
1203
|
+
|
1204
|
+
|
1205
|
+
begin
|
1206
|
+
#Set the tags for this course
|
1207
|
+
api_instance.put_course_tags(course_id, tags)
|
1208
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1209
|
+
puts "Exception when calling CourseApi->put_course_tags: #{e}"
|
1210
|
+
end
|
1211
|
+
```
|
1212
|
+
|
1213
|
+
### Parameters
|
1214
|
+
|
1215
|
+
Name | Type | Description | Notes
|
1216
|
+
------------- | ------------- | ------------- | -------------
|
1217
|
+
**course_id** | **String**| |
|
1218
|
+
**tags** | [**TagListSchema**](TagListSchema.md)| |
|
1219
|
+
|
1220
|
+
### Return type
|
1221
|
+
|
1222
|
+
nil (empty response body)
|
1223
|
+
|
1224
|
+
### Authorization
|
1225
|
+
|
1226
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1227
|
+
|
1228
|
+
### HTTP request headers
|
1229
|
+
|
1230
|
+
- **Content-Type**: application/json
|
1231
|
+
- **Accept**: application/json
|
1232
|
+
|
1233
|
+
|
1234
|
+
|
1235
|
+
# **put_course_tags_batch**
|
1236
|
+
> put_course_tags_batch(batch)
|
1237
|
+
|
1238
|
+
Sets all of the provided tags on all of the provided courses
|
1239
|
+
|
1240
|
+
### Example
|
1241
|
+
```ruby
|
1242
|
+
# load the gem
|
1243
|
+
require 'rustici_software_cloud_v2'
|
1244
|
+
# setup authorization
|
1245
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1246
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1247
|
+
config.username = 'YOUR USERNAME'
|
1248
|
+
config.password = 'YOUR PASSWORD'
|
1249
|
+
|
1250
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1251
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1252
|
+
end
|
1253
|
+
|
1254
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1255
|
+
|
1256
|
+
batch = RusticiSoftwareCloudV2::CourseTagsBatchSchema.new # CourseTagsBatchSchema |
|
1257
|
+
|
1258
|
+
|
1259
|
+
begin
|
1260
|
+
#Sets all of the provided tags on all of the provided courses
|
1261
|
+
api_instance.put_course_tags_batch(batch)
|
1262
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1263
|
+
puts "Exception when calling CourseApi->put_course_tags_batch: #{e}"
|
1264
|
+
end
|
1265
|
+
```
|
1266
|
+
|
1267
|
+
### Parameters
|
1268
|
+
|
1269
|
+
Name | Type | Description | Notes
|
1270
|
+
------------- | ------------- | ------------- | -------------
|
1271
|
+
**batch** | [**CourseTagsBatchSchema**](CourseTagsBatchSchema.md)| |
|
1272
|
+
|
1273
|
+
### Return type
|
1274
|
+
|
1275
|
+
nil (empty response body)
|
1276
|
+
|
1277
|
+
### Authorization
|
1278
|
+
|
1279
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1280
|
+
|
1281
|
+
### HTTP request headers
|
1282
|
+
|
1283
|
+
- **Content-Type**: application/json
|
1284
|
+
- **Accept**: application/json
|
1285
|
+
|
1286
|
+
|
1287
|
+
|
1288
|
+
# **set_course_configuration**
|
1289
|
+
> set_course_configuration(course_id, configuration_settings)
|
1290
|
+
|
1291
|
+
Set configuration settings for this course.
|
1292
|
+
|
1293
|
+
### Example
|
1294
|
+
```ruby
|
1295
|
+
# load the gem
|
1296
|
+
require 'rustici_software_cloud_v2'
|
1297
|
+
# setup authorization
|
1298
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1299
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1300
|
+
config.username = 'YOUR USERNAME'
|
1301
|
+
config.password = 'YOUR PASSWORD'
|
1302
|
+
|
1303
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1304
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1305
|
+
end
|
1306
|
+
|
1307
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1308
|
+
|
1309
|
+
course_id = 'course_id_example' # String |
|
1310
|
+
|
1311
|
+
configuration_settings = RusticiSoftwareCloudV2::SettingsPostSchema.new # SettingsPostSchema |
|
1312
|
+
|
1313
|
+
|
1314
|
+
begin
|
1315
|
+
#Set configuration settings for this course.
|
1316
|
+
api_instance.set_course_configuration(course_id, configuration_settings)
|
1317
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1318
|
+
puts "Exception when calling CourseApi->set_course_configuration: #{e}"
|
1319
|
+
end
|
1320
|
+
```
|
1321
|
+
|
1322
|
+
### Parameters
|
1323
|
+
|
1324
|
+
Name | Type | Description | Notes
|
1325
|
+
------------- | ------------- | ------------- | -------------
|
1326
|
+
**course_id** | **String**| |
|
1327
|
+
**configuration_settings** | [**SettingsPostSchema**](SettingsPostSchema.md)| |
|
1328
|
+
|
1329
|
+
### Return type
|
1330
|
+
|
1331
|
+
nil (empty response body)
|
1332
|
+
|
1333
|
+
### Authorization
|
1334
|
+
|
1335
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1336
|
+
|
1337
|
+
### HTTP request headers
|
1338
|
+
|
1339
|
+
- **Content-Type**: application/json
|
1340
|
+
- **Accept**: application/json
|
1341
|
+
|
1342
|
+
|
1343
|
+
|
1344
|
+
# **set_course_title**
|
1345
|
+
> String set_course_title(course_id, title)
|
1346
|
+
|
1347
|
+
Sets the course title for `courseId`
|
1348
|
+
|
1349
|
+
### Example
|
1350
|
+
```ruby
|
1351
|
+
# load the gem
|
1352
|
+
require 'rustici_software_cloud_v2'
|
1353
|
+
# setup authorization
|
1354
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1355
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1356
|
+
config.username = 'YOUR USERNAME'
|
1357
|
+
config.password = 'YOUR PASSWORD'
|
1358
|
+
|
1359
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1360
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1361
|
+
end
|
1362
|
+
|
1363
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1364
|
+
|
1365
|
+
course_id = 'course_id_example' # String |
|
1366
|
+
|
1367
|
+
title = RusticiSoftwareCloudV2::TitleSchema.new # TitleSchema |
|
1368
|
+
|
1369
|
+
|
1370
|
+
begin
|
1371
|
+
#Sets the course title for `courseId`
|
1372
|
+
result = api_instance.set_course_title(course_id, title)
|
1373
|
+
p result
|
1374
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1375
|
+
puts "Exception when calling CourseApi->set_course_title: #{e}"
|
1376
|
+
end
|
1377
|
+
```
|
1378
|
+
|
1379
|
+
### Parameters
|
1380
|
+
|
1381
|
+
Name | Type | Description | Notes
|
1382
|
+
------------- | ------------- | ------------- | -------------
|
1383
|
+
**course_id** | **String**| |
|
1384
|
+
**title** | [**TitleSchema**](TitleSchema.md)| |
|
1385
|
+
|
1386
|
+
### Return type
|
1387
|
+
|
1388
|
+
**String**
|
1389
|
+
|
1390
|
+
### Authorization
|
1391
|
+
|
1392
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1393
|
+
|
1394
|
+
### HTTP request headers
|
1395
|
+
|
1396
|
+
- **Content-Type**: application/json
|
1397
|
+
- **Accept**: application/json
|
1398
|
+
|
1399
|
+
|
1400
|
+
|
1401
|
+
# **set_course_version_configuration**
|
1402
|
+
> set_course_version_configuration(course_id, version_id, configuration_settings)
|
1403
|
+
|
1404
|
+
Set configuration settings for this course and version.
|
1405
|
+
|
1406
|
+
### Example
|
1407
|
+
```ruby
|
1408
|
+
# load the gem
|
1409
|
+
require 'rustici_software_cloud_v2'
|
1410
|
+
# setup authorization
|
1411
|
+
RusticiSoftwareCloudV2.configure do |config|
|
1412
|
+
# Configure HTTP basic authorization: APP_NORMAL
|
1413
|
+
config.username = 'YOUR USERNAME'
|
1414
|
+
config.password = 'YOUR PASSWORD'
|
1415
|
+
|
1416
|
+
# Configure OAuth2 access token for authorization: OAUTH
|
1417
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
1418
|
+
end
|
1419
|
+
|
1420
|
+
api_instance = RusticiSoftwareCloudV2::CourseApi.new
|
1421
|
+
|
1422
|
+
course_id = 'course_id_example' # String |
|
1423
|
+
|
1424
|
+
version_id = 56 # Integer | The course version
|
1425
|
+
|
1426
|
+
configuration_settings = RusticiSoftwareCloudV2::SettingsPostSchema.new # SettingsPostSchema |
|
1427
|
+
|
1428
|
+
|
1429
|
+
begin
|
1430
|
+
#Set configuration settings for this course and version.
|
1431
|
+
api_instance.set_course_version_configuration(course_id, version_id, configuration_settings)
|
1432
|
+
rescue RusticiSoftwareCloudV2::ApiError => e
|
1433
|
+
puts "Exception when calling CourseApi->set_course_version_configuration: #{e}"
|
1434
|
+
end
|
1435
|
+
```
|
1436
|
+
|
1437
|
+
### Parameters
|
1438
|
+
|
1439
|
+
Name | Type | Description | Notes
|
1440
|
+
------------- | ------------- | ------------- | -------------
|
1441
|
+
**course_id** | **String**| |
|
1442
|
+
**version_id** | **Integer**| The course version |
|
1443
|
+
**configuration_settings** | [**SettingsPostSchema**](SettingsPostSchema.md)| |
|
1444
|
+
|
1445
|
+
### Return type
|
1446
|
+
|
1447
|
+
nil (empty response body)
|
1448
|
+
|
1449
|
+
### Authorization
|
1450
|
+
|
1451
|
+
[APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
|
1452
|
+
|
1453
|
+
### HTTP request headers
|
1454
|
+
|
1455
|
+
- **Content-Type**: application/json
|
1456
|
+
- **Accept**: application/json
|
1457
|
+
|
1458
|
+
|
1459
|
+
|