apiary.apib

FORMAT: 1A
HOST:https://et.udc-service.io:5000

# Energy Trading (ET) API Document

ET's back-end API<p>
API-version: 0.1

# Group Restful

## Login [/login]

Used to login platform.

### Login [POST]
<pre>
curl https://et.udc-service.io:5000/login -X POST -H "Content-Type: application/json" -d '{"account": "TestA1", "password": "TestA1"}'
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1

    + Attributes
        + account: `TestA1` - Login Account
        + password: `TestA1` - Account's Password

+ Response 200 (application/json)
    + Attributes
        + id: `03f87a5a-a4e6-4536-ba6c-265c03ebd317` - User's UUID
        + bearer: `OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR` - Authentication Bearer Token

+ Response 401 (application/json)
    + Attributes
        + error: `Unauthorized access` - Authentication failed

## User [/user]

User's information.

### User Info [GET]
<pre>
curl https://et.udc-service.io:5000/user -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes
        + account: `TestA1_BEMS`
        + username: `TestA1`
        + avatar: `https://imgur.com/0JMAdHM` - Profile Picture's URL
        + balance: `100` (number) - User's Token balance
        + address: `台南市大學路一號` - User's Building Address
        + eth_address: `0xB346ef4EEFc02FdAa7b4756Db4F30E0cdA9704Ae` - User's ETH Address
        + is_aggregator: `true` - User's aggregator authority

### Change Password [PUT]
<pre>
curl https://et.udc-service.io:5000/user -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR" -d '{"original_passwd": "TestA1","new_passwd": "new_password"}'
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

    + Attributes
        + original_passwd: `User1pwd` - User input original password
        + new_passwd: `User1new` - User input new password

+ Response 200 (application/json)
    + Attributes
        + message: Accept.


+ Response 400 (application/json)
    + Attributes
        + message: Fail. - Error Message

### Create User [POST]
<pre>
curl https://et.udc-service.io:5000/user -X POST -H "Content-Type: application/json"
  -d '{
        "account": "TestA1",
        "username": "TestA1_BEMS",
        "password": "test"
}'
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1

    + Attributes
        + account: `TestA1` - Account name, ID
        + username: `TestA1` - Account username
        + password: `test` - Account password

+ Response 200 (application/json)
    + Attributes
        + message: Account created


+ Response 400 (application/json)
    + Attributes
        + message: `{error-message}` - Error Message

## AMI [/amis]

Get User's AMIs.

### AMIs [GET]
<pre>
curl https://et.udc-service.io:5000/amis -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (object)
            + id: `a6d2a4cd-fc78-4636-9c42-c0006976244b` - UUID
            + name: `智駕車BEMS`
            + description: `智駕車總表AMI` - AMI 名稱

## News [/news]

Get latest ten system news.

### News [GET]
<pre>
curl https://et.udc-service.io:5000/news -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (object)
            + id: `5f3276c2-ec53-4dd3-ada3-081ca3f9d4f9` - The news' UUID
            + time: `2019/08/25 10:00` - The Message Upload Date
            + content: `Website Upload to Version 0.2` - The Message Content

## Bid Status [/bidstatus]

Related to bidding page info.

### Bidding Status [GET /bidstatus]
<pre>
curl https://et.udc-service.io:5000/bidstatus -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc"
</pre>

Return the average bidding price and active participants in the active hour.

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes
        + average_price: `7.3` (number) - 在下一個有效的執行時段，參與者的平均競標單價
        + average_volume: `15` (number) - 在下一個有效的執行時段，參與者的平均競標電量
        + participants: `2` (number) - 在下一個有效的執行時段，投標的參與者數目

## Bid Submit [/bidsubmit]

Related to bidding.

### Bidding Project [GET /bidsubmit{?per_page}{?page}{?bid_type}]
<pre>
curl https://et.udc-service.io:5000/bidsubmit?per_page=10&page=5&bid_type=buy -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc"
</pre>

