Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Operation

Information of the operation

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


Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
offsetIntegerfalse0Offset of the array of results.
limitIntegerfalse10Limit of results.
sortstringfalseidProperty of the entity to sort by.
sortModestringfalseAscMode 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


FieldTypeRequiredDescription
idIntegertrueUnique identificator of the Room.
codestringtrueCode of the Room
namestringtrueName of the Room
startDateLocalDatefalseStart date of Room
endDateLocalDatefalseEnd date of Room
descriptionstringfalseDescription of Room.
descriptionI18nstringfalseDescription of Room in I18n.
roomSituationTypeRoomSituationTypetrueSituation of the Room (see ref. table).

roomSpaceStatusType

RoomSpaceStatusTypefalseStatus of the inner Space.
reservationRoomStayReservationRoomStayfalseRelated stay that has this Room assigned.
reservationRoomStaySummaryReservationRoomStaySummaryfalseRelated stay summary that has this room assigned. Only show if have data.
spaceLockSpaceLockfalseSpace lock. Only show if have data.
roomTypeRoomTypefalseRoom Type. Only show if have data.


Example response

{
	"count": 10,
	"offset": 0,
	"limit": 2,
	"list": [{
			"id": 1,
			"code": "101",
			"name": "101",
			"roomSpaceStatusType": {
				"id": 1,
				"code": null,
				"name": "Clean"
			},
			"reservationRoomStay": null,
			"roomSituationType": {
				"id": 3,
				"code": "BL",
				"name": "Blocked"
			}
		},
		{
			"id": 2,
			"code": "102",
			"name": "102",
			"roomSpaceStatusType": {
				"id": 2,
				"code": null,
				"name": "Dirty"
			},
			"reservationRoomStay": null,
			"roomSituationType": {
				"id": 2,
				"code": "OC",
				"name": "Occupied"
			}
		}
	]
}
  • No labels