版本：V3.0

預約管理API

獲取設施列表

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
page_size	Integer	Body	是	每頁數量
page_index	Integer	Body	是	當前頁數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
amenity_id	String	Body	設施ID
amenity_name	String	Body	設施名稱
amenity_description	String	Body	設施描述
amenity_picture_url	String	Body	設施圖片地址
buildings	[]Object<building>	Body	樓棟信息
devices	[]Object<device>	Body	設備信息
enable	Boolean	Body	判斷是否啓用設施 true：啓用 false：禁用
contact	String	Body	聯繫人
contact_information	String	Body	聯繫方式
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
available_days	[]String	Body	可用時間
maximum_duration	Integer	Body	最大持續時間，單位：分鐘
maximum_advance	Integer	Body	最大提前量，單位：天
maximum_reservation	Integer	Body	最大預約數
maximum_password_count	Integer	Body	最大密碼次數
require_approval	Boolean	Body	判斷是否需要審覈 true：需要 false：不需要

building說明

參數名	類型	位置	說明
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱

device說明

參數名	類型	位置	說明
device_id	String	Body	設備ID
device_name	String	Body	設備名稱

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_amenity_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "amenity_id": "afa332e258aae1badbb27d31128f442dc",
      "amenity_name": "Gym",
      "amenity_description": "test",
      "amenity_picture_url": "https://test.akubela.com/g",
      "buildings": [
        {
          "building_id": "bafa332e258aae1badbb27d31128f442d",
          "building_name": "001"
        }
      ],
      "devices": [
        {
          "device_id": "dwbdbbafa332e258aae1badbb27d31128",
          "device_name": "device"
        }
      ],
      "enable": true,
      "contact": "test",
      "contact_information": "1234567",
      "start_time": "13:14",
      "finish_time": "15:14",
      "available_days": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday",
        "Sunday"
      ],
      "maximum_duration": 30,
      "maximum_advance": 1,
      "maximum_reservation": 1,
      "maximum_password_count": 20,
      "require_approval": true
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取設施信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
amenity_id	String	Body	是	設施ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
amenity_name	String	Body	設施名稱
amenity_description	String	Body	設施描述
amenity_picture_url	String	Body	設施圖片地址
buildings	[]Object<building>	Body	樓棟信息
devices	[]Object<device>	Body	設備信息
enable	Boolean	Body	判斷是否啓用設施 true：啓用 false：禁用
contact	String	Body	聯繫人
contact_information	String	Body	聯繫方式
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
available_days	[]String	Body	可用時間
maximum_duration	Integer	Body	最大持續時間，單位：分鐘
maximum_advance	Integer	Body	最大提前量，單位：天
maximum_reservation	Integer	Body	最大預約數
maximum_password_count	Integer	Body	最大密碼次數
require_approval	Boolean	Body	判斷是否需要審覈 true：需要 false：不需要

building說明

參數名	類型	位置	說明
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱

device說明

參數名	類型	位置	說明
device_id	String	Body	設備ID
device_name	String	Body	設備名稱

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "amenity_id": "afa332e258aae1badbb27d31128f442dc"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "amenity_name": "Gym",
    "amenity_description": "test",
    "amenity_picture_url": "https://test.akubela.com/g",
    "buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d",
        "building_name": "001"
      }
    ],
    "devices": [
      {
        "device_id": "dwbdbbafa332e258aae1badbb27d31128",
        "device_name": "device"
      }
    ],
    "enable": true,
    "contact": "test",
    "contact_information": "1234567",
    "start_time": "13:14",
    "finish_time": "15:14",
    "available_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday",
      "Sunday"
    ],
    "maximum_duration": 30,
    "maximum_advance": 1,
    "maximum_reservation": 1,
    "maximum_password_count": 20,
    "require_approval": true
  }
}

失敗返回示例

見接口失敗返回

獲取可創建設施列表

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
buildings	[]Object<building>	Body	樓棟信息
devices	[]Object<device>	Body	設備信息

building說明

參數名	類型	位置	說明
building_id	String	Body	樓棟ID
building_name	String	Body	樓棟名稱

device說明