Return the bid content valid from the day (Today, current time).

+ Parameters
    + per_page: `10` (number) - 一頁的標案數量.
    + page: `5` (number) - 頁面數.
    + bid_type: `buy` (string) - 取得買或賣的標案資料

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes
        + data (array) - 頁面所顯示的標案資訊
            + (BidSubmit) - 第一筆資料
            + (BidSubmit) - 第二筆資料
                + bid_type: `sell` (string) - 投標類型
        + page: `1` (number) - 所在頁數
        + totalCount: `20` (number) - 在當時間總共有效的標案

### Order [POST]
<pre>
curl https://et.udc-service.io:5000/bidsubmit -X POST -H 'Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc' -H 'Content-Type: application/json' \
  -d '{
    "bid_type": "buy",
    "start_time": "2019/10/29 18",
    "end_time": "2019/10/29 19",
    "value": 10,
    "price": 6.8
}'
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

    + Attributes
        + bid_type: `buy` - Bidding type: sell or buy
        + start_time: `2019/09/01 13` - Bidding Datetime Start
        + end_time: `2019/09/01 14` - Bidding Datetime End
        + value: `10` (number) - kWh
        + price: `4.3` (number) - NT Dollars

+ Response 200 (application/json)
    + Attributes
        + message: Accept

+ Response 400 (application/json)
    + Attributes
        + message: Reject

### Edit [PUT]
<pre>
curl https://et.udc-service.io:5000/bidsubmit -X PUT -H 'Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc' -H 'Content-Type: application/json' \
  -d '{
    "id": "2048b3c9-0125-41fc-bef6-9b1e52bd825f",
    "bid_type": buy,
    "start_time": "2019/10/29 18",
    "end_time": "2019/10/29 19",
    "value": 10,
    "price": 6.8
}'
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

    + Attributes
        + id: `104fa450-c688-4f7f-8cca-fae7a18f2eb8` - Item's UUID
        + bid_type: `buy` - Bidding type: sell or buy
        + start_time: `2019/09/01 13` - Bidding Datetime Start
        + end_time: `2019/09/01 14` - Bidding Datetime End
        + value: `10` (number) - kWh
        + price: `4.3` (number) - NT Dollars

+ Response 200 (application/json)
    + Attributes
        + message: Accept

+ Response 400 (application/json)
    + Attributes
        + message: Reject

### Remove [DELETE]
<pre>
curl https://et.udc-service.io:5000/bidsubmit -X DELETE -H 'Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc' -H 'Content-Type: application/json' -d '{"id": "104fa450-c688-4f7f-8cca-fae7a18f2eb8"}'
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

    + Attributes
        + id: `104fa450-c688-4f7f-8cca-fae7a18f2eb8` - Remove item's UUID

+ Response 200 (application/json)
    + Attributes
        + message: Accept

+ Response 400 (application/json)
    + Attributes
        + message: Reject
        + description: The bid has been closed - Error message


## Home Page [/homepage]

Return information for home page.

### Home Page [GET]
<pre>
curl https://et.udc-service.io:5000/homepage -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc"
</pre>

Return detail information sets for home page which includes current execution info and 10 most recent succuessful bid results (if any).

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes
        + buy - 首頁即時買電交易資訊 (當時段執行買電的資料,若沒有買電,以下皆 null)
            + price: 4.0 (number) - 交易價錢
            + volume: 40 (number) - 交易電量
        + sell - 首頁即時賣電交易資訊 (當時段賣電的資料,若沒有賣電,以下皆 null)
            + price: 4.0 (number) - 交易價錢
            + volume: 40 (number) - 交易電量
        + results (array) - 最近十筆得標成功的資料 (if any)
            + (HomepageBid) - 第一筆資料
            + (HomepageBid) - 第二筆資料
                + time: `13:00-14:00`

## Match Result [/matchresult]

