Version: V4.0

Room Management API

Get Room 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
building_id	String	Body	Building ID
building_name	String	Body	Building name
floors	[]Object<floor>	Body	Floor information

floor description

Parameter Name	Type	Location	Description
floor_id	String	Body	Floor ID
floor_name	String	Body	Floor name
residences	[]Object<residence>	Body	Residence information

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID
residence_no	String	Body	Residence number

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

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

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "building_id": "bx9a621c1ae77040d697bd2134700f57e",
      "building_name": "test",
      "floors": [
        {
          "floor_id": "fx9a621c1ae77040d697bd2134700f572",
          "floor_name": "1",
          "residences": [
            {
              "residence_id": "rx9a621c1ae77040d697bd2134700f574",
              "residence_name": "101"
            }
          ]
        }
      ]
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Room 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
residence_id	String	Body	Yes	Residence 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
building_id	String	Body	Building ID
building_name	String	Body	Building name
floor_id	String	Body	Floor ID
floor_name	String	Body	Floor name
residence_no	String	Body	Residence number
room_type_id	String	Body	Room type ID
room_type_name	String	Body	Room type name
room_tag_id	String	Body	Room tag ID
room_tag_name	String	Body	Room tag name
order_id	String	Body	Order ID
dirty	Boolean	Body	Whether the room is dirty or not? true: yes false: no
occupied	Boolean	Body	Whether the room is occupied or not? true: yes false: no
dnd	Boolean	Body	Whether the room is DND 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_room_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "rx9a621c1ae77040d697bd2134700f57v"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "building_id": "brx9a621c1ae77040d697bd2134700f57",
    "building_name": "test",
    "floor_id": "fbrx9a621c1ae77040d697bd2134700f5",
    "floor_name": "test",
    "residence_no": "101",
    "room_type_id": "rfbrx9a621c1ae77040d697bd2134700f",
    "room_type_name": "test",
    "room_tag_id": "rrfbrx9a621c1ae77040d697bd2134700",
    "room_tag_name": "big",
    "order_id": "orrfbrx9a621c1ae77040d697bd213470",
    "dirty": true,
    "occupied": true,
    "dnd": false
  }
}

Failure Return Example

See Failure Return Example

