0.9.0 • Published 8 years ago

hackathon_web_api v0.9.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
8 years ago

hackathon_web_api

HackathonWebApi - JavaScript client for hackathon_web_api Hackathonの Web API 仕様書 This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.9
  • Package version: 0.9
  • Build date: 2016-09-22T07:09:45.989Z
  • Build package: class 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 hackathon_web_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/hackathon_web_api then install it via:

    npm install YOUR_USERNAME/hackathon_web_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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var HackathonWebApi = require('hackathon_web_api');

var api = new HackathonWebApi.DefaultApi()

var objectId = "objectId_example"; // {String} オブジェクトID

var objectValue = new HackathonWebApi.UserObjectValue(); // {UserObjectValue} ObjectRegisteredData


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

Documentation for API Endpoints

All URIs are relative to https://bcd-web.net/

ClassMethodHTTP requestDescription
HackathonWebApi.DefaultApiaddObjectValueUsingPOSTPOST /api/v1/user/objects/{objectId}オブジェクトの登録
HackathonWebApi.DefaultApicreateAssetsUsingPOSTPOST /api/v1/user/assetsアセット作成
HackathonWebApi.DefaultApicreateNewAccountUsingPOSTPOST /api/v1/user/useraddユーザーの作成
HackathonWebApi.DefaultApifindAssetsUsingGETGET /api/v1/user/assets/findアセット検索
HackathonWebApi.DefaultApifindCountObjectValuesUsingGETGET /api/v1/user/objects/{objectId}/findCountオブジェクトの登録データの検索結果件数
HackathonWebApi.DefaultApifindObjectValuesUsingGETGET /api/v1/user/objects/{objectId}/findオブジェクトの登録データの検索
HackathonWebApi.DefaultApigetObjectCountUsingGETGET /api/v1/user/objects/{objectId}/countオブジェクトの登録件数の参照
HackathonWebApi.DefaultApigetObjectValueUsingGETGET /api/v1/user/objects/{objectId}/{index}オブジェクトの参照
HackathonWebApi.DefaultApigetObjectValuesUsingGETGET /api/v1/user/objects/{objectId}オブジェクトの登録データの参照
HackathonWebApi.DefaultApiqueryAssetsBalanceUsingGETGET /api/v1/user/assets/{assetsName}アセットの残高照会
HackathonWebApi.DefaultApiqueryAssetsTradingHistoryUsingGETGET /api/v1/user/assets/{assetsName}/tradingHistoryアセットの取引履歴参照
HackathonWebApi.DefaultApisendAssetsUsingPOSTPOST /api/v1/user/assets/{assetsName}/sendアセットの送信

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.