Return match results.

### Match Result [GET]
<pre>
curl https://et.udc-service.io:5000/matchresult -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc"
</pre>

Return details information sets of the user's bids.

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (BID)


## Schematic Diagram [/participant]

Return participants in the transaction to paint schematic diagram.

### Participants [GET]
<pre>
curl https://et.udc-service.io:5000/participant -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (object)
            + id: `7e54877b-3743-4d20-bbfc-5b4deb131116` - User's UUID
            + name: `BEMS1`

## Power Info [/power_info]

Return Electricity History Usage.

### PowerData (Data Table Mode) [GET /power_info{?per_page}{?page}{?time}]
<pre>
curl https://et.udc-service.io:5000/power_info?per_page=10&page=1&time=2020/02/14 -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

+ Parameters
    + per_page: `10` (number, required) - Power data per page.
    + page: `1` (number, required) - Power data at page.
    + time: `2020/02/14` (string, optional) - Date for the data, default is now, format YYYY/MM/DD.

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes
        + data (array) - 頁面所顯示的電力資訊
            + (PowerEntry) - 第一筆資料
            + (PowerEntry) - 第二筆資料
                + time: `23:51`
                + id: `049a9c28-c0cc-418e-9f35-23f6bc43df7e`
        + page: `1` (number) - 所在頁數
        + totalCount: `785` (number) - Query 時間內資料總數

### PowerData (Data Chart Mode) [GET /power_info{?chart_date}]
<pre>
curl https://et.udc-service.io:5000/power_info?chart_date=2020/01/13 -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

Return past 7 days power information.

+ Parameters
    + chart_date: `2020/02/14` (string, required) - Date for the data, format YYYY/MM/DD.

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (ChartData)
            + Date: `2020/02/08`
        + (ChartData)
            + Date: `2020/02/09`
        + (ChartData)
            + Date: `2020/02/10`
        + (ChartData)
            + Date: `2020/02/11`
        + (ChartData)
            + Date: `2020/02/12`
        + (ChartData)
            + Date: `2020/02/13`
        + (ChartData)
            + Date: `2020/02/14`

### PowerData (Date Summary Mode) [GET /power_info{?summary_date}]
<pre>
curl https://et.udc-service.io:5000/power_info?summary_date=2020/02/14 -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

+ Parameters
    + summary_date: `2020/02/14` (string, required) - Date for the data, format YYYY/MM/DD.

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

+ Response 200 (application/json)
    + Attributes
        + Consume: `48.19` (number) - 正常用電
        + Demand: `47.208` (number) - 總淨負載
        + ESS: `0.219` (number) - 儲電系統
        + EV: `2.017` (number) - 充電樁
        + PV: `-3.501` (number) - 太陽能
        + WT: `0.283` (number) - 風能

# Group Web Socket
## Association Diagram [/s1]

Return transaction status.

### Association [OPTIONS /socket/association]
<pre>
NOT YET !!!!!!
</pre>

+ Request (application/json)
    + Headers

            API-version: 0.1
            Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR - Authentication Bearer Token

    + Attributes
        + event: association - Socket Event Name

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (object)
            + seller: `e900b7b0-c097-4ce8-9426-7399d6412b26` - Seller's UUID
            + buyer: `9eef88ba-abf3-4cdc-a2cc-c63e331c4c47` - Buyer's UUID
            + value: `10` (number) - win value
            + achievement: `4` (number)

## Data Structures
### BID (object)
+ id: `b345273d-ffc9-4916-bf7e-5615f0ee8a39` - Message's UUID
+ date: `2019/09/01` - Trade Target Date
+ time: `13:00-14:00` - Trade Period
+ bid_type: `sell` - sell or buy
+ bids
    + price: `5.0` (number) - Bidding Price
    + value: `20.0` (number) - Bidding Value