Update Room State

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
residence_id	String	Body	Yes	Residence ID
dirty	Boolean	Body	Yes	Whether the room is dirty 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_room_state",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "dirty": true
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Room 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
room_type_id	String	Body	Room type ID
room_type_name	String	Body	Room type name
bed	Integer	Body	Bed
occupancy	Integer	Body	Occupancy

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_room_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": [
    {
      "room_type_id": "rx9a621c1ae77040d697bd2134700f57e",
      "room_type_name": "test",
      "bed": 2,
      "occupancy": 2
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Room 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
room_type_id	String	Body	Yes	Room 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
room_type_name	String	Body	Room type name
bed	Integer	Body	Bed
occupancy	Integer	Body	Occupancy
residences	[]Object<residence>	Body	Residence information

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_room_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_type_id": "rx9a621c1ae77040d697bd2134700f57e"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "room_type_name": "test",
    "bed": 2,
    "occupancy": 2,
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Failure Return Example

See Failure Return Example

Create Room 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
room_type_name	String	Body	Yes	Room type name
bed	Integer	Body	Yes	Bed
occupancy	Integer	Body	Yes	Occupancy
residences	[]Object<residence>	Body	Yes	Residence information

residence description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence 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
room_type_id	String	Body	Room 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_room_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_type_name": "test",
    "bed": 2,
    "occupancy": 2,
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Update Room 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
room_type_id	String	Body	Yes	Room type ID
room_type_name	String	Body	Yes	Room type name
bed	Integer	Body	Yes	Bed
occupancy	Integer	Body	Yes	Occupancy
residences	[]Object<residence>	Body	Yes	Residence information

residence description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence 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": "update_room_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_type_id": "r2a621c1ae77040d697bd2134700f57ea",
    "room_type_name": "test",
    "bed": 2,
    "occupancy": 2,
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Room 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
room_type_id	String	Body	Yes	Room 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_room_type_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_type_id": "rrbr2c4b070cc928496198944858b344f"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

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
room_tag_id	String	Body	Room tag ID
room_tag_name	String	Body	Room tag name
residences	[]Object<residence>	Body	Residence information

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_room_tag_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": [
    {
      "room_tag_id": "rx9a621c1ae77040d697bd2134700f571",
      "room_tag_name": "test",
      "residences": [
        {
          "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
        }
      ]
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Room Tag 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
room_tag_id	String	Body	Yes	Room tag 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
room_tag_name	String	Body	Room tag name
residences	[]Object<residence>	Body	Residence information

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_room_tag_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_tag_id": "rx9a621c1ae77040d697bd2134700f572"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "room_tag_name": "test",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Failure Return Example

See Failure Return Example

Create Room Tag 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
room_tag_name	String	Body	Yes	Room tag name
residences	[]Object<residence>	Body	Yes	Residence information

residence description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence 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
room_tag_id	String	Body	Room tag 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_room_tag_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_tag_name": "test",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Update Room Tag 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
room_tag_id	String	Body	Yes	Room tag ID
room_tag_name	String	Body	Yes	Room tag name
residences	[]Object<residence>	Body	Yes	Residence information

residence description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence 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": "update_room_tag_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_tag_id": "r2a621c1ae77040d697bd2134700f57e1",
    "room_tag_name": "test",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Delete Room Tag 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
room_tag_id	String	Body	Yes	Room tag 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_room_tag_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "room_tag_id": "rrbr2c4b070cc928496198944858b343f"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Authorization Record 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
record_id	String	Body	Record ID
authorization_number	String	Body	Authorization number
access_type	String	Body	Access type, password or rf_card or qr_code
guest_id	String	Body	Guest ID
guest_name	String	Body	Guest name
email	String	Body	Email
phone	String	Body	Phone
residence_id	String	Body	Residence ID
residence_no	String	Body	Residence number
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
authorization_status	String	Body	Authorization status
updated_time	String	Body	Updated time, UTC

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_authorization_record_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": [
    {
      "record_id": "rr31adc223cc4b3bedb6bd4742dedcfa5",
      "authorization_number": "20250804152509933679",
      "access_type": "password",
      "guest_id": "grr31adc223cc4b3bedb6bd4742dedcfa",
      "guest_name": "test",
      "email": "",
      "phone": "",
      "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
      "residence_no": "12345",
      "start_time": "2025-08-06 03:00:03",
      "end_time": "2025-08-06 03:30:03",
      "authorization_status": "expired",
      "updated_at": "2025-08-06 04:00:03"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Authorization Record 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
record_id	String	Body	Yes	Record 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
authorization_number	String	Body	Authorization number
access_type	String	Body	Access type, password or rf_card or qr_code
pin_code	String	Body	PIN code
rf_card_number	String	Body	RF card number
qr_code_url	String	Body	QR code URL
guest_id	String	Body	Guest ID
guest_name	String	Body	Guest name
email	String	Body	Email
phone	String	Body	Phone
residence_id	String	Body	Residence ID
residence_no	String	Body	Residence number
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
authorization_status	String	Body	Authorization status
updated_time	String	Body	Updated time, UTC

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_authorization_record_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "record_id": "rr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "authorization_number": "20250804152509933679",
    "access_type": "password",
    "pin_code": "123456",
    "rf_card_number": "",
    "qr_code_url": "",
    "guest_id": "grr31adc223cc4b3bedb6bd4742dedcfa",
    "guest_name": "test",
    "email": "",
    "phone": "",
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "residence_no": "12345",
    "start_time": "2025-08-06 03:00:03",
    "end_time": "2025-08-06 03:30:03",
    "authorization_status": "expired",
    "updated_at": "2025-08-06 04:00:03"
  }
}

Failure Return Example

See Failure Return Example

Create Authorization Record 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
room_tag_name	String	Body	Yes	Room tag name
residences	[]Object<residence>	Body	Yes	Residence information

residence description

Parameter Name	Type	Location	Required	Description
access_type	String	Body	Yes	Access type, password or rf_card or qr_code
pin_code	String	Body	No	PIN code
rf_card_number	String	Body	No	RF card number
qr_code_url	String	Body	No	QR code URL
guest_id	String	Body	Yes	Guest ID
residence_id	String	Body	Yes	Residence ID
start_time	String	Body	Yes	Start time, UTC
finish_time	String	Body	Yes	Finish time, UTC

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
record_id	String	Body	Record ID
authorization_number	String	Body	Authorization number

Request Example

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

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_authorization_record_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_type": "password",
    "pin_code": "123456",
    "rf_card_number": "",
    "qr_code_url": "",
    "guest_id": "grr31adc223cc4b3bedb6bd4742dedcfa",
    "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
    "start_time": "2025-08-06 03:00:03",
    "end_time": "2025-08-06 03:30:03"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "record_id": "rr31adc223cc4b3bedb6bd4742dedcfa5",
    "authorization_number": "20250804152509933679"
  }
}

Failure Return Example

See Failure Return Example

Delete Authorization Record 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
record_id	String	Body	Yes	Record 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_authorization_record_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "record_id": "rr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

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

Failure Return Example

See Failure Return Example

Get Room List​

Request URL​

Request Parameter​

Return Parameter​

result description​

floor description​

residence description​

Request Example​

Success Return Example​

Failure Return Example​

Get Room Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Update Room State​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Get Room Type List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Room Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

residence description​

Request Example​

Success Return Example​

Failure Return Example​

Create Room Type Information​

Request URL​

Request Parameter​

param description​

residence description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Update Room Type Information​

Request URL​

Request Parameter​

param description​

residence description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Delete Room Type Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Get Room Tag List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

residence description​

Get Room List

Request URL

Request Parameter

Return Parameter

result description

floor description

residence description

Request Example

Success Return Example

Failure Return Example

Get Room Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Update Room State

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Get Room Type List

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Room Type Information

Request URL

Request Parameter

param description

Return Parameter

result description

residence description

Request Example

Success Return Example

Failure Return Example

Create Room Type Information

Request URL

Request Parameter

param description

residence description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Update Room Type Information

Request URL

Request Parameter

param description

residence description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Delete Room Type Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Get Room Tag List

Request URL

Request Parameter

param description

Return Parameter

result description

residence description