Operation

Information of the operation

Only accessible with permission of pms.integration.room


table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



GET



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



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
offsetIntegerfalserequest parameter
Offset of the array of results.
limitIntegerfalserequest parameter
Limit of results.
sortstringfalserequest parameter
Property of the entity to sort by.
sortModestringfalserequest parameter
Mode of sorting.


Example request

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



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity


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": "Habitación 101, en la primera planta.",
			"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"
			}
		}
	]
}