+ status: `已結算` - Bidding Status
+ transaction_hash: `0xdb13d6c572a482f2a9578bfb3cc41a2f0e349852138e788db795ee51ce40b439` - Transaction Hash
+ counterpart
    + name: 沙崙綠能科學城C區BEMS
    + address: 台南市歸仁區高發二路360號C區
+ win: `1` (number) - Deal or No Deal
+ wins
    + value: `10` (number) - Winning Value
    + price: `50` (number) - Winning Total Price
+ upload: `Thu, 12 Mar 2020 14:15:00 GMT` - Upload Time
+ achievement: `100%` - 0~100%
+ settlement: `50` (number) - Settlement Transaction Price

### BidSubmit
+ bid_type: `buy` (string) - 投標類型
+ date: `2020/10/29` (string) - 目標執行日期 YYYY/MM/DD
+ end_time: `2020/10/29 19` (string) - 執行結束時間
+ id: `049a9c28-c0cc-418e-9f35-23f6bc43df7e` - 投標 UUID
+ price: `6.8` (number) - 投標單價
+ start_time: `2020/10/29 18` (string) - 執行開始時間
+ time: `18` (number) - 執行時間
+ total_price: `68.0` (number) - 總交易價格
+ upload_time: `Sat, 21 Mar 2020 14:28:59 GMT` (string) - 投標上傳時間
+ volume: `10` (number) - 投標電量

### ESS
+ table: `ess`
+ id: `486fbca4-9bc1-42bd-af93-92ceb77d89ec` - Data's UUID
+ field: `NCKU` (string) - 場域
+ cluster: `1` (number) - ESS編號
+ power_display: `-0.035` (number) - 讀取實功輸出(kW)
+ updated_at: `2019-09-04T12:00:00` - 資料上傳時間

### EV
+ table: `ev`
+ id: `c363a32e-3dbe-42c5-bfe2-398436192c6f` - Data's UUID
+ field: `NCKU` (string) - 場域
+ cluster: `1` (number) - 充電柱編號
+ power_display: `0.000` (number) - 充電功率(kW)
+ updated_at: `2019-09-04T12:00:00` - 資料上傳時間

### PV
+ table: `pv`
+ id: `e257ccca-409a-4297-a6c2-c6d91b6dd334` - Data's UUID
+ field: NCKU (string) - 場域
+ cluster: `1` (number) - 太陽能編號
+ PAC: 0.000 (number) - 市電功率
+ updated_at: `2019-09-04T12:00:00` - 資料上傳時間

### WT
+ table: `wt`
+ id: `c15107ab-afed-4d9c-a123-ca6d0626d868` - Data's UUID
+ field: `NCKU` (string) - 場域
+ cluster: `1` (number) - 風機編號
+ WindGridPower: `0.000` (number) - 風機功率
+ updated_at: `2019-09-04T12:00:00` - 資料上傳時間

### PowerEntry
+ address: `https://thetangle.org/transaction/WGQEE9ZNHHNPZ9AILVK9NAUXTRQZWJVEMIXWPBMWFQZTRXLIURDKLVUKACJAQIJOCKDWAZTLTLZY99999` - IOTA address
+ data_type: `ESS` - 產能設備
+ date: `2020/02/14` - 日期
+ id: `049a9c28-c0cc-418e-9f35-23f6bc43df7e` - PowerData UUID
+ power_display: `4.771` (number) - 電力資訊
+ time: `23:50` - 時間

### ChartData
+ Consume: `47.823` (number) - 用電
+ Date: `2020/01/07` - 日期
+ Demand: `49.044` (number) - 淨負載
+ ESS: `2.245` (number) - 儲能裝置
+ EV: `-0.499` (number) - 充電樁
+ Generate: `1.221` (number) - 產電
+ PV: `0.053` (number) - 太陽能
+ WT: `-0.578` (number) - 風能

# Group DR

## Demand Response Bids [/DR_bid]

