api_simca v1.0.3

api_simca

ApiSimca - JavaScript client for api_simca SIMCA API Client This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://bitbucket.org/pdg-icesi/simca-backend

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 api_simca --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your api_simca from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('api_simca') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 ApiSimca = require('api_simca');

var api = new ApiSimca.DatacontrollerApi()

var measurementId = 56; // {Number} measurementId

var pollutantId = 56; // {Number} pollutantId


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

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Documentation for Models

• ApiSimca.AddMeasurementDTO
• ApiSimca.AddPlaceDTO
• ApiSimca.AddPollutantDTO
• ApiSimca.AddUserDTO
• ApiSimca.AddUserProfileDTO
• ApiSimca.AddValuesToMeasurementDTO
• ApiSimca.CountryDTO
• ApiSimca.MeasurementDTO
• ApiSimca.MeasurementDataDTO
• ApiSimca.MeasurementsDTO
• ApiSimca.PlaceDTO
• ApiSimca.PlacesDTO
• ApiSimca.PollutantDTO
• ApiSimca.PollutantsDTO
• ApiSimca.RequestPasswordResetDTO
• ApiSimca.ResetPasswordDTO
• ApiSimca.StateDTO
• ApiSimca.TimezoneDTO
• ApiSimca.UserDTO
• ApiSimca.UserProfileDTO
• ApiSimca.UsersDTO

Documentation for Authorization

oauth2schema

• Type: OAuth
• Flow: implicit
• Authorization URL: http://localhost:8080/oauth/token
• Scopes:
  • global: Global authorization scope