Version: V4.0

Booking Management API

Get Amenity Type 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<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

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
amenity_type_id	String	Body	Amenity type ID
amenity_type_name	String	Body	Amenity type name
is_public	Boolean	Body	Whether the device is public or not? true: yes false: no

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_amenity_type_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "amenity_type_id": "ax9a621c1ae77040d697bd2134700f57e",
      "amenity_type_name": "test",
      "is_public": true
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Amenity Type 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
amenity_type_id	String	Body	Yes	Amenity type ID

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
amenity_type_name	String	Body	Amenity type name
is_public	Boolean	Body	Whether the device is public or not? true: yes false: no

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_amenity_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_type_id": "ax9a621c1ae77040d697bd2134700f57e"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "amenity_type_name": "test",
    "is_public": true
  }
}

Failure Return Example

See Failure Return Example

Create Amenity Type 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
amenity_type_name	String	Body	Yes	Amenity type name
is_public	Boolean	Body	Yes	Whether the device is public or not? true: yes false: no

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
amenity_type_id	String	Body	Amenity type ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_amenity_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_type_name": "test",
    "is_public": true
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Update Amenity Type 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
amenity_type_id	String	Body	Yes	Amenity type ID
amenity_type_name	String	Body	Yes	Amenity type name
is_public	Boolean	Body	Yes	Whether the device is public or not? true: yes false: no

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_amenity_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_type_id": "a2a621c1ae77040d697bd2134700f57ea",
    "amenity_type_name": "test",
    "is_public": true
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Amenity Type 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
amenity_type_id	String	Body	Yes	Amenity type ID

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": "delete_amenity_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_type_id": "a2a621c1ae77040d697bd2134700f57ea"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Amenity 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<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

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
amenity_id	String	Body	Amenity ID
amenity_name	String	Body	Amenity name
amenity_type_id	String	Body	Amenity type ID
amenity_type_name	String	Body	Amenity type name
amenity_description	String	Body	Amenity description
amenity_picture_url	String	Body	Amenity picture URL
devices	[]Object<device>	Body	Device information
enable	Boolean	Body	Whether the amenity is enable or not? true: enable false: disable
contact	String	Body	Contact
contact_information	String	Body	Contact information
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
available_days	[]String	Body	Available days
maximum_duration	Integer	Body	Maximum duration (min)
maximum_advance	Integer	Body	Maximum advance (d)
maximum_reservation	Integer	Body	Maximum reservation
maximum_password_count	Integer	Body	Maximum password count
require_approval	Boolean	Body	Whether the amenity requires approval or not? true: require false: not require
allow_guest_booking	Boolean	Body	Whether the guest allowed booking or not? true: allowed false: not allowed
fee_type	String	Body	Fee type, time or people or time and people
fee	String	Body	Fee

device description

Parameter Name	Type	Location	Description
mac	String	Body	MAC

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "amenity_id": "afa332e258aae1badbb27d31128f442dc",
      "amenity_name": "Gym",
      "amenity_type_id": "a2a621c1ae77040d697bd2134700f57ea",
      "amenity_type_name": "test",
      "amenity_description": "test",
      "amenity_picture_url": "https://test.akubela.com/g",
      "devices": [
        {
          "mac": "C10519082089"
        }
      ],
      "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,
      "allow_guest_booking": true,
      "fee_type": "time",
      "fee": "100"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Amenity 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
amenity_id	String	Body	Yes	Amenity ID

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
amenity_name	String	Body	Amenity name
amenity_type_id	String	Body	Amenity type ID
amenity_type_name	String	Body	Amenity type name
amenity_description	String	Body	Amenity description
amenity_picture_url	String	Body	Amenity picture URL
devices	[]Object<device>	Body	Device information
enable	Boolean	Body	Whether the amenity is enable or not? true: enable false: disable
contact	String	Body	Contact
contact_information	String	Body	Contact information
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
available_days	[]String	Body	Available days
maximum_duration	Integer	Body	Maximum duration (min)
maximum_advance	Integer	Body	Maximum advance (d)
maximum_reservation	Integer	Body	Maximum reservation
maximum_password_count	Integer	Body	Maximum password count
require_approval	Boolean	Body	Whether the amenity requires approval or not? true: require false: not require
allow_guest_booking	Boolean	Body	Whether the guest allowed booking or not? true: allowed false: not allowed
fee_type	String	Body	Fee type, time or people or time and people
fee	String	Body	Fee

device description

Parameter Name	Type	Location	Description
mac	String	Body	MAC

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "amenity_name": "Gym",
    "amenity_type_id": "a2a621c1ae77040d697bd2134700f57ea",
    "amenity_type_name": "test",
    "amenity_description": "test",
    "amenity_picture_url": "https://test.akubela.com/g",
    "devices": [
      {
        "mac": "C10519082089"
      }
    ],
    "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,
    "allow_guest_booking": true,
    "fee_type": "time",
    "fee": "100"
  }
}

Failure Return Example

See Failure Return Example

Get Creating Amenity 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
devices	[]Object<device>	Body	Device information

device description

