Rrhet_quality_star_api NPM

rrhet_quality_star_api

RrhetQualityStarApi - JavaScript client for rrhet_quality_star_api Analyses MDS data and generates reports 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

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 rrhet_quality_star_api --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 rrhet_quality_star_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('rrhet_quality_star_api') 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/YOUR_USERNAME/rrhet_quality_star_api then install it via:

    npm install YOUR_USERNAME/rrhet_quality_star_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, 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 RrhetQualityStarApi = require('rrhet_quality_star_api');

var api = new RrhetQualityStarApi.DefaultApi()

var location = "location_example"; // {String} facility ID

var type = "type_example"; // {String} Type of chart (qm/4q/qm-gap/qm-risk)

var start = "start_example"; // {String} Start date in the format yyyy-MM-dd

var end = "end_example"; // {String} End date in the format yyyy-MM-dd

var token = "token_example"; // {String} The authorization token

var opts = { 
  'measure': "all", // {String} Quality measure
  'calculationType': "average" // {String} Type of calculation(Average/Predicitve)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.chartLocationTypeStartEndGet(location, type, start, end, token, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost:8079/v1

Class	Method	HTTP request	Description
RrhetQualityStarApi.DefaultApi	chartLocationTypeStartEndGet	GET /chart/{location}/{type}/{start}/{end}	Returns array of measures for individual quarters in the specified period.
RrhetQualityStarApi.DefaultApi	fileDownloadGet	GET /file-download	download file
RrhetQualityStarApi.DefaultApi	fileUploadPost	POST /file-upload	upload a file
RrhetQualityStarApi.DefaultApi	getDummyGraphDataGet	GET /getDummyGraphData	Returns dummy data for homepage graph
RrhetQualityStarApi.DefaultApi	improvementPlanGet	GET /improvement-plan	Improvement Plan
RrhetQualityStarApi.DefaultApi	improvementPlanIdDelete	DELETE /improvement-plan/{id}	Deleting improvement plan
RrhetQualityStarApi.DefaultApi	improvementPlanIdGet	GET /improvement-plan/{id}	Improvement Plan
RrhetQualityStarApi.DefaultApi	improvementPlanIdPut	PUT /improvement-plan/{id}	Updating improvement plan
RrhetQualityStarApi.DefaultApi	improvementPlanPost	POST /improvement-plan	Adding improcement plan
RrhetQualityStarApi.DefaultApi	measurePost	POST /measure	Measure
RrhetQualityStarApi.DefaultApi	qualityMeasureGet	GET /quality-measure	Quality Measure
RrhetQualityStarApi.DefaultApi	qualityMeasureIdGet	GET /quality-measure/{id}	Quality Measure
RrhetQualityStarApi.DefaultApi	quickTipsLocationGet	GET /quick-tips/{location}	Returns an array of quick tips
RrhetQualityStarApi.DefaultApi	reportPost	POST /report	QM report
RrhetQualityStarApi.DefaultApi	uploadMDSGet	GET /uploadMDS	Getting all MDS upload history
RrhetQualityStarApi.DefaultApi	uploadMDSLocationYearQuarterPost	POST /uploadMDS/{location}/{year}/{quarter}	upload MDS zip file
RrhetQualityStarApi.DefaultApi	usersGet	GET /users	returns users