Crohavior_web_service NPM

crohavior_web_service

CrohaviorWebService - JavaScript client for crohavior_web_service This is a Web Server design for Crohavior project. This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: class 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 crohavior_web_service --save

git

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

    npm install YOUR_USERNAME/crohavior_web_service --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.

Getting Started

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

var CrohaviorWebService = require('crohavior_web_service');

var defaultClient = CrohaviorWebService.ApiClient.instance;

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

var api = new CrohaviorWebService.HeatmapApi()

var projectId = 789; // {Number} id of the project of logged in user

var startTime = 56; // {Number} Start date/time

var endTime = 56; // {Number} End date/time


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

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/katsiatyna/Crohavior/1.0.0

Class	Method	HTTP request	Description
CrohaviorWebService.HeatmapApi	getHeatmapsByParameters	GET /heatmaps/{projectId}	Retrieves heatmap collection by parameters
CrohaviorWebService.ProjectApi	createProject	POST /projects	Create project for a specific user
CrohaviorWebService.ProjectApi	deleteProject	DELETE /projects/{projectId}	Delete project
CrohaviorWebService.ProjectApi	getProjectById	GET /projects/{projectId}	Get project by ID
CrohaviorWebService.ProjectApi	updateProject	PUT /projects/{projectId}	Updated project
CrohaviorWebService.TrajectoryApi	getTrajectoriesByParameters	GET /trajectories/{projectId}	Retrieves trajectories collection by parameters
CrohaviorWebService.UserApi	createUser	POST /users	Create user
CrohaviorWebService.UserApi	deleteUser	DELETE /users/{username}	Delete user
CrohaviorWebService.UserApi	getUserByName	GET /users/{username}	Get user by user name
CrohaviorWebService.UserApi	loginUser	GET /users/login	Logs user into the system
CrohaviorWebService.UserApi	logoutUser	GET /users/logout	Logs out current logged in user session
CrohaviorWebService.UserApi	updateUser	PUT /users/{username}	Updated user

Documentation for Models

Documentation for Authorization

AdminSecurity

Type: HTTP basic authentication

UserSecurity

Type: HTTP basic authentication

superagent

@everything-registry/sub-chunk-1413

1.0.0

7 years ago