Demand response operation API for both Aggregator (CEMS) and BEMS.

### GET DR BIDS [GET /DR_bid{?date}]
<pre>
curl https://et.udc-service.io:5000/DR_bid?date=2020-01-01 -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

For BEMS, they can only get bids submitted by themselves.

* Parameters: date
* Description: getting bids that event times are from start_time to end_time

For Aggregator (CEMS) , they can get bids from bems which under its supervision.

* Parameters: date
* Description: getting bids that event times are from start_time to end_time

Note:
* Aggregator can get bids from all its executors. (Maybe more than 1 executors at a time)

+ Parameters
    + date: `2020-01-01` (required, string) - query date (YYYY-MM-DD)

+ Request

    + Headers

            API-version: 0.1
            Authorization: `Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (BEMSBID)
            + uuid: `36d87673-0daf-4ce2-917e-ec6d655d3c0a` (string) - bid uuid
            + executor: `NCKU` (string) - Name of BEMS
            + start_time: `2020-11-11 11:00:00` (string) - DR start time
            + end_time: `2020-11-11 12:00:00` (string) - DR end time
            + volume: 40 (number) - bidding capacity
            + price: 8 (number) - bidding price
        + (BEMSBID)
            + uuid: `515ae958-187a-4503-815f-379d728390b1` (string) - bid uuid
            + executor: `NCKU` (string) - Name of BEMS
            + start_time: `2020-11-11 12:00:00` (string) - DR start time
            + end_time: `2020-11-11 13:00:00` (string) - DR end time
            + volume: 50 (number) - bidding capacity
            + price: 6 (number) - bidding price
        + (BEMSBID)
            + uuid: `ca45ecc1-13a1-4a93-b047-857be806b764` (string) - bid uuid
            + executor: `Carlab_BEMS` (string) - Name of BEMS
            + start_time: `2020-11-11 11:00:00` (string) - DR start time
            + end_time: `2020-11-11 12:00:00` (string) - DR end time
            + volume: 30 (number) - bidding capacity
            + price: 8 (number) - bidding price

+ Response 400 (text/plain)
     + body

            error


### POST DR BID [POST /DR_bid]

For BEMS: This route is to post DR request to Aggregator

For Aggregator: This route is to accept and confirm bems' submitted bids, so aggregator should provide
uuids on those bids he/she wants to accept.

+ Request BEMS (application/json)

    BEMS Add DR

    <pre>
    curl https://et.udc-service.io:5000/DR_bid -X POST -H 'Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc' -H 'Content-Type: application/json' \
    -d '{
        "value": 50,
        "price": 8
    }'
    </pre>

    + Headers

            API-version: 0.1
            Authorization: `Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR`

    + Attributes
        + volume: 50 (number) - bidding capacity
        + price: 8 (number) - bidding price


+ Request Aggregator (application/json)

    Aggregator Accept DR

    <pre>
    curl https://et.udc-service.io:5000/DR_bid -X POST -H 'Authorization: Bearer 3MaTIcta709SxWZ88OkaLjKvNzgfFkxqr8WemUjeOKLZcImscV6WcziuFyfrbXjc' -H 'Content-Type: application/json' \
    -d '{
        "start_time": "2020-11-11 11:00:00",
        "end_time": "2020-11-11 12:00:00",
        "uuid": [
            "36d87673-0daf-4ce2-917e-ec6d655d3c0a",
            "ca45ecc1-13a1-4a93-b047-857be806b764"
        ]
    }'
    </pre>

    + Headers

            API-version: 0.1
            Authorization: `Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR`

    + Attributes
        + start_time: `2020-11-11 11:00:00` (string) - DR start time
        + end_time: `2020-11-11 12:00:00` (string) - DR end time
        + uuid (array, fixed-type)
            - `36d87673-0daf-4ce2-917e-ec6d655d3c0a` (string)
            - `ca45ecc1-13a1-4a93-b047-857be806b764` (string)

+ Response 200 (text/plain)
    + body

            ok

+ Response 400 (text/plain)
    + body

            error


## Demand Response Result [/DR_result]

Demand response operation API for both Aggregator (CEMS) and BEMS.

### BEMS DR RESULTS BY DATE [GET /DR_result{?start_date}{?end_date}]
<pre>
curl https://et.udc-service.io:5000/DR_result?start_date=2020-01-01&end_date=2020-01-02 -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

For BEMS: They can only see their own DR bid result.

For Aggregator: He/she can query all bid result for bems under his/her management (its executors).

+ Parameters
    + start_date: `2020-01-01` (required, string) - query start time (YYYY-MM-DD)
    + end_date: `2020-01-02` (required, string) - query end time (YYYY-MM-DD)

+ Request BEMS DR RESULTS
    + Headers

            API-version: 0.1
            Authorization: `Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR

    + Parameters
        + start_date: `2020-01-01` (required, string) - query start time (YYYY-MM-DD)
        + end_date: `2020-01-02` (required, string) - query end time (YYYY-MM-DD)

