跳至主要内容
版本:V4.0

項目管理API


獲取項目信息

接口地址

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

請求參數

參數名類型位置必填說明
Content-TypeStringHeader內容類型,值爲application/json
AcceptStringHeader接受類型,值爲application/json
AuthorizationStringHeaderBearer認證,訪問令牌
commandStringBody命令名稱
idStringBody命令ID
paramObjectBody命令參數

返回參數

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
resultObject<result>Body返回結果

result說明

參數名類型位置說明
project_idStringBody項目ID
project_nameStringBody項目名稱
currencyStringBody貨幣
visit_urlStringBody訪問地址
addressObject<address>Body地址
roomObject<room>Body房間信息
deviceObject<device>Body設備信息

address說明

參數名類型位置說明
countryStringBody國家
state_provinceStringBody州/省份
cityStringBody城市
streetStringBody街道
postcodeStringBody郵編

room說明

參數名類型位置說明
to_stayIntegerBody待入住
checked_outIntegerBody已退房
dirtyIntegerBody髒房間
vacant_dirtyIntegerBody空髒房間
occupied_dirtyIntegerBody住客髒房間
vacant_cleanIntegerBody空乾淨房間
occupied_cleanIntegerBody住客乾淨房間
dndIntegerBody勿擾房間
vacant_todayIntegerBody今日空房
checked_in_todayIntegerBody今日入住
number_of_staying_todayIntegerBody今日入住人數
occupancy_rate_todayIntegerBody今日入住率

device說明

參數名類型位置說明
totalIntegerBody總數
onlineIntegerBody在線
offlineIntegerBody離線
low_powerIntegerBody低電量

請求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_project_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {}
}

成功返回示例

狀態碼:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
"project_name": "test",
"currency": "USD:US Dollar",
"visit_url": "https://test.akubela.com/g",
"address": {
"country": "Austria",
"state_province": "Tirol",
"city": "Absam",
"street": "test",
"postcode": "0000001"
},
"room": {
"to_stay": 0,
"checked_out": 0,
"dirty": 0,
"vacant_dirty": 0,
"occupied_dirty": 0,
"vacant_clean": 0,
"occupied_clean": 0,
"dnd": 0,
"vacant_today": 0,
"checked_in_today": 0,
"number_of_staying_today": 0,
"occupancy_rate_today": 0
},
"device": {
"total": 0,
"online": 0,
"offline": 0,
"low_power": 0
}
}
}

失敗返回示例

接口失敗返回



更新項目信息

接口地址

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

請求參數

參數名類型位置必填說明
Content-TypeStringHeader內容類型,值爲application/json
AcceptStringHeader接受類型,值爲application/json
AuthorizationStringHeaderBearer認證,訪問令牌
commandStringBody命令名稱
idStringBody命令ID
paramObject<param>Body命令參數

param說明

參數名類型位置必填說明
currencyStringBody貨幣

返回參數

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
resultObjectBody返回結果

請求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "update_project_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"currency": "USD:US Dollar"
}
}

成功返回示例

狀態碼:200

Content-Type: application/json

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

失敗返回示例

接口失敗返回



獲取貨幣列表

接口地址

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

請求參數

參數名類型位置必填說明
Content-TypeStringHeader內容類型,值爲application/json
AcceptStringHeader接受類型,值爲application/json
AuthorizationStringHeaderBearer認證,訪問令牌
commandStringBody命令名稱
idStringBody命令ID
paramObjectBody命令參數

返回參數

參數名類型位置說明
Content-TypeStringHeader內容類型,值爲application/json
successBooleanBody判斷請求是否成功
true:成功
false:失敗
timestampIntegerBody時間戳
result[]Object<result>Body返回結果

result說明

參數名類型位置說明
currencyStringBody貨幣

請求示例

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_currency_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {}
}

成功返回示例

狀態碼:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"currency": "USD:US Dollar"
}
]
}

失敗返回示例

接口失敗返回