List of Room [GET]

Operation

Information of the operation

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/room

Request

Property	Type	Required	Type parameter	Description
chainId	Integer	true	path parameter	Unique identificator of the chain.
propertyId	Integer	true	path parameter	Unique identificator of the property.
offset	Integer	false	request parameter	Offset of the array of results.
limit	Integer	false	request parameter	Limit of results.
sort	string	false	request parameter	Property of the entity to sort by.
sortMode	string	false	request parameter	Mode of sorting.
lang	string	false	request parameter	Code Identificator of language.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/2/room

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field	Type	Required	Description
id	Integer	true	Unique identificator of the Room.
code	string	true	Code of the Room
name	string	true	Name of the Room
startDate	LocalDate	false	Start date of Room
endDate	LocalDate	false	End date of Room
description	string	false	Description of Room.
descriptionI18n	string	false	Description of Room in I18n.
roomSituationType	RoomSituationType	true	Situation of the Room (see ref. table).
roomSpaceStatusType	RoomSpaceStatusType	false	Status of the inner Space.
reservationRoomStay	ReservationRoomStay	false	Related stay that has this Room assigned.
reservationRoomStaySummary	ReservationRoomStaySummary	false	Related stay summary that has this room assigned. Only show if have data.
spaceLock	SpaceLock	false	Space lock. Only show if have data.
roomType	RoomType	false	Room Type. Only show if have data.

Example response

{
	"count": 10,
	"offset": 0,
	"limit": 2,
	"list": [{
			"id": 1,
			"code": "101",
			"name": "101",
            "startDate": "2023-09-23",
            "endDate": "2024-09-23",
	        "description": "Room 101, at first floor.",
            "descriptionI18n": "Room 101, at first floor.",
			"roomSpaceStatusType": {
				"id": 1,
				"code": null,
				"name": "Clean"
			},
			"reservationRoomStay": null,
			"roomSituationType": {
				"id": 3,
				"code": "BL",
				"name": "Blocked"
			}
		},
		{
			"id": 2,
			"code": "102",
			"name": "102",
            "startDate": "2023-09-23",
            "endDate": "2024-09-23",
			"roomSpaceStatusType": {
				"id": 2,
				"code": null,
				"name": "Dirty"
			},
			"reservationRoomStay": null,
			"roomSituationType": {
				"id": 2,
				"code": "OC",
				"name": "Occupied"
			}
		}
	]
}