+ Response 200 (application/json)

    200 OK (BEMS DR RESULTS)

    + Attributes (array, fixed-type)
        + (BIDRESULT)
            + uuid: `36d87673-0daf-4ce2-917e-ec6d655d3c0a` (string) - uuid
            + executor: `NCKU` (string) - BEMS name
            + acceptor: `Carlab_BEMS` (string) - CEMS name
            + start_time: `2020-11-11 11:00:00` (string) - DR start time
            + end_time: `2020-11-11 12:00:00` (string) - DR end time
            + volume: 40 (number) - bidding capacity
            + price: 8 (number) - bidding price
            + result: true (boolean) - bool
            + rate: 0.11 (number) - 達成率
            + blockchain_url: `https://ropsten.etherscan.io/tx/0xc94ec346cea143d8aab07e3a23a9f24031a9a9ae5b9717d99cf32ac0f57a920d` (string) - url
        + (BIDRESULT)
            + uuid: `515ae958-187a-4503-815f-379d728390b1` (string) - uuid
            + executor: `NCKU` (string) - BEMS name
            + acceptor: `Carlab_BEMS` (string) - CEMS name
            + start_time: `2020-11-11 12:00:00` (string) - DR start time
            + end_time: `2020-11-11 13:00:00` (string) - DR end time
            + volume: 50 (number) - bidding capacity
            + price: 6 (number) - bidding price
            + result: false (boolean) - bool
            + rate: 0 (number) - 達成率
            + blockchain_url: `https://ropsten.etherscan.io/tx/0x07178bc6d022a826d7f85b64f00b77bf878d04519cfbdc6e33aacd802b191435` (string) - url

