# IiiDispatch.DispatchApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**createDispatch**](DispatchApi.md#createDispatch) | **POST** /dispatch | 新增載客工作單
[**deleteDispatch**](DispatchApi.md#deleteDispatch) | **DELETE** /dispatch/{dispatchId} | Deletes a dispatch
[**findAllDispatches**](DispatchApi.md#findAllDispatches) | **GET** /dispatch | 取得增載客工作單清單
[**getDispatchById**](DispatchApi.md#getDispatchById) | **GET** /dispatch/{dispatchId} | 以ID連結載客工作單資料


<a name="createDispatch"></a>
# **createDispatch**
> createDispatch(body)

新增載客工作單

This can only be done by the logged in user.

### Example
```javascript
var IiiDispatch = require('iii_dispatch');

var apiInstance = 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.');
  }
};
apiInstance.createDispatch(body, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**Dispatch**](Dispatch.md)| Created dispatch object | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="deleteDispatch"></a>
# **deleteDispatch**
> deleteDispatch(dispatchId, opts)

Deletes a dispatch



### Example
```javascript
var IiiDispatch = require('iii_dispatch');
var defaultClient = IiiDispatch.ApiClient.instance;

// Configure OAuth2 access token for authorization: iii_dispatch_auth
var iii_dispatch_auth = defaultClient.authentications['iii_dispatch_auth'];
iii_dispatch_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new IiiDispatch.DispatchApi();

var dispatchId = 789; // Number | Dispatch id to delete

var opts = { 
  'apiKey': "apiKey_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteDispatch(dispatchId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dispatchId** | **Number**| Dispatch id to delete | 
 **apiKey** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

[iii_dispatch_auth](../README.md#iii_dispatch_auth)

### HTTP request headers

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

<a name="findAllDispatches"></a>
# **findAllDispatches**
> [Dispatch] findAllDispatches()

取得增載客工作單清單

### Example
```javascript
var IiiDispatch = require('iii_dispatch');
var defaultClient = IiiDispatch.ApiClient.instance;

// Configure OAuth2 access token for authorization: iii_dispatch_auth
var iii_dispatch_auth = defaultClient.authentications['iii_dispatch_auth'];
iii_dispatch_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new IiiDispatch.DispatchApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**[Dispatch]**](Dispatch.md)

### Authorization

[iii_dispatch_auth](../README.md#iii_dispatch_auth)

### HTTP request headers

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

<a name="getDispatchById"></a>
# **getDispatchById**
> Dispatch getDispatchById(dispatchId)

以ID連結載客工作單資料

回傳單筆載客工作單資料

### Example
```javascript
var IiiDispatch = require('iii_dispatch');
var defaultClient = IiiDispatch.ApiClient.instance;

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

var apiInstance = new IiiDispatch.DispatchApi();

var dispatchId = 789; // Number | ID of dispatch to return


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dispatchId** | **Number**| ID of dispatch to return | 

### Return type

[**Dispatch**](Dispatch.md)

### Authorization

[api_key](../README.md#api_key)

### HTTP request headers

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