rustici_software_cloud_v2 2.1.0 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +4 -4
- data/lib/rustici_software_cloud_v2/api/about_api.rb +3 -1
- data/lib/rustici_software_cloud_v2/api/application_management_api.rb +103 -8
- data/lib/rustici_software_cloud_v2/api/authentication_api.rb +3 -1
- data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +6 -1
- data/lib/rustici_software_cloud_v2/api/course_api.rb +42 -1
- data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +67 -10
- data/lib/rustici_software_cloud_v2/api/invitations_api.rb +35 -3
- data/lib/rustici_software_cloud_v2/api/learner_api.rb +8 -1
- data/lib/rustici_software_cloud_v2/api/ping_api.rb +3 -1
- data/lib/rustici_software_cloud_v2/api/registration_api.rb +32 -1
- data/lib/rustici_software_cloud_v2/api/reporting_api.rb +5 -1
- data/lib/rustici_software_cloud_v2/api/xapi_api.rb +15 -1
- data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +11 -1
- data/lib/rustici_software_cloud_v2/api_client.rb +3 -2
- data/lib/rustici_software_cloud_v2/api_error.rb +0 -1
- data/lib/rustici_software_cloud_v2/configuration.rb +0 -8
- data/lib/rustici_software_cloud_v2/models/about_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_info_list_schema.rb +197 -0
- data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +12 -2
- data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/application_token.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/comment_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/course_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +25 -5
- data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/credential_schema.rb +25 -5
- data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/{credential_created_schema.rb → destination_info_id_schema.rb} +10 -40
- data/lib/rustici_software_cloud_v2/models/destination_info_list_schema.rb +198 -0
- data/lib/rustici_software_cloud_v2/models/destination_info_schema.rb +263 -0
- data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +5 -15
- data/lib/rustici_software_cloud_v2/models/destination_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +16 -5
- data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/learner_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/message_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/paginated_list.rb +186 -0
- data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/ping_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/preview_launch_link_request_schema.rb +239 -0
- data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +2 -2
- data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +4 -4
- data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +4 -4
- data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/registration_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/registration_success.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/response_error.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/score_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_item.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/title_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +15 -18
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_account.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_score.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +1 -1
- data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +1 -1
- data/lib/rustici_software_cloud_v2/version.rb +1 -2
- data/lib/rustici_software_cloud_v2.rb +6 -2
- data/rustici_software_cloud_v2.gemspec +0 -1
- data/spec/api_client_spec.rb +0 -1
- data/spec/configuration_spec.rb +0 -1
- data/spec/spec_helper.rb +0 -1
- metadata +8 -3
@@ -6,7 +6,6 @@
|
|
6
6
|
OpenAPI spec version: 2.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.27
|
10
9
|
|
11
10
|
=end
|
12
11
|
|
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
|
|
19
18
|
def initialize(api_client = ApiClient.default)
|
20
19
|
@api_client = api_client
|
21
20
|
end
|
21
|
+
|
22
|
+
extend Gem::Deprecate
|
23
|
+
|
22
24
|
# Create a group of Destinations
|
23
25
|
# Creates a group of destinations. A destination is a label used to identify an entity outside of SCORM Cloud, such as an LMS. Used in conjunction with dispatches to provide access control mechanisms for the courses distributed to the destination.
|
24
26
|
# @param destinations_list
|
@@ -72,6 +74,7 @@ module RusticiSoftwareCloudV2
|
|
72
74
|
end
|
73
75
|
return data, status_code, headers
|
74
76
|
end
|
77
|
+
|
75
78
|
# Create a group of Dispatches
|
76
79
|
# Creates a group of dispatches. Dispatches are the connection between a course and a destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination. >**Caution:** >Only one dispatch can exist for a given course-destination combination. If calling this method with the same course and destination supplied, the old one will be loaded for modification. An exception to this is if a dispatchId is passed in the body, the request will fail with a 400 response warning that the dispatch already exists. This is to prevent confusion over which dispatchId is to be used in future requests.
|
77
80
|
# @param dispatch_list
|
@@ -125,6 +128,7 @@ module RusticiSoftwareCloudV2
|
|
125
128
|
end
|
126
129
|
return data, status_code, headers
|
127
130
|
end
|
131
|
+
|
128
132
|
# Delete a Destination
|
129
133
|
# Deletes the specified destination. >**Caution:** >This will also delete all dispatches belonging to the destination.
|
130
134
|
# @param destination_id Identifier for the destination
|
@@ -178,6 +182,7 @@ module RusticiSoftwareCloudV2
|
|
178
182
|
end
|
179
183
|
return data, status_code, headers
|
180
184
|
end
|
185
|
+
|
181
186
|
# Delete a Destination's Dispatches
|
182
187
|
# Deletes all the dispatches from the destination. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
183
188
|
# @param destination_id Identifier for the destination
|
@@ -231,6 +236,7 @@ module RusticiSoftwareCloudV2
|
|
231
236
|
end
|
232
237
|
return data, status_code, headers
|
233
238
|
end
|
239
|
+
|
234
240
|
# Delete tags from a Destination
|
235
241
|
# Deletes the specified tags from the destination. Deleting tags that do not exist will still result in a success.
|
236
242
|
# @param destination_id Identifier for the destination
|
@@ -290,6 +296,7 @@ module RusticiSoftwareCloudV2
|
|
290
296
|
end
|
291
297
|
return data, status_code, headers
|
292
298
|
end
|
299
|
+
|
293
300
|
# Delete a Dispatch
|
294
301
|
# Deletes the specified dispatch. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
|
295
302
|
# @param dispatch_id Identifier for the dispatch
|
@@ -343,6 +350,7 @@ module RusticiSoftwareCloudV2
|
|
343
350
|
end
|
344
351
|
return data, status_code, headers
|
345
352
|
end
|
353
|
+
|
346
354
|
# Delete postback information from a Dispatch
|
347
355
|
# Clears the postback settings from the dispatch. This causes the postback settings to inherit a value from a higher level (e.g. application). If there is no setting at the application level, this will disable postbacks for the dispatch.
|
348
356
|
# @param dispatch_id Identifier for the dispatch
|
@@ -396,6 +404,7 @@ module RusticiSoftwareCloudV2
|
|
396
404
|
end
|
397
405
|
return data, status_code, headers
|
398
406
|
end
|
407
|
+
|
399
408
|
# Delete tags from a Dispatch
|
400
409
|
# Deletes the specified tags from the dispatch. Deleting tags that do not exist will still result in a success.
|
401
410
|
# @param dispatch_id Identifier for the dispatch
|
@@ -455,6 +464,7 @@ module RusticiSoftwareCloudV2
|
|
455
464
|
end
|
456
465
|
return data, status_code, headers
|
457
466
|
end
|
467
|
+
|
458
468
|
# Delete a group of Dispatches
|
459
469
|
# Deletes the specified group of dispatches. Can be filtered using the request parameters to provide a subset of results. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental deletion of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
|
460
470
|
# @param [Hash] opts the optional parameters
|
@@ -523,6 +533,7 @@ module RusticiSoftwareCloudV2
|
|
523
533
|
end
|
524
534
|
return data, status_code, headers
|
525
535
|
end
|
536
|
+
|
526
537
|
# Update registration instancing status for a Destination's Dispatches
|
527
538
|
# Updates the restration instancing status for all dispatches distributed to the destination. Registration instancing is the default for dispatches, in order to support versioning of dispatches. A small portion of users may experience duplicate registrations with content dispatched to some LMS platforms. If you happen to be dispatching content to an LMS with this issue, disabling registration instancing here will resolve the problems. However, dispatch versioning will also be disabled.
|
528
539
|
# @param destination_id Identifier for the destination
|
@@ -582,11 +593,13 @@ module RusticiSoftwareCloudV2
|
|
582
593
|
end
|
583
594
|
return data, status_code, headers
|
584
595
|
end
|
596
|
+
|
585
597
|
# Get detailed information about a Destination
|
586
598
|
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
587
599
|
# @param destination_id Identifier for the destination
|
588
600
|
# @param [Hash] opts the optional parameters
|
589
|
-
# @
|
601
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for the destination. (default to false)
|
602
|
+
# @return [DestinationInfoSchema]
|
590
603
|
def get_destination(destination_id, opts = {})
|
591
604
|
data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
|
592
605
|
data
|
@@ -596,7 +609,8 @@ module RusticiSoftwareCloudV2
|
|
596
609
|
# Returns detailed information about the destination. This includes name, tags, and launchAuth information.
|
597
610
|
# @param destination_id Identifier for the destination
|
598
611
|
# @param [Hash] opts the optional parameters
|
599
|
-
# @
|
612
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for the destination.
|
613
|
+
# @return [Array<(DestinationInfoSchema, Fixnum, Hash)>] DestinationInfoSchema data, response status code and response headers
|
600
614
|
def get_destination_with_http_info(destination_id, opts = {})
|
601
615
|
if @api_client.config.debugging
|
602
616
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destination ...'
|
@@ -610,6 +624,7 @@ module RusticiSoftwareCloudV2
|
|
610
624
|
|
611
625
|
# query parameters
|
612
626
|
query_params = {}
|
627
|
+
query_params[:'includeDispatchCount'] = opts[:'include_dispatch_count'] if !opts[:'include_dispatch_count'].nil?
|
613
628
|
|
614
629
|
# header parameters
|
615
630
|
header_params = {}
|
@@ -630,12 +645,13 @@ module RusticiSoftwareCloudV2
|
|
630
645
|
:form_params => form_params,
|
631
646
|
:body => post_body,
|
632
647
|
:auth_names => auth_names,
|
633
|
-
:return_type => '
|
648
|
+
:return_type => 'DestinationInfoSchema')
|
634
649
|
if @api_client.config.debugging
|
635
650
|
@api_client.config.logger.debug "API called: DispatchApi#get_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
636
651
|
end
|
637
652
|
return data, status_code, headers
|
638
653
|
end
|
654
|
+
|
639
655
|
# Get registration count for a Destination's Dispatches
|
640
656
|
# Returns the registration count for all dispatches distributed to the destination. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
|
641
657
|
# @param destination_id Identifier for the destination
|
@@ -690,6 +706,7 @@ module RusticiSoftwareCloudV2
|
|
690
706
|
end
|
691
707
|
return data, status_code, headers
|
692
708
|
end
|
709
|
+
|
693
710
|
# Download a zip file for a Destination's Dispatches
|
694
711
|
# Downloads a zip file containing all of the dispatch packages for the destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud.
|
695
712
|
# @param destination_id Identifier for the destination
|
@@ -753,6 +770,7 @@ module RusticiSoftwareCloudV2
|
|
753
770
|
end
|
754
771
|
return data, status_code, headers
|
755
772
|
end
|
773
|
+
|
756
774
|
# Get a list of a Destination's Dispatches
|
757
775
|
# Returns a list of dispatches belonging to the destination. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter should only ever yield 0 or 1 results, as a dispatch is the intersection of a course and a destination. This can be useful for identifying if a certain course is dispatched to the destination. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
758
776
|
# @param destination_id Identifier for the destination
|
@@ -766,6 +784,7 @@ module RusticiSoftwareCloudV2
|
|
766
784
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
767
785
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
768
786
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
787
|
+
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token. (default to false)
|
769
788
|
# @return [DispatchListSchema]
|
770
789
|
def get_destination_dispatches(destination_id, opts = {})
|
771
790
|
data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
|
@@ -785,6 +804,7 @@ module RusticiSoftwareCloudV2
|
|
785
804
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
786
805
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
787
806
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
807
|
+
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
788
808
|
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
789
809
|
def get_destination_dispatches_with_http_info(destination_id, opts = {})
|
790
810
|
if @api_client.config.debugging
|
@@ -808,6 +828,7 @@ module RusticiSoftwareCloudV2
|
|
808
828
|
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
809
829
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
810
830
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
831
|
+
query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
|
811
832
|
|
812
833
|
# header parameters
|
813
834
|
header_params = {}
|
@@ -834,6 +855,7 @@ module RusticiSoftwareCloudV2
|
|
834
855
|
end
|
835
856
|
return data, status_code, headers
|
836
857
|
end
|
858
|
+
|
837
859
|
# Get user PII hashing status for a Destination
|
838
860
|
# Returns whether or not user PII hashing is enabled for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
839
861
|
# @param destination_id Identifier for the destination
|
@@ -888,6 +910,7 @@ module RusticiSoftwareCloudV2
|
|
888
910
|
end
|
889
911
|
return data, status_code, headers
|
890
912
|
end
|
913
|
+
|
891
914
|
# Get tags for a Destination
|
892
915
|
# Returns the tags for the destination.
|
893
916
|
# @param destination_id Identifier for the destination
|
@@ -942,8 +965,9 @@ module RusticiSoftwareCloudV2
|
|
942
965
|
end
|
943
966
|
return data, status_code, headers
|
944
967
|
end
|
968
|
+
|
945
969
|
# Get a list of Destinations
|
946
|
-
# Returns a list of destinations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
970
|
+
# Returns a list of destinations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >This endpoint caches the dispatch count of a destination for 24 hours if the `includeDispatchCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of dispatches for a destination will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the dispatch count for a single destination within the caching period, use the GetDestination endpoint with `includeDispatchCount` set to `true`. GetDestination *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that destination.
|
947
971
|
# @param [Hash] opts the optional parameters
|
948
972
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
949
973
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
@@ -954,14 +978,16 @@ module RusticiSoftwareCloudV2
|
|
954
978
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to destination_id)
|
955
979
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
956
980
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
957
|
-
# @
|
981
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for each destination. (default to false)
|
982
|
+
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token. (default to false)
|
983
|
+
# @return [DestinationInfoListSchema]
|
958
984
|
def get_destinations(opts = {})
|
959
985
|
data, _status_code, _headers = get_destinations_with_http_info(opts)
|
960
986
|
data
|
961
987
|
end
|
962
988
|
|
963
989
|
# Get a list of Destinations
|
964
|
-
# Returns a list of destinations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
990
|
+
# Returns a list of destinations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >This endpoint caches the dispatch count of a destination for 24 hours if the `includeDispatchCount` parameter is set to `true`. Since this value is cached for an extended period, any changes made to the number of dispatches for a destination will not be reflected in the results of this endpoint until the caching period has passed. >If you want to get an up-to-date value of the dispatch count for a single destination within the caching period, use the GetDestination endpoint with `includeDispatchCount` set to `true`. GetDestination *always* gathers the most up-to-date values and overwrites them in the cache, resetting the caching period for that destination.
|
965
991
|
# @param [Hash] opts the optional parameters
|
966
992
|
# @option opts [String] :course_id Only retrieve resources having `courseId`
|
967
993
|
# @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
|
@@ -972,7 +998,9 @@ module RusticiSoftwareCloudV2
|
|
972
998
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
973
999
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
974
1000
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
975
|
-
# @
|
1001
|
+
# @option opts [BOOLEAN] :include_dispatch_count Include a count of dispatches for each destination.
|
1002
|
+
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
1003
|
+
# @return [Array<(DestinationInfoListSchema, Fixnum, Hash)>] DestinationInfoListSchema data, response status code and response headers
|
976
1004
|
def get_destinations_with_http_info(opts = {})
|
977
1005
|
if @api_client.config.debugging
|
978
1006
|
@api_client.config.logger.debug 'Calling API: DispatchApi.get_destinations ...'
|
@@ -991,6 +1019,8 @@ module RusticiSoftwareCloudV2
|
|
991
1019
|
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
992
1020
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
993
1021
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
1022
|
+
query_params[:'includeDispatchCount'] = opts[:'include_dispatch_count'] if !opts[:'include_dispatch_count'].nil?
|
1023
|
+
query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
|
994
1024
|
|
995
1025
|
# header parameters
|
996
1026
|
header_params = {}
|
@@ -1011,12 +1041,13 @@ module RusticiSoftwareCloudV2
|
|
1011
1041
|
:form_params => form_params,
|
1012
1042
|
:body => post_body,
|
1013
1043
|
:auth_names => auth_names,
|
1014
|
-
:return_type => '
|
1044
|
+
:return_type => 'DestinationInfoListSchema')
|
1015
1045
|
if @api_client.config.debugging
|
1016
1046
|
@api_client.config.logger.debug "API called: DispatchApi#get_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1017
1047
|
end
|
1018
1048
|
return data, status_code, headers
|
1019
1049
|
end
|
1050
|
+
|
1020
1051
|
# Get detailed information about a Dispatch
|
1021
1052
|
# Returns detailed information about the dispatch. This includes destination and course IDs, as well as registration count.
|
1022
1053
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1071,6 +1102,7 @@ module RusticiSoftwareCloudV2
|
|
1071
1102
|
end
|
1072
1103
|
return data, status_code, headers
|
1073
1104
|
end
|
1105
|
+
|
1074
1106
|
# Get enabled status of a Dispatch
|
1075
1107
|
# Returns the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
1076
1108
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1125,6 +1157,7 @@ module RusticiSoftwareCloudV2
|
|
1125
1157
|
end
|
1126
1158
|
return data, status_code, headers
|
1127
1159
|
end
|
1160
|
+
|
1128
1161
|
# Get user PII hashing status for a Dispatch
|
1129
1162
|
# Returns whether or not user PII hashing is enabled for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
1130
1163
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1179,6 +1212,7 @@ module RusticiSoftwareCloudV2
|
|
1179
1212
|
end
|
1180
1213
|
return data, status_code, headers
|
1181
1214
|
end
|
1215
|
+
|
1182
1216
|
# Get registration count for a Dispatch
|
1183
1217
|
# Returns the registration count for the dispatch, as well as the date and time of the last count reset, if any. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
|
1184
1218
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1233,6 +1267,7 @@ module RusticiSoftwareCloudV2
|
|
1233
1267
|
end
|
1234
1268
|
return data, status_code, headers
|
1235
1269
|
end
|
1270
|
+
|
1236
1271
|
# Get tags for a Dispatch
|
1237
1272
|
# Returns the tags for the dispatch.
|
1238
1273
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1287,6 +1322,7 @@ module RusticiSoftwareCloudV2
|
|
1287
1322
|
end
|
1288
1323
|
return data, status_code, headers
|
1289
1324
|
end
|
1325
|
+
|
1290
1326
|
# Download a zip package for a Dispatch
|
1291
1327
|
# Downloads a zip package for the dispatch. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination.
|
1292
1328
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1347,6 +1383,7 @@ module RusticiSoftwareCloudV2
|
|
1347
1383
|
end
|
1348
1384
|
return data, status_code, headers
|
1349
1385
|
end
|
1386
|
+
|
1350
1387
|
# Get a list of Dispatches
|
1351
1388
|
# Returns a list of dispatches. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter will allow for viewing which destinations the course has been dispatched to. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
|
1352
1389
|
# @param [Hash] opts the optional parameters
|
@@ -1359,6 +1396,7 @@ module RusticiSoftwareCloudV2
|
|
1359
1396
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
|
1360
1397
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
|
1361
1398
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
1399
|
+
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token. (default to false)
|
1362
1400
|
# @return [DispatchListSchema]
|
1363
1401
|
def get_dispatches(opts = {})
|
1364
1402
|
data, _status_code, _headers = get_dispatches_with_http_info(opts)
|
@@ -1377,6 +1415,7 @@ module RusticiSoftwareCloudV2
|
|
1377
1415
|
# @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
|
1378
1416
|
# @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
|
1379
1417
|
# @option opts [String] :more Pagination token returned as `more` property of multi page list requests
|
1418
|
+
# @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
|
1380
1419
|
# @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
|
1381
1420
|
def get_dispatches_with_http_info(opts = {})
|
1382
1421
|
if @api_client.config.debugging
|
@@ -1396,6 +1435,7 @@ module RusticiSoftwareCloudV2
|
|
1396
1435
|
query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
|
1397
1436
|
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
1398
1437
|
query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
|
1438
|
+
query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
|
1399
1439
|
|
1400
1440
|
# header parameters
|
1401
1441
|
header_params = {}
|
@@ -1422,6 +1462,7 @@ module RusticiSoftwareCloudV2
|
|
1422
1462
|
end
|
1423
1463
|
return data, status_code, headers
|
1424
1464
|
end
|
1465
|
+
|
1425
1466
|
# Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification.
|
1426
1467
|
# Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step.
|
1427
1468
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1476,6 +1517,7 @@ module RusticiSoftwareCloudV2
|
|
1476
1517
|
end
|
1477
1518
|
return data, status_code, headers
|
1478
1519
|
end
|
1520
|
+
|
1479
1521
|
# Launch this dispatch using the IMS LTI 1.3 specification.
|
1480
1522
|
# Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course).
|
1481
1523
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1531,7 +1573,7 @@ module RusticiSoftwareCloudV2
|
|
1531
1573
|
|
1532
1574
|
# http body (model)
|
1533
1575
|
post_body = nil
|
1534
|
-
auth_names = [
|
1576
|
+
auth_names = []
|
1535
1577
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1536
1578
|
:header_params => header_params,
|
1537
1579
|
:query_params => query_params,
|
@@ -1543,6 +1585,7 @@ module RusticiSoftwareCloudV2
|
|
1543
1585
|
end
|
1544
1586
|
return data, status_code, headers
|
1545
1587
|
end
|
1588
|
+
|
1546
1589
|
# Get the information needed to configure a LTI 1.3 platform with the destination id `destinationId`
|
1547
1590
|
# @param destination_id Identifier for the destination
|
1548
1591
|
# @param [Hash] opts the optional parameters
|
@@ -1595,6 +1638,7 @@ module RusticiSoftwareCloudV2
|
|
1595
1638
|
end
|
1596
1639
|
return data, status_code, headers
|
1597
1640
|
end
|
1641
|
+
|
1598
1642
|
# Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification.
|
1599
1643
|
# Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch.
|
1600
1644
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1649,6 +1693,7 @@ module RusticiSoftwareCloudV2
|
|
1649
1693
|
end
|
1650
1694
|
return data, status_code, headers
|
1651
1695
|
end
|
1696
|
+
|
1652
1697
|
# Add tags to a Destination
|
1653
1698
|
# Applies the provided tags to the destination. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
|
1654
1699
|
# @param destination_id Identifier for the destination
|
@@ -1708,6 +1753,7 @@ module RusticiSoftwareCloudV2
|
|
1708
1753
|
end
|
1709
1754
|
return data, status_code, headers
|
1710
1755
|
end
|
1756
|
+
|
1711
1757
|
# Add a group of tags to a group of Destinations
|
1712
1758
|
# Applies all of the provided tags on all of the provided destinations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
|
1713
1759
|
# @param batch Array of ids, and array of tags for bulk tag operations
|
@@ -1761,6 +1807,7 @@ module RusticiSoftwareCloudV2
|
|
1761
1807
|
end
|
1762
1808
|
return data, status_code, headers
|
1763
1809
|
end
|
1810
|
+
|
1764
1811
|
# Add tags to a Dispatch
|
1765
1812
|
# Applies the provided tags to the dispatch. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
|
1766
1813
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1820,6 +1867,7 @@ module RusticiSoftwareCloudV2
|
|
1820
1867
|
end
|
1821
1868
|
return data, status_code, headers
|
1822
1869
|
end
|
1870
|
+
|
1823
1871
|
# Add a group of tags to a group of Dispatches
|
1824
1872
|
# Applies all of the provided tags on all of the provided dispatches. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
|
1825
1873
|
# @param batch Array of ids, and array of tags for bulk tag operations
|
@@ -1873,6 +1921,7 @@ module RusticiSoftwareCloudV2
|
|
1873
1921
|
end
|
1874
1922
|
return data, status_code, headers
|
1875
1923
|
end
|
1924
|
+
|
1876
1925
|
# Reset registration counts for a Destination's Dispatches
|
1877
1926
|
# Clears the registration count for all dispatches distributed to the destination. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
|
1878
1927
|
# @param destination_id Identifier for the destination
|
@@ -1926,6 +1975,7 @@ module RusticiSoftwareCloudV2
|
|
1926
1975
|
end
|
1927
1976
|
return data, status_code, headers
|
1928
1977
|
end
|
1978
|
+
|
1929
1979
|
# Reset registration count for a Dispatch
|
1930
1980
|
# Clears the registration count for the dispatch. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
|
1931
1981
|
# @param dispatch_id Identifier for the dispatch
|
@@ -1979,6 +2029,7 @@ module RusticiSoftwareCloudV2
|
|
1979
2029
|
end
|
1980
2030
|
return data, status_code, headers
|
1981
2031
|
end
|
2032
|
+
|
1982
2033
|
# Create or update a Destination
|
1983
2034
|
# Creates or updates information about the destination. -If the destination is being created, a name should be provided in the DestinationSchema. If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. >**Note:** >While the \"updated\" and \"created\" values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored.
|
1984
2035
|
# @param destination_id Identifier for the destination
|
@@ -2038,6 +2089,7 @@ module RusticiSoftwareCloudV2
|
|
2038
2089
|
end
|
2039
2090
|
return data, status_code, headers
|
2040
2091
|
end
|
2092
|
+
|
2041
2093
|
# Update enabled status for a Destination's Dispatches
|
2042
2094
|
# Updates the enabled status for all dispatches distributed to the destination. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
2043
2095
|
# @param destination_id Identifier for the destination
|
@@ -2097,6 +2149,7 @@ module RusticiSoftwareCloudV2
|
|
2097
2149
|
end
|
2098
2150
|
return data, status_code, headers
|
2099
2151
|
end
|
2152
|
+
|
2100
2153
|
# Update enabled status for a Dispatch
|
2101
2154
|
# Updates the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
|
2102
2155
|
# @param dispatch_id Identifier for the dispatch
|
@@ -2156,6 +2209,7 @@ module RusticiSoftwareCloudV2
|
|
2156
2209
|
end
|
2157
2210
|
return data, status_code, headers
|
2158
2211
|
end
|
2212
|
+
|
2159
2213
|
# Update user PII hashing status for a Destination
|
2160
2214
|
# Updates user PII hashing status for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
2161
2215
|
# @param destination_id Identifier for the destination
|
@@ -2215,6 +2269,7 @@ module RusticiSoftwareCloudV2
|
|
2215
2269
|
end
|
2216
2270
|
return data, status_code, headers
|
2217
2271
|
end
|
2272
|
+
|
2218
2273
|
# Update information about a Dispatch
|
2219
2274
|
# Updates information about the dispatch, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
|
2220
2275
|
# @param dispatch_id Identifier for the dispatch
|
@@ -2274,6 +2329,7 @@ module RusticiSoftwareCloudV2
|
|
2274
2329
|
end
|
2275
2330
|
return data, status_code, headers
|
2276
2331
|
end
|
2332
|
+
|
2277
2333
|
# Update user PII hashing status for a Dispatch
|
2278
2334
|
# Updates user PII hashing status for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
|
2279
2335
|
# @param dispatch_id Identifier for the dispatch
|
@@ -2333,6 +2389,7 @@ module RusticiSoftwareCloudV2
|
|
2333
2389
|
end
|
2334
2390
|
return data, status_code, headers
|
2335
2391
|
end
|
2392
|
+
|
2336
2393
|
# Update a group of Dispatches
|
2337
2394
|
# Updates information about a group of dispatches, such as registration cap, expiration date, and postback information. Can be filtered using the request parameters to provide a subset of results. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental modification of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
|
2338
2395
|
# @param dispatch_properties
|