+ Request Aggregator DR RESULTS
    + Headers

            API-version: 0.1
            Authorization: `Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR

    + Parameters
        + Parameters
        + start_time: `2020-01-01 11:00` (required, string) - query start time (YYYY-MM-DD HH:mm)
        + end_time: `2020-01-01 12:00` (required, string) - query end time (YYYY-MM-DD HH:mm)

+ Response 200 (application/json)

    200 OK (Aggregator DR RESULTS)

    + Attributes (array, fixed-type)
        + (BIDRESULT)
            + uuid: `36d87673-0daf-4ce2-917e-ec6d655d3c0a` (string) - bid uuid
            + executor: `NCKU` (string) - Name of BEMS
            + start_time: `2020-11-11 11:00:00` (string) - DR start time
            + end_time: `2020-11-11 12:00:00` (string) - DR end time
            + volume: 40 (number) - bidding capacity
            + price: 8 (number) - bidding price
            + result: true (boolean) - bool
            + rate: 0.11 (number) - 達成率
            + blockchain_url: `https://ropsten.etherscan.io/tx/0xc94ec346cea143d8aab07e3a23a9f24031a9a9ae5b9717d99cf32ac0f57a920d` (string) - url
        + (BIDRESULT)
            + uuid: `515ae958-187a-4503-815f-379d728390b1` (string) - bid uuid
            + executor: `NCKU` (string) - Name of BEMS
            + start_time: `2020-11-11 12:00:00` (string) - DR start time
            + end_time: `2020-11-11 13:00:00` (string) - DR end time
            + volume: 50 (number) - bidding capacity
            + price: 6 (number) - bidding price
            + result: false (boolean) - bool
            + rate: 0 (number) - 達成率
            + blockchain_url: `https://ropsten.etherscan.io/tx/0x07178bc6d022a826d7f85b64f00b77bf878d04519cfbdc6e33aacd802b191435` (string) - url
        + (BIDRESULT)
            + uuid: `ca45ecc1-13a1-4a93-b047-857be806b764` (string) - bid uuid
            + executor: `Carlab_BEMS` (string) - Name of BEMS
            + start_time: `2020-11-11 11:00:00` (string) - DR start time
            + end_time: `2020-11-11 12:00:00` (string) - DR end time
            + volume: 30 (number) - bidding capacity
            + price: 8 (number) - bidding price
            + result: true (boolean) - bool
            + rate: 0.33 (number) - 達成率
            + blockchain_url: `https://ropsten.etherscan.io/tx/0xc94ec346cea143d8aab07e3a23a9f24031a9a9ae5b9717d99cf32ac0f57a920d` (string) - url

+ Response 400 (text/plain)
     + body

            error


### BEMS DR RESULTS BY UUID [GET /DR_result{?uuid}]
<pre>
curl https://et.udc-service.io:5000/DR_result?uuid=fbb4ccc5-d4ea-489d-94ea-3f04cd48b17b -X GET -H "Content-Type: application/json" -H "Authorization: Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR"
</pre>

Get DR results: By specifying uuids in query parameter, response will return same uuid result.
* When you are logged in as a BEMS, you can only query uuid within your bids, otherwise return empty.
* For Aggregator, he/she can request any uuid unless the uuid is not found in database.

+ Parameters
    + uuid: `fbb4ccc5-d4ea-489d-94ea-3f04cd48b17b` (required, string) - uuid of bid

+ Request
    + Headers

            API-version: 0.1
            Authorization: `Bearer OXBiogjCfdKb7m9CEOPhpbjjv0n5OtfltzgMJbSxbP7jVFY8XUNzHqkGidDumQSR

+ Response 200 (application/json)
    + Attributes (array, fixed-type)
        + (BIDRESULT)

+ Response 400 (text/plain)
     + body

            error


## Data Structures
### BEMSBID
+ uuid: `fbb4ccc5-d4ea-489d-94ea-3f04cd48b17b` (string) - bid uuid
+ executor: `NCKU` (string) - Name of BEMS
+ start_time: `2020-11-11 11:00:00` (string) - DR start time
+ end_time: `2020-11-11 12:00:00` (string) - DR end time
+ volume: 40 (number) - bidding capacity
+ price: 8 (number) - bidding price

### BIDRESULT
+ uuid: `fbb4ccc5-d4ea-489d-94ea-3f04cd48b17b` (string) - uuid
+ executor: `NCKU` (string) - BEMS name
+ acceptor: `Carlab_BEMS` (string) - CEMS name
+ start_time: `2020-11-11 11:00:00` (string) - DR start time
+ end_time: `2020-11-11 12:00:00` (string) - DR end time
+ volume: 40 (number) - bidding capacity
+ price: 8 (number) - bidding price
+ result: true (boolean) - bool
+ rate: 0.11 (number) - 達成率
+ blockchain_url: `https://ropsten.etherscan.io/tx/0x07178bc6d022a826d7f85b64f00b77bf878d04519cfbdc6e33aacd802b191435` (string) - url