rustici-software-cloud-v2

RusticiSoftwareCloudV2 - JavaScript client for rustici-software-cloud-v2 REST API used for SCORM Cloud integrations. This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0 beta
• Package version: 2.0 beta
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install rustici-software-cloud-v2 --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your rustici-software-cloud-v2 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('rustici-software-cloud-v2') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var RusticiSoftwareCloudV2 = require('rustici-software-cloud-v2');

var defaultClient = RusticiSoftwareCloudV2.ApiClient.instance;

// Configure HTTP basic authorization: APP_NORMAL
var APP_NORMAL = defaultClient.authentications['APP_NORMAL'];
APP_NORMAL.username = 'YOUR USERNAME'
APP_NORMAL.password = 'YOUR PASSWORD'

// Configure OAuth2 access token for authorization: OAUTH
var OAUTH = defaultClient.authentications['OAUTH'];
OAUTH.accessToken = "YOUR ACCESS TOKEN"

var api = new RusticiSoftwareCloudV2.ApplicationManagementApi()

var applicationName = "applicationName_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApplication(applicationName, callback);

Documentation for API Endpoints

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

Documentation for Models

• RusticiSoftwareCloudV2.ActivityResultSchema
• RusticiSoftwareCloudV2.ApplicationListSchema
• RusticiSoftwareCloudV2.ApplicationSchema
• RusticiSoftwareCloudV2.ApplicationToken
• RusticiSoftwareCloudV2.CommentSchema
• RusticiSoftwareCloudV2.CompletionAmountSchema
• RusticiSoftwareCloudV2.CourseActivitySchema
• RusticiSoftwareCloudV2.CourseListNonPagedSchema
• RusticiSoftwareCloudV2.CourseListSchema
• RusticiSoftwareCloudV2.CourseReferenceSchema
• RusticiSoftwareCloudV2.CourseSchema
• RusticiSoftwareCloudV2.CourseTagsBatchSchema
• RusticiSoftwareCloudV2.CreateRegistrationSchema
• RusticiSoftwareCloudV2.CredentialCreatedSchema
• RusticiSoftwareCloudV2.CredentialListSchema
• RusticiSoftwareCloudV2.CredentialRequestSchema
• RusticiSoftwareCloudV2.CredentialSchema
• RusticiSoftwareCloudV2.ImportFetchRequestSchema
• RusticiSoftwareCloudV2.ImportJobResultSchema
• RusticiSoftwareCloudV2.ImportResultSchema
• RusticiSoftwareCloudV2.IntegerResultSchema
• RusticiSoftwareCloudV2.ItemValuePairSchema
• RusticiSoftwareCloudV2.LaunchHistoryListSchema
• RusticiSoftwareCloudV2.LaunchHistorySchema
• RusticiSoftwareCloudV2.LaunchLinkRequestSchema
• RusticiSoftwareCloudV2.LaunchLinkSchema
• RusticiSoftwareCloudV2.LearnerPreferenceSchema
• RusticiSoftwareCloudV2.LearnerSchema
• RusticiSoftwareCloudV2.LinkSchema
• RusticiSoftwareCloudV2.MessageSchema
• RusticiSoftwareCloudV2.MetadataSchema
• RusticiSoftwareCloudV2.ObjectiveSchema
• RusticiSoftwareCloudV2.PermissionsSchema
• RusticiSoftwareCloudV2.PingSchema
• RusticiSoftwareCloudV2.PostBackSchema
• RusticiSoftwareCloudV2.RegistrationCompletion
• RusticiSoftwareCloudV2.RegistrationListSchema
• RusticiSoftwareCloudV2.RegistrationSchema
• RusticiSoftwareCloudV2.RegistrationSuccess
• RusticiSoftwareCloudV2.RegistrationTagsBatchSchema
• RusticiSoftwareCloudV2.ResponseError
• RusticiSoftwareCloudV2.RuntimeInteractionSchema
• RusticiSoftwareCloudV2.RuntimeObjectiveSchema
• RusticiSoftwareCloudV2.RuntimeSchema
• RusticiSoftwareCloudV2.ScoreSchema
• RusticiSoftwareCloudV2.SettingItem
• RusticiSoftwareCloudV2.SettingListSchema
• RusticiSoftwareCloudV2.SettingMetadata
• RusticiSoftwareCloudV2.SettingValidValue
• RusticiSoftwareCloudV2.SettingsIndividualSchema
• RusticiSoftwareCloudV2.SettingsPostSchema
• RusticiSoftwareCloudV2.SharedDataEntrySchema
• RusticiSoftwareCloudV2.StaticPropertiesSchema
• RusticiSoftwareCloudV2.StringResultSchema
• RusticiSoftwareCloudV2.TagListSchema
• RusticiSoftwareCloudV2.TagPostSchema
• RusticiSoftwareCloudV2.TitleSchema
• RusticiSoftwareCloudV2.TokenRequestSchema
• RusticiSoftwareCloudV2.XapiAccount
• RusticiSoftwareCloudV2.XapiActivity
• RusticiSoftwareCloudV2.XapiActivityDefinition
• RusticiSoftwareCloudV2.XapiAgentGroup
• RusticiSoftwareCloudV2.XapiAttachment
• RusticiSoftwareCloudV2.XapiContext
• RusticiSoftwareCloudV2.XapiContextActivity
• RusticiSoftwareCloudV2.XapiInteractionComponent
• RusticiSoftwareCloudV2.XapiResult
• RusticiSoftwareCloudV2.XapiScore
• RusticiSoftwareCloudV2.XapiStatement
• RusticiSoftwareCloudV2.XapiStatementReference
• RusticiSoftwareCloudV2.XapiStatementResult
• RusticiSoftwareCloudV2.XapiVerb

Documentation for Authorization

APP_MANAGEMENT

• Type: HTTP basic authentication

APP_NORMAL

• Type: HTTP basic authentication

LAUNCH_TOKEN

• Type: API key
• API key parameter name: launchToken
• Location: URL query string

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

URL_TOKEN

• Type: API key
• API key parameter name: authtoken
• Location: URL query string