Parameter Name	Type	Location	Description
mac	String	Body	MAC
device_name	String	Body	Device name

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "devices": [
      {
        "mac": "C10519082089",
        "device_name": "device"
      }
    ]
  }
}

Failure Return Example

See Failure Return Example

Create Amenity 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
amenity_name	String	Body	Yes	Amenity name
amenity_type_id	String	Body	Yes	Amenity type ID
amenity_description	String	Body	Yes	Amenity description
amenity_picture_url	String	Body	Yes	Amenity picture URL
devices	[]Object<device>	Body	Yes	Device information
enable	Boolean	Body	Yes	Whether the amenity is enable or not? true: enable false: disable
contact	String	Body	Yes	Contact
contact_information	String	Body	Yes	Contact information
start_time	String	Body	Yes	Start time, UTC
finish_time	String	Body	Yes	Finish time, UTC
available_days	[]String	Body	Yes	Available days
maximum_duration	Integer	Body	Yes	Maximum duration (min)
maximum_advance	Integer	Body	Yes	Maximum advance (d)
maximum_reservation	Integer	Body	Yes	Maximum reservation
maximum_password_count	Integer	Body	Yes	Maximum password count
require_approval	Boolean	Body	Yes	Whether the amenity requires approval or not? true: require false: not require
allow_guest_booking	Boolean	Body	Yes	Whether the guest allowed booking or not? true: allowed false: not allowed
fee_type	String	Body	Yes	Fee type, time or people or time and people
fee	String	Body	Yes	Fee

device description

Parameter Name	Type	Location	Required	Description
mac	String	Body	Yes	MAC

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
amenity_id	String	Body	Amenity ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_name": "Gym",
    "amenity_type_id": "a2a621c1ae77040d697bd2134700f57ea",
    "amenity_description": "test",
    "amenity_picture_url": "https://test.akubela.com/g",
    "devices": [
      {
        "mac": "C10519082089"
      }
    ],
    "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,
    "allow_guest_booking": true,
    "fee_type": "time",
    "fee": "100"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Update Amenity 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
amenity_id	String	Body	Yes	Amenity ID
amenity_type_id	String	Body	Yes	Amenity type ID
amenity_name	String	Body	Yes	Amenity name
amenity_description	String	Body	Yes	Amenity description
amenity_picture_url	String	Body	Yes	Amenity picture URL
devices	[]Object<device>	Body	Yes	Device information
enable	Boolean	Body	Yes	Whether the amenity is enable or not? true: enable false: disable
contact	String	Body	Yes	Contact
contact_information	String	Body	Yes	Contact information
start_time	String	Body	Yes	Start time, UTC
finish_time	String	Body	Yes	Finish time, UTC
available_days	[]String	Body	Yes	Available days
maximum_duration	Integer	Body	Yes	Maximum duration (min)
maximum_advance	Integer	Body	Yes	Maximum advance (d)
maximum_reservation	Integer	Body	Yes	Maximum reservation
maximum_password_count	Integer	Body	Yes	Maximum password count
require_approval	Boolean	Body	Yes	Whether the amenity requires approval or not? true: require false: not require
allow_guest_booking	Boolean	Body	Yes	Whether the guest allowed booking or not? true: allowed false: not allowed
fee_type	String	Body	Yes	Fee type, time or people or time and people
fee	String	Body	Yes	Fee

device description

Parameter Name	Type	Location	Required	Description
mac	String	Body	Yes	MAC

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_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_id": "abafa332e258aae1badbb27d31128f442",
    "amenity_type_id": "a2a621c1ae77040d697bd2134700f57ea",
    "amenity_name": "Gym",
    "amenity_description": "test",
    "amenity_picture_url": "https://test.akubela.com/g",
    "devices": [
      {
        "mac": "C10519082089"
      }
    ],
    "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,
    "allow_guest_booking": true,
    "fee_type": "time",
    "fee": "100"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Amenity 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
