Get Room Details

Last Updated on : 2023-06-15 06:07:48

Get the details of a specified room based on the unique room ID.

API address

GET: /v1.0/osaas/rooms/{room_id}

Request parameter

Parameter name	Type	IN	Required	Description
roomId	String	uri	true	The unique ID of a specified room.

Return parameter

Parameter name	Type	Description
roomId	String	The unique ID of a specified room.
projectId	String	The unique ID of a specified project.
roomName	String	The name of a specified room.
roomNo	String	The number of a specified room.
telephone	String	The mobile phone number.
description	String	The description of a specified room.
gmtCreate	long	The 13-bit timestamp of the creation time.
gmtModified	long	The 13-bit timestamp of the modification time.
constructionStatus	String	The construction status. Valid values: `UNAUTHORIZED`: unauthorized. `PENDING_CONSTRUCTION`: pending for construction. `IN_CONSTRUCTION`: under construction. `PENDING_ACCEPTANCE`: pending for acceptance. `ACCEPTANCE_COMPLETE`: acceptance completed.

Request example

GET: {url}/v1.0/osaas/rooms/1160823965053******

Return example

{
    "result": {
        "room_id": "1160823965053******",
        "gmt_create": 1559707046000,
        "description": "Description of the room",
        "gmt_modified": 1559707046000,
        "room_name": "Test Room",
        "project_id": "11239994446505******",
        "construction_status": "UNAUTHORIZED",
        "room_no": "1001"
    },
    "t": 1561381210234,
    "success": true
}

Error code

For more information, see error code.

Prev DocHotel Room Management

Next DocCreate Room