# iii_dispatch > iiiWeb_API__httpxxx_xxx_xxx_httpxxx_xxx_xxx_p_NET_Core_2_0__brASP__NET_Web_API_brMongoDBMariaDB Latest version **1.0.1** (published 2018-07-23) · Apache 2.0 license · 0 weekly downloads ## Install ```sh npm install iii_dispatch pnpm add iii_dispatch yarn add iii_dispatch bun add iii_dispatch ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2018-07-23 | | First published | 2018-07-23 | | Weekly downloads | 0 | | License | Apache 2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 226 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Maintainers | chuanway | ## Links - npm: https://www.npmjs.com/package/iii_dispatch - npm.io page: https://npm.io/package/iii_dispatch ## Dependencies (1) - [superagent](https://npm.io/package/superagent.md) 3.5.2 ## Recent versions - 1.0.1 (latest) — 2018-07-23 ## README # iii_dispatch IiiDispatch - JavaScript client for iii_dispatch 本文件定義iii派車系統Web API，相關系統規格請參考 [http://xxx.xxx.xxx](http://xxx.xxx.xxx).

預定開發/運行系統：.NET Core 2.0
預定開發技術：ASP .NET Web API
預定使用資料庫：MongoDB/MariaDB This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.1 - Package version: 1.0.1 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your iii_dispatch from, and run: ```shell npm link /path/to/ ``` 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: ```shell npm install YOUR_USERNAME/iii_dispatch --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/DispatchApi.md#createDispatch) | **POST** /dispatch | 新增載客工作單 *IiiDispatch.DispatchApi* | [**deleteDispatch**](docs/DispatchApi.md#deleteDispatch) | **DELETE** /dispatch/{dispatchId} | Deletes a dispatch *IiiDispatch.DispatchApi* | [**findAllDispatches**](docs/DispatchApi.md#findAllDispatches) | **GET** /dispatch | 取得增載客工作單清單 *IiiDispatch.DispatchApi* | [**getDispatchById**](docs/DispatchApi.md#getDispatchById) | **GET** /dispatch/{dispatchId} | 以ID連結載客工作單資料 *IiiDispatch.DispatchingApi* | [**updateDispatchWithArrive**](docs/DispatchingApi.md#updateDispatchWithArrive) | **POST** /dispatching/arrive | 載客工作流程：乘客抵達目的地 *IiiDispatch.DispatchingApi* | [**updateDispatchWithPayment**](docs/DispatchingApi.md#updateDispatchWithPayment) | **POST** /dispatching/payment | 載客工作流程：乘客支付車資 *IiiDispatch.DispatchingApi* | [**updateDispatchWithPick**](docs/DispatchingApi.md#updateDispatchWithPick) | **POST** /dispatching/pick | 載客工作流程：乘客上車 *IiiDispatch.DriverApi* | [**createDriver**](docs/DriverApi.md#createDriver) | **POST** /driver | 新增司機 *IiiDispatch.DriverApi* | [**deleteDriver**](docs/DriverApi.md#deleteDriver) | **DELETE** /driver/{username} | Delete driver *IiiDispatch.DriverApi* | [**getDriverByName**](docs/DriverApi.md#getDriverByName) | **GET** /driver/{username} | Get driver by user name *IiiDispatch.DriverApi* | [**loginDriver**](docs/DriverApi.md#loginDriver) | **POST** /driver/login | Logs driver into the system *IiiDispatch.DriverApi* | [**logoutDriver**](docs/DriverApi.md#logoutDriver) | **GET** /driver/logout | Logs out current logged in driver session *IiiDispatch.DriverApi* | [**updateDriver**](docs/DriverApi.md#updateDriver) | **PUT** /driver/{username} | Updated driver *IiiDispatch.TaxiApi* | [**addTaxi**](docs/TaxiApi.md#addTaxi) | **POST** /taxi | 新增車輛 *IiiDispatch.TaxiApi* | [**deleteTaxi**](docs/TaxiApi.md#deleteTaxi) | **DELETE** /taxi/{taxiId} | Deletes a taxi *IiiDispatch.TaxiApi* | [**findTaxiByStatus**](docs/TaxiApi.md#findTaxiByStatus) | **GET** /taxi/findByStatus | Finds Taxi by status *IiiDispatch.TaxiApi* | [**getTaxiById**](docs/TaxiApi.md#getTaxiById) | **GET** /taxi/{taxiId} | 以ID連結車輛資料 *IiiDispatch.TaxiApi* | [**updateTaxi**](docs/TaxiApi.md#updateTaxi) | **PUT** /taxi | 更新車輛資料 *IiiDispatch.TaxiApi* | [**updateTaxiWithForm**](docs/TaxiApi.md#updateTaxiWithForm) | **POST** /taxi/{taxiId} | 更新ID指定之車輛資料 *IiiDispatch.TaxiRequestApi* | [**createTaxiRequest**](docs/TaxiRequestApi.md#createTaxiRequest) | **POST** /taxi_request | 新增叫車 *IiiDispatch.TaxiRequestApi* | [**deleteTaxiRequest**](docs/TaxiRequestApi.md#deleteTaxiRequest) | **DELETE** /taxi_request/{taxi_requestId} | Deletes a taxi_request *IiiDispatch.TaxiRequestApi* | [**findAllTaxiRequests**](docs/TaxiRequestApi.md#findAllTaxiRequests) | **GET** /taxi_request | 取得叫車服務清單 *IiiDispatch.TaxiRequestApi* | [**getTaxiRequestById**](docs/TaxiRequestApi.md#getTaxiRequestById) | **GET** /taxi_request/{taxi_requestId} | 以ID連結叫車資料 *IiiDispatch.TaxiRequestApi* | [**updateTaxiRequestWithForm**](docs/TaxiRequestApi.md#updateTaxiRequestWithForm) | **POST** /taxi_request/{taxi_requestId} | 更新ID指定之叫車資料 *IiiDispatch.UserApi* | [**createUser**](docs/UserApi.md#createUser) | **POST** /user | 新增乘客 *IiiDispatch.UserApi* | [**createUsersWithListInput**](docs/UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array *IiiDispatch.UserApi* | [**deleteUser**](docs/UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user *IiiDispatch.UserApi* | [**getUserByName**](docs/UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name *IiiDispatch.UserApi* | [**getUserPassword**](docs/UserApi.md#getUserPassword) | **POST** /user/register_get_password | Forget password *IiiDispatch.UserApi* | [**loginUser**](docs/UserApi.md#loginUser) | **POST** /user/login | Logs user into the system *IiiDispatch.UserApi* | [**logoutUser**](docs/UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session *IiiDispatch.UserApi* | [**registerEmail**](docs/UserApi.md#registerEmail) | **POST** /user/register_email | Registering email *IiiDispatch.UserApi* | [**registerPassword**](docs/UserApi.md#registerPassword) | **POST** /user/register_password | Registering password *IiiDispatch.UserApi* | [**registerUser**](docs/UserApi.md#registerUser) | **POST** /user/register | Register user into the system *IiiDispatch.UserApi* | [**registerUsername**](docs/UserApi.md#registerUsername) | **POST** /user/register_username | Registering username *IiiDispatch.UserApi* | [**registerVerify**](docs/UserApi.md#registerVerify) | **POST** /user/register_verify | Verify using pushed validation code *IiiDispatch.UserApi* | [**updateUser**](docs/UserApi.md#updateUser) | **PUT** /user/{username} | Updated user ## Documentation for Models - [IiiDispatch.Dispatch](docs/Dispatch.md) - [IiiDispatch.Driver](docs/Driver.md) - [IiiDispatch.Taxi](docs/Taxi.md) - [IiiDispatch.TaxiRequest](docs/TaxiRequest.md) - [IiiDispatch.User](docs/User.md) - [IiiDispatch.VehicleType](docs/VehicleType.md) ## 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 --- _Source: https://npm.io/package/iii_dispatch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._