Tsreg_api NPM | npm.io

ts

Ts - JavaScript client for ts No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

API version: 1.2.0
Package version: 1.2.0
Build date: 2016-08-16T12:07:11.268Z
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 ts --save

git

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

    npm install YOUR_USERNAME/ts --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 Ts = require('ts');

var defaultClient = Ts.ApiClient.instance;

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

var api = new Ts.TsDataApi()

var courseid = "courseid_example"; // {String} Identifier of the Course


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCoursesCourseid(courseid, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:4000/v1

Class	Method	HTTP request
Ts.TsDataApi	deleteCoursesCourseid	DELETE /courses/{courseid}
Ts.TsDataApi	deleteFoldersFolderid	DELETE /folders/{folderid}
Ts.TsDataApi	deleteLessonsLessonid	DELETE /lessons/{lessonid}
Ts.TsDataApi	deleteParticipantsParticipantid	DELETE /participants/{participantid}
Ts.TsDataApi	deleteSeasonsSeasonid	DELETE /seasons/{seasonid}
Ts.TsDataApi	deleteStudentsStudentid	DELETE /students/{studentid}
Ts.TsDataApi	getCourses	GET /courses/
Ts.TsDataApi	getCoursesCourseid	GET /courses/{courseid}
Ts.TsDataApi	getFolders	GET /folders/
Ts.TsDataApi	getFoldersFolderid	GET /folders/{folderid}
Ts.TsDataApi	getLessons	GET /lessons/
Ts.TsDataApi	getLessonsLessonid	GET /lessons/{lessonid}
Ts.TsDataApi	getParticipants	GET /participants/
Ts.TsDataApi	getParticipantsParticipantid	GET /participants/{participantid}
Ts.TsDataApi	getSeasons	GET /seasons/
Ts.TsDataApi	getSeasonsSeasonid	GET /seasons/{seasonid}
Ts.TsDataApi	getStudents	GET /students/
Ts.TsDataApi	getStudentsStudentid	GET /students/{studentid}
Ts.TsDataApi	postCourses	POST /courses/
Ts.TsDataApi	postFolders	POST /folders/
Ts.TsDataApi	postLessons	POST /lessons/
Ts.TsDataApi	postParticipants	POST /participants/
Ts.TsDataApi	postSeasons	POST /seasons/
Ts.TsDataApi	postStudents	POST /students/
Ts.TsDataApi	putCoursesCourseid	PUT /courses/{courseid}
Ts.TsDataApi	putFoldersFolderid	PUT /folders/{folderid}
Ts.TsDataApi	putLessonsLessonid	PUT /lessons/{lessonid}
Ts.TsDataApi	putParticipantsParticipantid	PUT /participants/{participantid}
Ts.TsDataApi	putSeasonsSeasonid	PUT /seasons/{seasonid}
Ts.TsDataApi	putStudentsStudentid	PUT /students/{studentid}

Documentation for Models

Documentation for Authorization

HTTP_BASIC

Type: HTTP basic authentication

superagent

@infinitebrahmanuniverse/nolb-tsr @everything-registry/sub-chunk-2983

1.2.0

8 years ago