Project Management API

---

Get Project Information

Request URL

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

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object	Body	Yes	Command parameter

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
project_id	String	Body	Project ID
project_name	String	Body	Project name
currency	String	Body	Currency
visit_url	String	Body	Visit URL
address	Object<address>	Body	Address
room	Object<room>	Body	Room information
device	Object<device>	Body	Device information

address description

Parameter Name	Type	Location	Description
country	String	Body	Country
state_province	String	Body	State or province
city	String	Body	City
street	String	Body	Street
postcode	String	Body	Postcode

room description

Parameter Name	Type	Location	Description
to_stay	Integer	Body	To stay
checked_out	Integer	Body	Checked out
dirty	Integer	Body	Dirty
vacant_dirty	Integer	Body	Vacant dirty
occupied_dirty	Integer	Body	Occupied dirty
vacant_clean	Integer	Body	Vacant clean
occupied_clean	Integer	Body	Occupied clean
dnd	Integer	Body	DND
vacant_today	Integer	Body	Vacant today
checked_in_today	Integer	Body	Checked in today
number_of_staying_today	Integer	Body	Number of staying today
occupancy_rate_today	Integer	Body	Occupancy rate today

device description

Parameter Name	Type	Location	Description
total	Integer	Body	Total
online	Integer	Body	Online
offline	Integer	Body	Offline
low_power	Integer	Body	Low power

Request Example

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": {}
}

Success Return Example

Status Code: 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
    }
  }
}

Failure Return Example

See Failure Return Example

---

Update Project Information

Request URL

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

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
currency	String	Body	Yes	Currency

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

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"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

---

Get Currency List

Request URL

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

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object	Body	Yes	Command parameter

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
currency	String	Body	Currency

Request Example

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": {}
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example