amenity_id	String	Body	Yes	Amenity ID

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": "delete_amenity_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_id": "a8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Enable Amenity

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
amenity_id	String	Body	Yes	Amenity ID
enable	Boolean	Body	Yes	Whether the amenity is enable or not? true: enable false: disable

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": "enable_amenity",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "amenity_id": "afa332e258aae1badbb27d31128f442dc",
    "enable": true
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Booking 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<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

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
residence_id	String	Body	Residence ID
booking_id	String	Body	Booking ID
amenity_id	String	Body	Amenity ID
amenity_name	String	Body	Amenity name
amenity_type_id	String	Body	Amenity type ID
amenity_type_name	String	Body	Amenity type name
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
state	String	Body	State, pending or rejected or canceled or success
is_expired	Boolean	Body	Whether the booking is expired or not? true: yes false: no
pin_code	String	Body	PIN code
qr_code_url	String	Body	QR code URL
created_time	String	Body	Created time, UTC
guest_id	String	Body	Guest ID
member_id	String	Body	Member ID
number	Integer	Body	Number of people

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "residence_id": "rm31adc223cc4b3bedb6bd4742dedcfa5",
      "booking_id": "bfa332e258aae1badbb27d31128f442d1",
      "amenity_id": "afa332e258aae1badbb27d31128f442dc",
      "amenity_name": "Gym",
      "amenity_type_id": "ax9a621c1ae77040d697bd2134700f57e",
      "amenity_type_name": "test",
      "start_time": "2025-05-02 13:14:15",
      "finish_time": "2025-05-02 15:14:15",
      "state": "pending",
      "is_expired": true,
      "pin_code": "123456",
      "qr_code_url": "https://test.akubela.com/h.png",
      "created_time": "2025-05-01 13:32:45",
      "guest_id": "grm31adc223cc4b3bedb6bd4742dedcfa",
      "member_id": "",
      "number": 1
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Booking 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
booking_id	String	Body	Yes	Booking ID

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
amenity_id	String	Body	Amenity ID
amenity_name	String	Body	Amenity name
amenity_type_id	String	Body	Amenity type ID
amenity_type_name	String	Body	Amenity type name
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
state	String	Body	State, pending or rejected or canceled or success
is_expired	Boolean	Body	Whether the booking is expired or not? true: yes false: no
pin_code	String	Body	PIN code
qr_code_url	String	Body	QR code URL
created_time	String	Body	Created time, UTC
guest_name	String	Body	Guest name
member_id	String	Body	Member ID
number	Integer	Body	Number of people

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "amenity_id": "afa332e258aae1badbb27d31128f442dc",
    "amenity_name": "Gym",
    "amenity_type_id": "ax9a621c1ae77040d697bd2134700f57e",
    "amenity_type_name": "test",
    "start_time": "2025-05-02 13:14:15",
    "finish_time": "2025-05-02 15:14:15",
    "state": "pending",
    "is_expired": true,
    "pin_code": "123456",
    "qr_code_url": "https://test.akubela.com/h.png",
    "created_time": "2025-05-01 13:32:45",
    "guest_name": "dom",
    "member_id": "",
    "number": 1
  }
}

Failure Return Example

See Failure Return Example

Update Booking 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
booking_id	String	Body	Yes	Booking ID
state	String	Body	Yes	State, rejected or success

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_booking_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "booking_id": "bfa332e258aae1badbb27d31128f442dc",
    "state": "rejected"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Booking 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
booking_id	String	Body	Yes	Booking ID

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": "delete_booking_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "booking_id": "b8b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Member Booking 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<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index
member_id	String	Body	Yes	Member ID

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
residence_id	String	Body	Residence ID
booking_id	String	Body	Booking ID
amenity_id	String	Body	Amenity ID
amenity_name	String	Body	Amenity name
amenity_type_id	String	Body	Amenity type ID
amenity_type_name	String	Body	Amenity type name
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
state	String	Body	State, pending or rejected or canceled or success
is_expired	Boolean	Body	Whether the booking is expired or not? true: yes false: no
pin_code	String	Body	PIN code
qr_code_url	String	Body	QR code URL
created_time	String	Body	Created time, UTC
number	Integer	Body	Number of people

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_member_booking_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "member_id": "mgrm31adc223cc4b3bedb6bd4742dedcf"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": [
    {
      "residence_id": "rm31adc223cc4b3bedb6bd4742dedcfa5",
      "booking_id": "bfa332e258aae1badbb27d31128f442d1",
      "amenity_id": "afa332e258aae1badbb27d31128f442dc",
      "amenity_name": "Gym",
      "amenity_type_id": "ax9a621c1ae77040d697bd2134700f57e",
      "amenity_type_name": "test",
      "start_time": "2025-05-02 13:14:15",
      "finish_time": "2025-05-02 15:14:15",
      "state": "pending",
      "is_expired": true,
      "pin_code": "123456",
      "qr_code_url": "https://test.akubela.com/h.png",
      "created_time": "2025-05-01 13:32:45",
      "number": 1
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Amenity Type List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Amenity Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Create Amenity Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Update Amenity Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Delete Amenity Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Get Amenity List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

device description​

Request Example​

Success Return Example​

Failure Return Example​

Get Amenity Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

device description​

Request Example​

Success Return Example​

Failure Return Example​

Get Creating Amenity List​

Request URL​

Request Parameter​

Return Parameter​

result description​

device description​

Request Example​

Success Return Example​

Failure Return Example​

Create Amenity Information​

Request URL​

Request Parameter​

param description​

device description​

Return Parameter​

result description​

Request Example​

Get Amenity Type List

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Amenity Type Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Create Amenity Type Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Update Amenity Type Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Delete Amenity Type Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Get Amenity List

Request URL

Request Parameter

param description

Return Parameter

result description

device description

Request Example

Success Return Example

Failure Return Example

Get Amenity Information

Request URL

Request Parameter

param description

Return Parameter

result description

device description

Request Example

Success Return Example

Failure Return Example

Get Creating Amenity List

Request URL

Request Parameter

Return Parameter

result description

device description

Request Example

Success Return Example

Failure Return Example

Create Amenity Information

Request URL

Request Parameter

param description

device description

Return Parameter

result description

Request Example