參數名	類型	位置	說明
device_id	String	Body	設備ID
device_name	String	Body	設備名稱

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_creating_amenity_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "buildings": [
      {
        "building_id": "b8f39bda1a956435d96be126854c61318",
        "building_name": "test"
      }
    ],
    "devices": [
      {
        "device_id": "db8f39bda1a956435d96be126854c6131",
        "device_name": "device"
      }
    ]
  }
}

失敗返回示例

見接口失敗返回

創建設施信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
amenity_name	String	Body	是	設施名稱
amenity_description	String	Body	是	設施描述
amenity_picture_url	String	Body	是	設施圖片地址
buildings	[]Object<building>	Body	是	樓棟信息
devices	[]Object<device>	Body	是	設備信息
enable	Boolean	Body	是	判斷是否啓用設施 true：啓用 false：禁用
contact	String	Body	是	聯繫人
contact_information	String	Body	是	聯繫方式
start_time	String	Body	是	開始時間，UTC
finish_time	String	Body	是	結束時間，UTC
available_days	[]String	Body	是	可用時間
maximum_duration	Integer	Body	是	最大持續時間，單位：分鐘
maximum_advance	Integer	Body	是	最大提前量，單位：天
maximum_reservation	Integer	Body	是	最大預約數
maximum_password_count	Integer	Body	是	最大密碼次數
require_approval	Boolean	Body	是	判斷是否需要審覈 true：需要 false：不需要

building說明

參數名	類型	位置	必填	說明
building_id	String	Body	是	樓棟ID
building_name	String	Body	是	樓棟名稱

device說明

參數名	類型	位置	必填	說明
device_id	String	Body	是	設備ID
device_name	String	Body	是	設備名稱

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
amenity_id	String	Body	設施ID

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
    "amenity_name": "Gym",
    "amenity_description": "test",
    "amenity_picture_url": "https://test.akubela.com/g",
    "buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d",
        "building_name": "001"
      }
    ],
    "devices": [
      {
        "device_id": "dwbdbbafa332e258aae1badbb27d31128",
        "device_name": "device"
      }
    ],
    "enable": true,
    "contact": "test",
    "contact_information": "1234567",
    "start_time": "13:14",
    "finish_time": "15:14",
    "available_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday",
      "Sunday"
    ],
    "maximum_duration": 30,
    "maximum_advance": 1,
    "maximum_reservation": 1,
    "maximum_password_count": 20,
    "require_approval": true
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "amenity_id": "abafa332e258aae1badbb27d31128f442"
  }
}

失敗返回示例

見接口失敗返回

更新設施信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
amenity_id	String	Body	是	設施ID
amenity_name	String	Body	是	設施名稱
amenity_description	String	Body	是	設施描述
amenity_picture_url	String	Body	是	設施圖片地址
buildings	[]Object<building>	Body	是	樓棟信息
devices	[]Object<device>	Body	是	設備信息
enable	Boolean	Body	是	判斷是否啓用設施 true：啓用 false：禁用
contact	String	Body	是	聯繫人
contact_information	String	Body	是	聯繫方式
start_time	String	Body	是	開始時間，UTC
finish_time	String	Body	是	結束時間，UTC
available_days	[]String	Body	是	可用時間
maximum_duration	Integer	Body	是	最大持續時間，單位：分鐘
maximum_advance	Integer	Body	是	最大提前量，單位：天
maximum_reservation	Integer	Body	是	最大預約數
maximum_password_count	Integer	Body	是	最大密碼次數
require_approval	Boolean	Body	是	判斷是否需要審覈 true：需要 false：不需要

building說明

參數名	類型	位置	必填	說明
building_id	String	Body	是	樓棟ID
building_name	String	Body	是	樓棟名稱

device說明

參數名	類型	位置	必填	說明
device_id	String	Body	是	設備ID
device_name	String	Body	是	設備名稱

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
    "amenity_id": "abafa332e258aae1badbb27d31128f442",
    "amenity_name": "Gym",
    "amenity_description": "test",
    "amenity_picture_url": "https://test.akubela.com/g",
    "buildings": [
      {
        "building_id": "bafa332e258aae1badbb27d31128f442d",
        "building_name": "001"
      }
    ],
    "devices": [
      {
        "device_id": "dwbdbbafa332e258aae1badbb27d31128",
        "device_name": "device"
      }
    ],
    "enable": true,
    "contact": "test",
    "contact_information": "1234567",
    "start_time": "13:14",
    "finish_time": "15:14",
    "available_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday",
      "Sunday"
    ],
    "maximum_duration": 30,
    "maximum_advance": 1,
    "maximum_reservation": 1,
    "maximum_password_count": 20,
    "require_approval": true
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

