/scormcloud-api-v2-client-ruby

Swagger Generated Ruby Client for SCORM Cloud API v2

Primary LanguageRubyApache License 2.0Apache-2.0

rustici_software_cloud_v2

RusticiSoftwareCloudV2 - the Ruby gem for the SCORM Cloud Rest API

REST API used for SCORM Cloud integrations.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Package version: 1.1.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build rustici_software_cloud_v2.gemspec

Then either install the gem locally:

gem install ./rustici_software_cloud_v2-1.1.0.gem

(for development, run gem install --dev ./rustici_software_cloud_v2-1.1.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'rustici_software_cloud_v2', '~> 1.1.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'rustici_software_cloud_v2', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'rustici_software_cloud_v2'

# Setup authorization
RusticiSoftwareCloudV2.configure do |config|
  # Configure HTTP basic authorization: APP_NORMAL
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure OAuth2 access token for authorization: OAUTH
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = RusticiSoftwareCloudV2::AboutApi.new

begin
  #Get back the API version and application name. 
  result = api_instance.get_about
  p result
rescue RusticiSoftwareCloudV2::ApiError => e
  puts "Exception when calling AboutApi->get_about: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://cloud.scorm.com/api/v2/

Class Method HTTP request Description
RusticiSoftwareCloudV2::AboutApi get_about GET /about Get back the API version and application name.
RusticiSoftwareCloudV2::ApplicationManagementApi create_application POST /appManagement/applications
RusticiSoftwareCloudV2::ApplicationManagementApi create_credential POST /appManagement/{childAppId}/credentials
RusticiSoftwareCloudV2::ApplicationManagementApi create_token POST /appManagement/token
RusticiSoftwareCloudV2::ApplicationManagementApi delete_application DELETE /appManagement/applications/{childAppId}
RusticiSoftwareCloudV2::ApplicationManagementApi delete_application_configuration_setting DELETE /appManagement/configuration/{settingId} Clears the settingId value for this level
RusticiSoftwareCloudV2::ApplicationManagementApi delete_credential DELETE /appManagement/{childAppId}/credentials/{credentialId}
RusticiSoftwareCloudV2::ApplicationManagementApi get_application_configuration GET /appManagement/configuration
RusticiSoftwareCloudV2::ApplicationManagementApi get_application_list GET /appManagement/applications Get a list of all applications for the realm.
RusticiSoftwareCloudV2::ApplicationManagementApi get_credentials GET /appManagement/{childAppId}/credentials
RusticiSoftwareCloudV2::ApplicationManagementApi set_application_configuration POST /appManagement/configuration
RusticiSoftwareCloudV2::ApplicationManagementApi update_credential PUT /appManagement/{childAppId}/credentials/{credentialId}
RusticiSoftwareCloudV2::AuthenticationApi get_app_token POST /oauth/authenticate/application/token Authenticates for a oauth token
RusticiSoftwareCloudV2::CourseApi build_course_preview_launch_link POST /courses/{courseId}/preview Get a link to preview a course.
RusticiSoftwareCloudV2::CourseApi build_course_preview_launch_link_with_version POST /courses/{courseId}/versions/{versionId}/preview Get a link to preview a particular course version.
RusticiSoftwareCloudV2::CourseApi create_fetch_and_import_course_job POST /courses/importJobs Fetch and import a course.
RusticiSoftwareCloudV2::CourseApi create_upload_and_import_course_job POST /courses/importJobs/upload Upload and import a course.
RusticiSoftwareCloudV2::CourseApi delete_course DELETE /courses/{courseId} Delete a course.
RusticiSoftwareCloudV2::CourseApi delete_course_configuration_setting DELETE /courses/{courseId}/configuration/{settingId} Clear a course configuration.
RusticiSoftwareCloudV2::CourseApi delete_course_tags DELETE /courses/{courseId}/tags Delete course tags.
RusticiSoftwareCloudV2::CourseApi delete_course_version DELETE /courses/{courseId}/versions/{versionId} Delete a course version.
RusticiSoftwareCloudV2::CourseApi delete_course_version_configuration_setting DELETE /courses/{courseId}/versions/{versionId}/configuration/{settingId} Clear a configuration setting for a version of a course.
RusticiSoftwareCloudV2::CourseApi get_course GET /courses/{courseId} Get course details.
RusticiSoftwareCloudV2::CourseApi get_course_configuration GET /courses/{courseId}/configuration Get course configuration.
RusticiSoftwareCloudV2::CourseApi get_course_statements GET /courses/{courseId}/xAPIStatements Get course xAPI statements.
RusticiSoftwareCloudV2::CourseApi get_course_tags GET /courses/{courseId}/tags Get course tags.
RusticiSoftwareCloudV2::CourseApi get_course_version_configuration GET /courses/{courseId}/versions/{versionId}/configuration Get configuration for a version of a course.
RusticiSoftwareCloudV2::CourseApi get_course_version_info GET /courses/{courseId}/versions/{versionId} Get details on a course version.
RusticiSoftwareCloudV2::CourseApi get_course_version_statements GET /courses/{courseId}/versions/{versionId}/xAPIStatements Get xAPI statements for a course version.
RusticiSoftwareCloudV2::CourseApi get_course_versions GET /courses/{courseId}/versions Get details on a course's versions.
RusticiSoftwareCloudV2::CourseApi get_courses GET /courses Get all courses.
RusticiSoftwareCloudV2::CourseApi get_import_job_status GET /courses/importJobs/{importJobId} Get course import job status.
RusticiSoftwareCloudV2::CourseApi put_course_tags PUT /courses/{courseId}/tags Set course tags.
RusticiSoftwareCloudV2::CourseApi put_course_tags_batch PUT /courses/tags Set tags on courses.
RusticiSoftwareCloudV2::CourseApi set_course_configuration POST /courses/{courseId}/configuration Set course configuration.
RusticiSoftwareCloudV2::CourseApi set_course_title PUT /courses/{courseId}/title Set the title of a course.
RusticiSoftwareCloudV2::CourseApi set_course_version_configuration POST /courses/{courseId}/versions/{versionId}/configuration Set configuration for a version of a course.
RusticiSoftwareCloudV2::DispatchApi create_destinations POST /dispatch/destinations DestinationsByTenant
RusticiSoftwareCloudV2::DispatchApi create_dispatches POST /dispatch/dispatches Create dispatches.
RusticiSoftwareCloudV2::DispatchApi delete_destination DELETE /dispatch/destinations/{destinationId} Delete destination
RusticiSoftwareCloudV2::DispatchApi delete_destination_dispatches DELETE /dispatch/destinations/{destinationId}/dispatches Delete dispatches in destination
RusticiSoftwareCloudV2::DispatchApi delete_destination_tags DELETE /dispatch/destinations/{destinationId}/tags Delete the tags for this destination
RusticiSoftwareCloudV2::DispatchApi delete_dispatch DELETE /dispatch/dispatches/{dispatchId} Delete the dispatch with dispatchId.
RusticiSoftwareCloudV2::DispatchApi delete_dispatch_postback_info DELETE /dispatch/dispatches/{dispatchId}/postback DispatchesByTenantAndDispatchId
RusticiSoftwareCloudV2::DispatchApi delete_dispatch_tags DELETE /dispatch/dispatches/{dispatchId}/tags Delete the tags for this dispatch.
RusticiSoftwareCloudV2::DispatchApi enable_registration_instancing POST /dispatch/destinations/{destinationId}/dispatches/registrationInstancing DestinationsDispatchesRegistrationInstancing
RusticiSoftwareCloudV2::DispatchApi get_destination GET /dispatch/destinations/{destinationId} Get destination information by destinationId.
RusticiSoftwareCloudV2::DispatchApi get_destination_dispatch_registration_count GET /dispatch/destinations/{destinationId}/dispatches/registrationCount DestinationsDispatchesRegistrationCount
RusticiSoftwareCloudV2::DispatchApi get_destination_dispatch_zip GET /dispatch/destinations/{destinationId}/dispatches/zip Get a ZIP of related dispatches.
RusticiSoftwareCloudV2::DispatchApi get_destination_dispatches GET /dispatch/destinations/{destinationId}/dispatches Get a list of dispatches in this destination
RusticiSoftwareCloudV2::DispatchApi get_destination_hash_user_info GET /dispatch/destinations/{destinationId}/dispatches/hashUserInfo True if the destination is set to hash user info, or false if it is disabled.
RusticiSoftwareCloudV2::DispatchApi get_destination_tags GET /dispatch/destinations/{destinationId}/tags Get the tags for this destination
RusticiSoftwareCloudV2::DispatchApi get_destinations GET /dispatch/destinations getAllDestinations
RusticiSoftwareCloudV2::DispatchApi get_dispatch GET /dispatch/dispatches/{dispatchId} Get dispatch by id.
RusticiSoftwareCloudV2::DispatchApi get_dispatch_enabled GET /dispatch/dispatches/{dispatchId}/enabled Get the enabled status for dispatchId.
RusticiSoftwareCloudV2::DispatchApi get_dispatch_hash_user_info GET /dispatch/dispatches/{dispatchId}/hashUserInfo Get if this dispatch has PII hashing enabled.
RusticiSoftwareCloudV2::DispatchApi get_dispatch_registration_count GET /dispatch/dispatches/{dispatchId}/registrationCount Get the registration count for dispatchId.
RusticiSoftwareCloudV2::DispatchApi get_dispatch_tags GET /dispatch/dispatches/{dispatchId}/tags Get the tags for this dispatch.
RusticiSoftwareCloudV2::DispatchApi get_dispatch_zip GET /dispatch/dispatches/{dispatchId}/zip Get the ZIP for the dispatchId.
RusticiSoftwareCloudV2::DispatchApi get_dispatches GET /dispatch/dispatches All Dispatches in the system for an AppId
RusticiSoftwareCloudV2::DispatchApi put_destination_tags PUT /dispatch/destinations/{destinationId}/tags Set the tags for this destination
RusticiSoftwareCloudV2::DispatchApi put_destination_tags_batch PUT /dispatch/destinations/tags Sets all of the provided tags on all of the provided destinations
RusticiSoftwareCloudV2::DispatchApi put_dispatch_tags PUT /dispatch/dispatches/{dispatchId}/tags Set the tags for this dispatch.
RusticiSoftwareCloudV2::DispatchApi put_dispatch_tags_batch PUT /dispatch/dispatches/tags Sets all of the provided tags on all of the provided dispatches
RusticiSoftwareCloudV2::DispatchApi reset_destination_dispatch_registration_count DELETE /dispatch/destinations/{destinationId}/dispatches/registrationCount DestinationsDispatchesRegistrationCount
RusticiSoftwareCloudV2::DispatchApi reset_dispatch_registration_count DELETE /dispatch/dispatches/{dispatchId}/registrationCount Reset registration count.
RusticiSoftwareCloudV2::DispatchApi set_destination PUT /dispatch/destinations/{destinationId}
RusticiSoftwareCloudV2::DispatchApi set_destination_dispatch_enabled POST /dispatch/destinations/{destinationId}/dispatches/enabled DestinationsDispatchesEnabledByTenant
RusticiSoftwareCloudV2::DispatchApi set_dispatch_enabled PUT /dispatch/dispatches/{dispatchId}/enabled Set the enabled status for dispatchId.
RusticiSoftwareCloudV2::DispatchApi update_destination_hash_user_info PUT /dispatch/destinations/{destinationId}/dispatches/hashUserInfo Enable or disable hashing of the user info for the destination.
RusticiSoftwareCloudV2::DispatchApi update_dispatch PUT /dispatch/dispatches/{dispatchId} Update the dispatch with dispatchId.
RusticiSoftwareCloudV2::DispatchApi update_dispatch_hash_user_info PUT /dispatch/dispatches/{dispatchId}/hashUserInfo Enable or disable hashing of the user info for the dispatch.
RusticiSoftwareCloudV2::InvitationsApi create_private_invitation POST /invitations/private Create a private invitation to a course.
RusticiSoftwareCloudV2::InvitationsApi create_public_invitation POST /invitations/public Create a publicly accessible invitation to a course.
RusticiSoftwareCloudV2::InvitationsApi delete_invitation_tags DELETE /invitations/{invitationId}/tags Delete the tags for this invitation
RusticiSoftwareCloudV2::InvitationsApi get_all_invitations GET /invitations Get a list of invitation summaries.
RusticiSoftwareCloudV2::InvitationsApi get_invitation_tags GET /invitations/{invitationId}/tags Get the tags for this invitation
RusticiSoftwareCloudV2::InvitationsApi get_private_invitation GET /invitations/private/{invitationId} Get a information about a private invitation.
RusticiSoftwareCloudV2::InvitationsApi get_private_invitation_job_status GET /invitations/private/{invitationId}/jobStatus Get the status of an invitation job.
RusticiSoftwareCloudV2::InvitationsApi get_private_invitations GET /invitations/private Get a list of all private invitations.
RusticiSoftwareCloudV2::InvitationsApi get_private_user_invitations GET /invitations/private/{invitationId}/userInvitations Get a list of user invitations.
RusticiSoftwareCloudV2::InvitationsApi get_public_invitation GET /invitations/public/{invitationId} Get a information about a public invitation.
RusticiSoftwareCloudV2::InvitationsApi get_public_invitations GET /invitations/public Get a list of all public invitations.
RusticiSoftwareCloudV2::InvitationsApi get_public_user_invitations GET /invitations/public/{invitationId}/userInvitations Get a list of user invitations.
RusticiSoftwareCloudV2::InvitationsApi put_invitation_tags PUT /invitations/{invitationId}/tags Set the tags for this invitation
RusticiSoftwareCloudV2::InvitationsApi put_invitation_tags_batch PUT /invitations/tags Sets all of the provided tags on all of the provided invitations
RusticiSoftwareCloudV2::InvitationsApi update_private_invitation PUT /invitations/private/{invitationId} Update attributes of this invitation.
RusticiSoftwareCloudV2::InvitationsApi update_public_invitation PUT /invitations/public/{invitationId} Update attributes of this invitation.
RusticiSoftwareCloudV2::LearnerApi delete_all_learner_data POST /learner/{learnerId}/delete-information Deletes all of the information associated with a learner in an application, by learner id.
RusticiSoftwareCloudV2::LearnerApi delete_learner_tags DELETE /learner/{learnerId}/tags Delete the tags for this learner
RusticiSoftwareCloudV2::LearnerApi get_learner_tags GET /learner/{learnerId}/tags Get the tags for this learner
RusticiSoftwareCloudV2::LearnerApi put_learner_tags PUT /learner/{learnerId}/tags Set the tags for this learner
RusticiSoftwareCloudV2::LearnerApi put_learner_tags_batch PUT /learner/tags Sets all of the provided tags on all of the provided learners
RusticiSoftwareCloudV2::LearnerApi update_learner_info POST /learner/{learnerId}/updateInfo Update a learner's info on all of their registrations.
RusticiSoftwareCloudV2::PingApi ping_app_id GET /ping
RusticiSoftwareCloudV2::RegistrationApi build_registration_launch_link POST /registrations/{registrationId}/launchLink Get registration launch link.
RusticiSoftwareCloudV2::RegistrationApi create_new_registration_instance POST /registrations/{registrationId}/instances
RusticiSoftwareCloudV2::RegistrationApi create_registration POST /registrations Create a registration.
RusticiSoftwareCloudV2::RegistrationApi delete_registration DELETE /registrations/{registrationId} Delete a registration.
RusticiSoftwareCloudV2::RegistrationApi delete_registration_configuration_setting DELETE /registrations/{registrationId}/configuration/{settingId} Clear a registration configuration.
RusticiSoftwareCloudV2::RegistrationApi delete_registration_global_data DELETE /registrations/{registrationId}/globalData Delete the global data of a registration.
RusticiSoftwareCloudV2::RegistrationApi delete_registration_instance DELETE /registrations/{registrationId}/instances/{instanceId} Delete instance instanceId of registrationId.
RusticiSoftwareCloudV2::RegistrationApi delete_registration_instance_configuration_setting DELETE /registrations/{registrationId}/instances/{instanceId}/configuration/{settingId} Clear a configuration for an instance of a registration.
RusticiSoftwareCloudV2::RegistrationApi delete_registration_progress DELETE /registrations/{registrationId}/progress Reset a registration.
RusticiSoftwareCloudV2::RegistrationApi delete_registration_tags DELETE /registrations/{registrationId}/tags Delete tags from a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration HEAD /registrations/{registrationId} See if a registration exists.
RusticiSoftwareCloudV2::RegistrationApi get_registration_configuration GET /registrations/{registrationId}/configuration Get registration configuration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_instance_configuration GET /registrations/{registrationId}/instances/{instanceId}/configuration Get configuration for instance of registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_instance_launch_history GET /registrations/{registrationId}/instances/{instanceId}/launchHistory Get launch history for an instance of a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_instance_progress GET /registrations/{registrationId}/instances/{instanceId} Get details of an instance of a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_instance_statements GET /registrations/{registrationId}/instances/{instanceId}/xAPIStatements Get xAPI statements for an instance of a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_instances GET /registrations/{registrationId}/instances Get all instances of a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_launch_history GET /registrations/{registrationId}/launchHistory Get launch history for a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_progress GET /registrations/{registrationId} Get details of a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_statements GET /registrations/{registrationId}/xAPIStatements Get xAPI statements for a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registration_tags GET /registrations/{registrationId}/tags Get tags for a registration.
RusticiSoftwareCloudV2::RegistrationApi get_registrations GET /registrations Get a list of all registrations.
RusticiSoftwareCloudV2::RegistrationApi put_registration_tags PUT /registrations/{registrationId}/tags Set tags on a registration.
RusticiSoftwareCloudV2::RegistrationApi put_registration_tags_batch PUT /registrations/tags Set tags on registrations.
RusticiSoftwareCloudV2::RegistrationApi set_registration_configuration POST /registrations/{registrationId}/configuration Set registration configuration.
RusticiSoftwareCloudV2::RegistrationApi set_registration_instance_configuration POST /registrations/{registrationId}/instances/{instanceId}/configuration Set configuration for instance of registration.
RusticiSoftwareCloudV2::RegistrationApi test_registration_postback POST /registrations/postBackTest Send a test postback with a provided configuration.
RusticiSoftwareCloudV2::ReportingApi get_account_info GET /reporting/accountInfo Get all of the account information specified by the given app ID
RusticiSoftwareCloudV2::ReportingApi get_reportage_auth_token GET /reporting/reportageAuth Get a session authentication token to use when launching Reportage
RusticiSoftwareCloudV2::ReportingApi get_reportage_link GET /reporting/reportageLink Get the link to a page in Reportage with the given authentication and permissions
RusticiSoftwareCloudV2::XapiApi create_statement_pipe POST /xapi/statementPipes Create an xAPI statement pipe.
RusticiSoftwareCloudV2::XapiApi create_xapi_credential POST /xapi/credentials Create a xAPI credential.
RusticiSoftwareCloudV2::XapiApi delete_statement_pipe DELETE /xapi/statementPipes/{statementPipeId} Deletes this xAPI pipe.
RusticiSoftwareCloudV2::XapiApi delete_xapi_credential DELETE /xapi/credentials/{xapiCredentialId} Deletes the xAPI credentials specified by the xAPI credentials id
RusticiSoftwareCloudV2::XapiApi get_statement_pipe GET /xapi/statementPipes/{statementPipeId} Retrieves xAPI pipe for xapiPipeId
RusticiSoftwareCloudV2::XapiApi get_statement_pipes GET /xapi/statementPipes Get all of the xapiPipes for appId
RusticiSoftwareCloudV2::XapiApi get_xapi_credential GET /xapi/credentials/{xapiCredentialId} Retrieves the xAPI credentials specified by the xAPI credentials id.
RusticiSoftwareCloudV2::XapiApi get_xapi_credentials GET /xapi/credentials Get the list of xapiCredentials
RusticiSoftwareCloudV2::XapiApi set_statement_pipe PUT /xapi/statementPipes/{statementPipeId} Edit an existing xAPI pipe or create a new one.
RusticiSoftwareCloudV2::XapiApi set_xapi_credential PUT /xapi/credentials/{xapiCredentialId} Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id
RusticiSoftwareCloudV2::ZoomiApi delete_application_zoomi_keys DELETE /zoomi/key Delete the keys for an application.
RusticiSoftwareCloudV2::ZoomiApi delete_zoomi_course DELETE /zoomi/course/{courseId}/version/{versionId} Deletes the course in zoomi
RusticiSoftwareCloudV2::ZoomiApi get_application_zoomi_company_id GET /zoomi Gets the zoomi company id of an application.
RusticiSoftwareCloudV2::ZoomiApi get_application_zoomi_public_key GET /zoomi/key Gets the public key for an application.
RusticiSoftwareCloudV2::ZoomiApi get_course_zoomi_enabled GET /zoomi/course/{courseId}/version/{versionId}/enabled Gets the zoomi enabled value of a course
RusticiSoftwareCloudV2::ZoomiApi get_zoomi_course_status GET /zoomi/course/{courseId}/version/{versionId} Gets the status for a course and imports to Zoomi
RusticiSoftwareCloudV2::ZoomiApi set_application_zoomi_company_id PUT /zoomi Set the zoomi company id value of an application.
RusticiSoftwareCloudV2::ZoomiApi set_course_zoomi_enabled PUT /zoomi/course/{courseId}/version/{versionId}/enabled Set the zoomi enabled value of a course.

Documentation for Models

Documentation for Authorization

APP_MANAGEMENT

  • Type: HTTP basic authentication

APP_NORMAL

  • Type: HTTP basic authentication

OAUTH

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • read: Grants read access
    • write: Grants write access
    • delete: Grants deletion access
    • admin: Grants read, write, and account management access
    • read:course: Grants read access to course methods
    • write:course: Grants write access to course methods
    • delete:course: Grants deletion access to course methods
    • read:dispatch: Grants read access to dispatch methods
    • write:dispatch: Grants write access to dispatch methods
    • delete:dispatch: Grants deletion access to dispatch methods
    • read:invitation: Grants read access to invitation methods
    • write:invitation: Grants write access to invitation methods
    • delete:invitation: Grants deletion access to invitation methods
    • read:ping: Grants read access to the ping method
    • read:registration: Grants read access to registration methods
    • write:registration: Grants write access to registration methods
    • delete:registration: Grants deletion access to registration methods
    • read:reporting: Grants read access to reporting methods
    • read:xapicredential: Grants read access to xapi credential methods
    • write:xapicredential: Grants write access to xapi credential methods
    • delete:xapicredential: Grants deletion access to xapi credential methods
    • read:xapipipe: Grants read access to xapi pipe methods
    • write:xapipipe: Grants write access to xapi pipe methods
    • delete:xapipipe: Grants deletion access to xapi pipe methods
    • read:appmgmt: Grants read access to app management methods
    • write:appmgmt: Grants write access to app management methods
    • delete:appmgmt: Grants deletion access to app management methods
    • read:learner: Grants read access to the learner methods
    • write:learner: Grants write access to the learner methods
    • read:about: Grants read permission for the about method