Skip to content

QwicBikeApi.md

Latest commit

 

History

History
176 lines (115 loc) · 5.12 KB

QwicBikeApi.md

File metadata and controls

176 lines (115 loc) · 5.12 KB

Api.QwicBikeApi

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

Method HTTP request Description
compareQwicBike POST /{version}/bike/compare
createQwicBike POST /{version}/bike/qwic
getQwicBikeModel GET /{version}/bike_model/qwic/{vin}

compareQwicBike

CompareQwicBikeResponse compareQwicBike(version, body)

Compare a QWIC bike, it will check whether the bike's MID meets the usage regulations. - `spec_id`: spec of bike. if didn't have spec_id, could be null. - `parts`: bike equipped part specs. only allow parts produced by Hyena or Brose. - There are 5 types: - Type 1: No changed any part specs - Type 2: New bike or change all part specs - Type 3: Have changes part specs - Type 4: Different bike of components - Type 5: Wrong part number

Example

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

var apiInstance = new Api.QwicBikeApi();
var version = "version_example"; // String | api version
var body = new Api.CompareBikeRequest(); // CompareBikeRequest | compare qwic bike body parameters
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.compareQwicBike(version, body, callback);

Parameters

Name Type Description Notes
version String api version
body CompareBikeRequest compare qwic bike body parameters

Return type

CompareQwicBikeResponse

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: /, application/json

createQwicBike

CreateBikeResponse createQwicBike(version, body)

Create a QWIC bike. - `vin`: frame number of bike. - `spec_id`: spec of bike. if didn't have spec_id, could be null. - `parts`: bike equipped part specs. only allow parts produced by Hyena or Brose.

Example

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

var apiInstance = new Api.QwicBikeApi();
var version = "version_example"; // String | api version
var body = new Api.CreateBikeRequest(); // CreateBikeRequest | create qwic bike body parameters
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createQwicBike(version, body, callback);

Parameters

Name Type Description Notes
version String api version
body CreateBikeRequest create qwic bike body parameters

Return type

CreateBikeResponse

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: /, application/json

getQwicBikeModel

QwicBikeModelResponse getQwicBikeModel(version, vin)

Get a QWIC's bike model from QWIC API

Example

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

var apiInstance = new Api.QwicBikeApi();
var version = "version_example"; // String | api version
var vin = "vin_example"; // String | frame number
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getQwicBikeModel(version, vin, callback);

Parameters

Name Type Description Notes
version String api version
vin String frame number

Return type

QwicBikeModelResponse

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: /, application/json