websea_rest_api v1.1.2

websea_rest_api

WebseaRestApi - JavaScript client for websea_rest_api REST API to access WebSEA function for a rich client implementation. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1.2
• Package version: 1.1.2
• 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 websea_rest_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 WebseaRestApi = require('websea_rest_api');

var api = new WebseaRestApi.DisplayApi()
var locationId = "locationId_example"; // {String} Location ID
var graphName = "graphName_example"; // {String} Curve ID
var resolution = 56; // {Number} the maximum number of point in the returned array
var opts = { 
  'start': 3.4, // {Number} staring time on x axis, minimum existing x is returned if empty
  'end': 3.4 // {Number} end time on x axis, minimum existing x is returned if empty
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.webseaSubgraphLocationIdGraphNameGet(locationId, graphName, resolution, opts, callback);

Documentation for API Endpoints

All URIs are relative to http:/api/

Documentation for Models

• WebseaRestApi.EnumGraphType
• WebseaRestApi.FlightEvent
• WebseaRestApi.FlightSequence
• WebseaRestApi.GraphInfo
• WebseaRestApi.GraphLocation
• WebseaRestApi.SubGraph

Documentation for Authorization

All endpoints do not require authorization.