iii_dispatch

IiiDispatch - JavaScript client for iii_dispatch 本文件定義iii派車系統Web API，相關系統規格請參考 http://xxx.xxx.xxx.預定開發/運行系統：.NET Core 2.0 預定開發技術：ASP .NET Web API 預定使用資料庫：MongoDB/MariaDB This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.1
• Package version: 1.0.1
• 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 iii_dispatch --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 iii_dispatch from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

    npm install YOUR_USERNAME/iii_dispatch --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 IiiDispatch = require('iii_dispatch');

var api = new IiiDispatch.DispatchApi()

var body = new IiiDispatch.Dispatch(); // {Dispatch} Created dispatch object


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createDispatch(body, callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- IiiDispatch.DispatchApi | createDispatch | POST /dispatch | 新增載客工作單 IiiDispatch.DispatchApi | deleteDispatch | DELETE /dispatch/{dispatchId} | Deletes a dispatch IiiDispatch.DispatchApi | findAllDispatches | GET /dispatch | 取得增載客工作單清單 IiiDispatch.DispatchApi | getDispatchById | GET /dispatch/{dispatchId} | 以ID連結載客工作單資料 IiiDispatch.DispatchingApi | updateDispatchWithArrive | POST /dispatching/arrive | 載客工作流程：乘客抵達目的地 IiiDispatch.DispatchingApi | updateDispatchWithPayment | POST /dispatching/payment | 載客工作流程：乘客支付車資 IiiDispatch.DispatchingApi | updateDispatchWithPick | POST /dispatching/pick | 載客工作流程：乘客上車 IiiDispatch.DriverApi | createDriver | POST /driver | 新增司機 IiiDispatch.DriverApi | deleteDriver | DELETE /driver/{username} | Delete driver IiiDispatch.DriverApi | getDriverByName | GET /driver/{username} | Get driver by user name IiiDispatch.DriverApi | loginDriver | POST /driver/login | Logs driver into the system IiiDispatch.DriverApi | logoutDriver | GET /driver/logout | Logs out current logged in driver session IiiDispatch.DriverApi | updateDriver | PUT /driver/{username} | Updated driver IiiDispatch.TaxiApi | addTaxi | POST /taxi | 新增車輛 IiiDispatch.TaxiApi | deleteTaxi | DELETE /taxi/{taxiId} | Deletes a taxi IiiDispatch.TaxiApi | findTaxiByStatus | GET /taxi/findByStatus | Finds Taxi by status IiiDispatch.TaxiApi | getTaxiById | GET /taxi/{taxiId} | 以ID連結車輛資料 IiiDispatch.TaxiApi | updateTaxi | PUT /taxi | 更新車輛資料 IiiDispatch.TaxiApi | updateTaxiWithForm | POST /taxi/{taxiId} | 更新ID指定之車輛資料 IiiDispatch.TaxiRequestApi | createTaxiRequest | POST /taxi_request | 新增叫車 IiiDispatch.TaxiRequestApi | deleteTaxiRequest | DELETE /taxi_request/{taxi_requestId} | Deletes a taxi_request IiiDispatch.TaxiRequestApi | findAllTaxiRequests | GET /taxi_request | 取得叫車服務清單 IiiDispatch.TaxiRequestApi | getTaxiRequestById | GET /taxi_request/{taxi_requestId} | 以ID連結叫車資料 IiiDispatch.TaxiRequestApi | updateTaxiRequestWithForm | POST /taxi_request/{taxi_requestId} | 更新ID指定之叫車資料 IiiDispatch.UserApi | createUser | POST /user | 新增乘客 IiiDispatch.UserApi | createUsersWithListInput | POST /user/createWithList | Creates list of users with given input array IiiDispatch.UserApi | deleteUser | DELETE /user/{username} | Delete user IiiDispatch.UserApi | getUserByName | GET /user/{username} | Get user by user name IiiDispatch.UserApi | getUserPassword | POST /user/register_get_password | Forget password IiiDispatch.UserApi | loginUser | POST /user/login | Logs user into the system IiiDispatch.UserApi | logoutUser | GET /user/logout | Logs out current logged in user session IiiDispatch.UserApi | registerEmail | POST /user/register_email | Registering email IiiDispatch.UserApi | registerPassword | POST /user/register_password | Registering password IiiDispatch.UserApi | registerUser | POST /user/register | Register user into the system IiiDispatch.UserApi | registerUsername | POST /user/register_username | Registering username IiiDispatch.UserApi | registerVerify | POST /user/register_verify | Verify using pushed validation code IiiDispatch.UserApi | updateUser | PUT /user/{username} | Updated user

Documentation for Models

• IiiDispatch.Dispatch
• IiiDispatch.Driver
• IiiDispatch.Taxi
• IiiDispatch.TaxiRequest
• IiiDispatch.User
• IiiDispatch.VehicleType

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

iii_dispatch_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/oauth/dialog
• Scopes:
  • write:taxis: modify taxis in your account
  • read:taxis: read your taxis