school_api v1.0.0
school_api
SchoolApi - JavaScript client for school_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: v1
- Package version: v1
- 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 school_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/school_api then install it via:
npm install YOUR_USERNAME/school_api --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 SchoolApi = require('school_api');
var api = new SchoolApi.AccountApi()
var model = new SchoolApi.AddExternalLoginBindingModel(); // {AddExternalLoginBindingModel}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.accountAddExternalLogin(model, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:61789
Class | Method | HTTP request | Description |
---|---|---|---|
SchoolApi.AccountApi | accountAddExternalLogin | POST /api/Account/AddExternalLogin | |
SchoolApi.AccountApi | accountChangePassword | POST /api/Account/ChangePassword | |
SchoolApi.AccountApi | accountGetExternalLogin | GET /api/Account/ExternalLogin | |
SchoolApi.AccountApi | accountGetExternalLogins | GET /api/Account/ExternalLogins | |
SchoolApi.AccountApi | accountGetManageInfo | GET /api/Account/ManageInfo | |
SchoolApi.AccountApi | accountGetUserInfo | GET /api/Account/UserInfo | |
SchoolApi.AccountApi | accountLogout | POST /api/Account/Logout | |
SchoolApi.AccountApi | accountRegister | POST /api/Account/Register | |
SchoolApi.AccountApi | accountRegisterExternal | POST /api/Account/RegisterExternal | |
SchoolApi.AccountApi | accountRemoveLogin | POST /api/Account/RemoveLogin | |
SchoolApi.AccountApi | accountSetPassword | POST /api/Account/SetPassword | |
SchoolApi.StudentsApi | studentsDeleteStudent | DELETE /api/Students/{id} | |
SchoolApi.StudentsApi | studentsGetStudent | GET /api/Students/{id} | |
SchoolApi.StudentsApi | studentsGetStudents | GET /api/Students | |
SchoolApi.StudentsApi | studentsPostStudent | POST /api/Students | |
SchoolApi.StudentsApi | studentsPutStudent | PUT /api/Students/{id} | |
SchoolApi.ValuesApi | valuesDelete | DELETE /api/Values/{id} | |
SchoolApi.ValuesApi | valuesGet | GET /api/Values | |
SchoolApi.ValuesApi | valuesGet_0 | GET /api/Values/{id} | |
SchoolApi.ValuesApi | valuesPost | POST /api/Values | |
SchoolApi.ValuesApi | valuesPut | PUT /api/Values/{id} |
Documentation for Models
- SchoolApi.AddExternalLoginBindingModel
- SchoolApi.ChangePasswordBindingModel
- SchoolApi.ExternalLoginViewModel
- SchoolApi.ManageInfoViewModel
- SchoolApi.RegisterBindingModel
- SchoolApi.RegisterExternalBindingModel
- SchoolApi.RemoveLoginBindingModel
- SchoolApi.SetPasswordBindingModel
- SchoolApi.Student
- SchoolApi.UserInfoViewModel
- SchoolApi.UserLoginInfoViewModel
Documentation for Authorization
All endpoints do not require authorization.
8 years ago