刪除設施信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
amenity_id	String	Body	是	設施ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "amenity_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

批量刪除設施信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
amenities	[]Object<amenity>	Body	是	設施信息

amenity說明

參數名	類型	位置	必填	說明
amenity_id	String	Body	是	設施ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "amenities": [
      {
        "amenity_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

啓用設施

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
amenity_id	String	Body	是	設施ID
enable	Boolean	Body	是	判斷是否啓用設施 true：啓用 false：禁用

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "enable_amenity",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
    "amenity_id": "afa332e258aae1badbb27d31128f442dc",
    "enable": true
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

獲取預約列表

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
page_size	Integer	Body	是	每頁數量
page_index	Integer	Body	是	當前頁數

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	[]Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
residence_id	String	Body	住宅ID
booking_id	String	Body	預約ID
amenity_id	String	Body	設施ID
amenity_name	String	Body	設施名稱
amenity_description	String	Body	設施描述
amenity_picture_url	String	Body	設施圖片地址
building_name	String	Body	樓棟名稱
family_name	String	Body	家庭名稱
residence_no	String	Body	住宅號碼
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
state	String	Body	狀態 pending：待審覈 rejected：已拒絕 canceled：已取消 success：成功
is_expired	Boolean	Body	判斷預約是否過期 true：已過期 false：未過期
pin_code	String	Body	PIN碼
qr_code_url	String	Body	二維碼地址
created_time	String	Body	創建時間，UTC
account_id	String	Body	賬號ID
account_name	String	Body	賬號名稱
first_name	String	Body	名
last_name	String	Body	姓
email	String	Body	郵箱
phone	String	Body	電話

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_booking_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "residence_id": "rm31adc223cc4b3bedb6bd4742dedcfa5",
      "booking_id": "bfa332e258aae1badbb27d31128f442d1",
      "amenity_id": "afa332e258aae1badbb27d31128f442dc",
      "amenity_name": "Gym",
      "amenity_description": "test",
      "amenity_picture_url": "https://test.akubela.com/g",
      "building_name": "001",
      "family_name": "home",
      "residence_no": "505",
      "start_time": "2024-05-02 13:14:15",
      "finish_time": "2024-05-02 15:14:15",
      "state": "pending",
      "is_expired": true,
      "pin_code": "123456",
      "qr_code_url": "https://test.akubela.com/h.png",
      "created_time": "2024-05-01 13:32:45",
      "account_id": "arm31adc223cc4b3bedb6bd4742dedcfa",
      "account_name": "test@akubela.com",
      "first_name": "clay",
      "last_name": "sagan",
      "email": "test@akubela.com",
      "phone": "1234567"
    }
  ]
}

失敗返回示例

見接口失敗返回

獲取預約信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
booking_id	String	Body	是	預約ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object<result>	Body	返回結果

result說明

參數名	類型	位置	說明
residence_id	String	Body	住宅ID
amenity_id	String	Body	設施ID
amenity_name	String	Body	設施名稱
amenity_description	String	Body	設施描述
amenity_picture_url	String	Body	設施圖片地址
building_name	String	Body	樓棟名稱
family_name	String	Body	家庭名稱
residence_no	String	Body	住宅號碼
start_time	String	Body	開始時間，UTC
finish_time	String	Body	結束時間，UTC
state	String	Body	狀態 pending：待審覈 rejected：已拒絕 canceled：已取消 success：成功
is_expired	Boolean	Body	判斷預約是否過期 true：已過期 false：未過期
pin_code	String	Body	PIN碼
qr_code_url	String	Body	二維碼地址
created_time	String	Body	創建時間，UTC
account_id	String	Body	賬號ID
account_name	String	Body	賬號名稱
first_name	String	Body	名
last_name	String	Body	姓
email	String	Body	郵箱
phone	String	Body	電話

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_booking_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "booking_id": "b31adc223cc4b3bedb6bd4742dedcfa52"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "residence_id": "rm31adc223cc4b3bedb6bd4742dedcfa5",
    "amenity_id": "afa332e258aae1badbb27d31128f442dc",
    "amenity_name": "Gym",
    "amenity_description": "test",
    "amenity_picture_url": "https://test.akubela.com/g",
    "building_name": "001",
    "family_name": "home",
    "residence_no": "505",
    "start_time": "2024-05-02 13:14:15",
    "finish_time": "2024-05-02 15:14:15",
    "state": "pending",
    "is_expired": true,
    "pin_code": "123456",
    "qr_code_url": "https://test.akubela.com/h.png",
    "created_time": "2024-05-01 13:32:45",
    "account_id": "arm31adc223cc4b3bedb6bd4742dedcfa",
    "account_name": "test@akubela.com",
    "first_name": "clay",
    "last_name": "sagan",
    "email": "test@akubela.com",
    "phone": "1234567"
  }
}

