1.0.0 • Published 7 years ago

mt_service v1.0.0

Weekly downloads
1
License
Apache-2.0
Repository
-
Last release
7 years ago

mt_service

MtService - JavaScript client for mt_service 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: v1.0.0
  • Package version: v1.0.0
  • Build date: 2017-04-06T14:06:25.670-04:00
  • 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 mt_service --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.

Getting Started

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

var MtService = require('mt_service');

var defaultClient = MtService.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new MtService.MtServiceApi()

var executionId = "executionId_example"; // {String} Execution id of the execution.


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

Documentation for API Endpoints

All URIs are relative to http://crcmsrserver.canadacentral.cloudapp.azure.com:12800

ClassMethodHTTP requestDescription
MtService.MtServiceApicancelAndDeleteBatchExecutionDELETE /api/mtService/v1.0.0/batch/{executionId}Cancels and deletes all batch executions for mtService.
MtService.MtServiceApigetBatchExecutionFileGET /api/mtService/v1.0.0/batch/{executionId}/{index}/files/{fileName}Gets a specific file from an execution in mtService.
MtService.MtServiceApigetBatchExecutionFilesGET /api/mtService/v1.0.0/batch/{executionId}/{index}/filesGets all files from an individual execution in mtService.
MtService.MtServiceApigetBatchExecutionStatusGET /api/mtService/v1.0.0/batch/{executionId}Gets all batch executions for mtService.
MtService.MtServiceApigetBatchExecutionsGET /api/mtService/v1.0.0/batchGets all batch executions for mtService.
MtService.MtServiceApimanualTransmissionPOST /api/mtService/v1.0.0
MtService.MtServiceApistartBatchExecutionPOST /api/mtService/v1.0.0/batch
MtService.UserApiloginPOST /loginLogs the user in
MtService.UserApirenewTokenPOST /login/refreshTokenThe user renews access token and refresh token
MtService.UserApirevokeRefreshTokenDELETE /login/refreshToken/{refreshToken}The user revokes a refresh token

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header