# RrhetQualityStarApi.DefaultApi

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

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


<a name="chartLocationTypeStartEndGet"></a>
# **chartLocationTypeStartEndGet**
> [Chart] chartLocationTypeStartEndGet(location, type, start, end, token, opts)

Returns array of measures for individual quarters in the specified period.

Returns measure for individual quarters for the specified period.

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = 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);
  }
};
apiInstance.chartLocationTypeStartEndGet(location, type, start, end, token, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **location** | **String**| facility ID | 
 **type** | **String**| Type of chart (qm/4q/qm-gap/qm-risk) | 
 **start** | **String**| Start date in the format yyyy-MM-dd | 
 **end** | **String**| End date in the format yyyy-MM-dd | 
 **token** | **String**| The authorization token | 
 **measure** | **String**| Quality measure | [optional] [default to all]
 **calculationType** | **String**| Type of calculation(Average/Predicitve) | [optional] [default to average]

### Return type

[**[Chart]**](Chart.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="fileDownloadGet"></a>
# **fileDownloadGet**
> UploadFile fileDownloadGet(uuid, extension, token)

download file

download a file user has uploaded

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var uuid = "uuid_example"; // String | 

var extension = "extension_example"; // String | 

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.fileDownloadGet(uuid, extension, token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uuid** | **String**|  | 
 **extension** | **String**|  | 
 **token** | **String**| The authorization token | 

### Return type

[**UploadFile**](UploadFile.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="fileUploadPost"></a>
# **fileUploadPost**
> UploadFile fileUploadPost(token, opts)

upload a file

upload files for improvement plan

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token

var opts = { 
  'file': "/path/to/file.txt" // File | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.fileUploadPost(token, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 
 **file** | **File**|  | [optional] 

### Return type

[**UploadFile**](UploadFile.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: multipart/form-data
 - **Accept**: application/json

<a name="getDummyGraphDataGet"></a>
# **getDummyGraphDataGet**
> PointsComparisonData getDummyGraphDataGet(token)

Returns dummy data for homepage graph

Returns dummy data for homepage graph

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDummyGraphDataGet(token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 

### Return type

[**PointsComparisonData**](PointsComparisonData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="improvementPlanGet"></a>
# **improvementPlanGet**
> [ImprovementPlan] improvementPlanGet(token)

Improvement Plan

This endpoint returns all improvement plans

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.improvementPlanGet(token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 

### Return type

[**[ImprovementPlan]**](ImprovementPlan.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="improvementPlanIdDelete"></a>
# **improvementPlanIdDelete**
> ImprovementPlan improvementPlanIdDelete(id, token)

Deleting improvement plan

Deleting improvement plan by given id

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var id = "id_example"; // String | improvement plan's id which you want to delete

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.improvementPlanIdDelete(id, token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| improvement plan&#39;s id which you want to delete | 
 **token** | **String**| The authorization token | 

### Return type

[**ImprovementPlan**](ImprovementPlan.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="improvementPlanIdGet"></a>
# **improvementPlanIdGet**
> ImprovementPlan improvementPlanIdGet(id, token)

Improvement Plan

This request will fetch improvement plan by the given id.

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var id = "id_example"; // String | testing

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.improvementPlanIdGet(id, token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| testing | 
 **token** | **String**| The authorization token | 

### Return type

[**ImprovementPlan**](ImprovementPlan.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="improvementPlanIdPut"></a>
# **improvementPlanIdPut**
> ImprovementPlan improvementPlanIdPut(id, token, opts)

Updating improvement plan

Updating improvement plan

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var id = "id_example"; // String | testing

var token = "token_example"; // String | The authorization token

var opts = { 
  'improvementPlanParam': new RrhetQualityStarApi.ImprovementPlan() // ImprovementPlan | testing body
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.improvementPlanIdPut(id, token, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| testing | 
 **token** | **String**| The authorization token | 
 **improvementPlanParam** | [**ImprovementPlan**](ImprovementPlan.md)| testing body | [optional] 

### Return type

[**ImprovementPlan**](ImprovementPlan.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="improvementPlanPost"></a>
# **improvementPlanPost**
> ImprovementPlan improvementPlanPost(token, opts)

Adding improcement plan

adds new improvement plan

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token

var opts = { 
  'improvementParam': new RrhetQualityStarApi.ImprovementPlan() // ImprovementPlan | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.improvementPlanPost(token, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 
 **improvementParam** | [**ImprovementPlan**](ImprovementPlan.md)|  | [optional] 

### Return type

[**ImprovementPlan**](ImprovementPlan.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="measurePost"></a>
# **measurePost**
> Measure measurePost(token, opts)

Measure

Returns individual quality measure.D

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token

var opts = { 
  'measureParam': new RrhetQualityStarApi.MeasureRequestParam() // MeasureRequestParam | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.measurePost(token, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 
 **measureParam** | [**MeasureRequestParam**](MeasureRequestParam.md)|  | [optional] 

### Return type

[**Measure**](Measure.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="qualityMeasureGet"></a>
# **qualityMeasureGet**
> [QM] qualityMeasureGet(token)

Quality Measure

This endpoint returns all the quality measures used in CMS five star rating.

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.qualityMeasureGet(token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 

### Return type

[**[QM]**](QM.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="qualityMeasureIdGet"></a>
# **qualityMeasureIdGet**
> QM qualityMeasureIdGet(id, token)

Quality Measure

An object of quality measure.

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var id = "id_example"; // String | Quality measure ID

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.qualityMeasureIdGet(id, token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| Quality measure ID | 
 **token** | **String**| The authorization token | 

### Return type

[**QM**](QM.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="quickTipsLocationGet"></a>
# **quickTipsLocationGet**
> [QuickTip] quickTipsLocationGet(location, token)

Returns an array of quick tips

Returns an array of quick tips

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var location = "location_example"; // String | 

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.quickTipsLocationGet(location, token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **location** | **String**|  | 
 **token** | **String**| The authorization token | 

### Return type

[**[QuickTip]**](QuickTip.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="reportPost"></a>
# **reportPost**
> Report reportPost(token, opts)

QM report

Returns a report with all the QMs

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token

var opts = { 
  'reportParam': new RrhetQualityStarApi.ReportRequestParam() // ReportRequestParam | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.reportPost(token, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 
 **reportParam** | [**ReportRequestParam**](ReportRequestParam.md)|  | [optional] 

### Return type

[**Report**](Report.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="uploadMDSGet"></a>
# **uploadMDSGet**
> [MDSHistory] uploadMDSGet(token)

Getting all MDS upload history

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | The authorization token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.uploadMDSGet(token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| The authorization token | 

### Return type

[**[MDSHistory]**](MDSHistory.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="uploadMDSLocationYearQuarterPost"></a>
# **uploadMDSLocationYearQuarterPost**
> uploadMDSLocationYearQuarterPost(location, year, quarter, token, additionalMetadata, opts)

upload MDS zip file

upload MDS zip file

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var location = "location_example"; // String | 

var year = "year_example"; // String | 

var quarter = "quarter_example"; // String | 

var token = "token_example"; // String | The authorization token

var additionalMetadata = "additionalMetadata_example"; // String | additional metadata for MDS upload

var opts = { 
  'file': "/path/to/file.txt" // File | MDS file to upload
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.uploadMDSLocationYearQuarterPost(location, year, quarter, token, additionalMetadata, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **location** | **String**|  | 
 **year** | **String**|  | 
 **quarter** | **String**|  | 
 **token** | **String**| The authorization token | 
 **additionalMetadata** | **String**| additional metadata for MDS upload | 
 **file** | **File**| MDS file to upload | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: multipart/form-data
 - **Accept**: Not defined

<a name="usersGet"></a>
# **usersGet**
> User usersGet(token)

returns users

### Example
```javascript
var RrhetQualityStarApi = require('rrhet_quality_star_api');

var apiInstance = new RrhetQualityStarApi.DefaultApi();

var token = "token_example"; // String | user token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.usersGet(token, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **token** | **String**| user token | 

### Return type

[**User**](User.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