失敗返回示例

見接口失敗返回

更新預約信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
booking_id	String	Body	是	預約ID
state	String	Body	是	狀態 rejected：已拒絕 success：成功

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_booking_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa51",
    "booking_id": "bfa332e258aae1badbb27d31128f442dc",
    "state": "rejected"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

刪除預約信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
booking_id	String	Body	是	預約ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_booking_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "booking_id": "b8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

批量刪除預約信息

接口地址

POST /api/v1.0/invoke/open-ability/method/manager-commands

請求參數

參數名	類型	位置	必填	說明
Content-Type	String	Header	是	內容類型，值爲application/json
Accept	String	Header	是	接受類型，值爲application/json
Authorization	String	Header	是	Bearer認證，訪問令牌
command	String	Body	是	命令名稱
id	String	Body	是	命令ID
param	Object<param>	Body	是	命令參數

param說明

參數名	類型	位置	必填	說明
project_id	String	Body	是	項目ID
bookings	[]Object<booking>	Body	是	預約信息

booking說明

參數名	類型	位置	必填	說明
booking_id	String	Body	是	預約ID

返回參數

參數名	類型	位置	說明
Content-Type	String	Header	內容類型，值爲application/json
success	Boolean	Body	判斷請求是否成功 true：成功 false：失敗
timestamp	Integer	Body	時間戳
result	Object	Body	返回結果

請求示例

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_booking_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "bookings": [
      {
        "booking_id": "b8b5a73f8dd84abaa94dcs248be49b0d1"
      }
    ]
  }
}

成功返回示例

狀態碼：200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

失敗返回示例

見接口失敗返回

獲取設施列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

building說明​

device說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取設施信息​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

building說明​

device說明​

請求示例​

成功返回示例​

失敗返回示例​

獲取可創建設施列表​

接口地址​

請求參數​

param說明​

返回參數​

result說明​

building說明​

device說明​

請求示例​

成功返回示例​

失敗返回示例​

創建設施信息​

接口地址​

請求參數​

param說明​

building說明​

device說明​

返回參數​

result說明​

請求示例​

成功返回示例​

失敗返回示例​

更新設施信息​

接口地址​

請求參數​

param說明​

building說明​

device說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

刪除設施信息​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

批量刪除設施信息​

接口地址​

請求參數​

param說明​

amenity說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

啓用設施​

接口地址​

請求參數​

param說明​

返回參數​

請求示例​

成功返回示例​

失敗返回示例​

獲取預約列表​

獲取設施列表

接口地址

請求參數

param說明

返回參數

result說明

building說明

device說明

請求示例

成功返回示例

失敗返回示例

獲取設施信息

接口地址

請求參數

param說明

返回參數

result說明

building說明

device說明

請求示例

成功返回示例

失敗返回示例

獲取可創建設施列表

接口地址

請求參數

param說明

返回參數

result說明

building說明

device說明

請求示例

成功返回示例

失敗返回示例

創建設施信息

接口地址

請求參數

param說明

building說明

device說明

返回參數

result說明

請求示例

成功返回示例

失敗返回示例

更新設施信息

接口地址

請求參數

param說明

building說明

device說明

返回參數

請求示例

成功返回示例

失敗返回示例

刪除設施信息

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

批量刪除設施信息

接口地址

請求參數

param說明

amenity說明

返回參數

請求示例

成功返回示例

失敗返回示例

啓用設施

接口地址

請求參數

param說明

返回參數

請求示例

成功返回示例

失敗返回示例

獲取預約列表