simva-sdk v1.0.0

simva_api

SimvaApi - JavaScript client for simva_api Simva, AKA Simple Validator, AKA SurveyManager is the evolution of a tool created to integrate and ease the task of validating serious games using pre-post surveys as a control point. This version allows to create more complex studies with more variety of activities and different allocations. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.javascript.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 simva_api --save

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):

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 SimvaApi = require('simva_api');

var api = new SimvaApi.AdminsApi()
var opts = { 
  'searchString': "searchString_example", // {String} pass an optional search string for result filtering
  'skip': 56, // {Number} number of records to skip for pagination
  'limit': 56 // {Number} maximum number of records to return
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getGroups(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/Synpheros/Simva/1.0.0

Documentation for Models

• SimvaApi.Activity
• SimvaApi.AddGroupBody
• SimvaApi.AddGroupToStudyBody
• SimvaApi.AddStudyBody
• SimvaApi.AddStudyToGroupBody
• SimvaApi.Allocator
• SimvaApi.Group
• SimvaApi.LoginBody
• SimvaApi.Study
• SimvaApi.Test
• SimvaApi.User
• SimvaApi.UserExternalEntity

Documentation for Authorization

All endpoints do not require authorization.