[GET] Module Rack

Operation

Returns a list of Module, which is a custom model created to retrieve all the data related to the Reservation, ReservationRoomStay and Module.

GET

https://{environment}.ulysescloud.com/api/{version}/chain/{chainId}/property/{propertyid}/moduleRack

Request

This request has no parameters.

Example request

GET https://prod.ulysescloud.com/api/v1/chain/1/property/2/moduleRack

Response

Property	Type	Required	Description
Module	Module (Rack)	true	Array of Module

Entity

Field	Type	Required	Description
moduleId	Integer	true	Id of the represented Module (ModuleRack).
code	String	false	Code of the Module (ModuleRack).
name	String	false	Name of the Module (ModuleRack).
floorCode	String	false	Code of the Floor.
floorName	String	false	Name of the Floor.
floorOrder	Integer	false	Order of the Floor.
moduleOrder	Integer	false	Order of the Module (ModuleRack).
propertyRoomTypeId	Integer	false	Id of the PropertyRoomType.
propertyRoomSubTypeId	Integer	false	Id of the PropertyRoomSubType.
status	Integer	false	StatusType of the Module (ModuleRack).
situation	String	false	SituationType of the Module (ModuleRack).
moduleLockId	Integer	false	Id of the ModuleLock.
reservationId	Integer	false	Id of the Reservation.
reservationRoomStayId	Integer	false	Id of the ReservationRoomStay.
adultsCheckin	Integer	false	Number of adults doing checkin today.
adultsInHouse	Integer	false	Number of adults In House.
checkin	Boolean	false	The Reservation must do the checkin today in this Module.
checkout	Boolean	false	The Reservation must do the checkout today in this Module.
assembly	Boolean	false	There's an assembly in the room/module.
propertyRoomFeatureTypeIdList	Array of Integer	false	Array of ID's of all the PropertyRoomFeatureType's
propertyRoomFeatureTypeList	Array of PropertyRoomFeatureType	false	Array of objects of type PropertyRoomFeatureType.
hasIssue	Boolean	false	There's an issue or not in the module.

Example response

[{
	"moduleId": 1,
	"code": "101",
	"name": null,
	"floorCode": "1",
	"floorName": "Floor 1",
	"floorOrder": 1,
	"moduleOrder": 0,
	"propertyRoomTypeId": 2,
	"propertyRoomSubTypeId": 14,
	"status": 1,
	"situation": "O",
	"moduleLockId": null,
	"reservationId": 685,
	"reservationRoomStayId": 865,
	"adultsCheckin": null,
	"adultsInhouse": 1,
	"checkin": false,
	"checkout": false,
	"assembly": false,
	"propertyRoomFeatureTypeIdList": [2, 8, 14, 20, 26, 32, 38, 44, 50, 56, 62, 68, 74, 80, 86, 92, 98, 104, 110, 116, 122, 128, 134, 140, 146, 152, 158, 164, 170, 176, 182],
	"propertyRoomFeatureTypeList": null,
	"hasIssue": true
}, {
	"moduleId": 2,
	"code": "102",
	"name": null,
	"floorCode": "1",
	"floorName": "Floor 1",
	"floorOrder": 1,
	"moduleOrder": 0,
	"propertyRoomTypeId": 14,
	"propertyRoomSubTypeId": 8,
	"status": 2,
	"situation": "O",
	"moduleLockId": null,
	"reservationId": 669,
	"reservationRoomStayId": 847,
	"adultsCheckin": null,
	"adultsInhouse": 1,
	"checkin": false,
	"checkout": false,
	"assembly": true,
	"propertyRoomFeatureTypeIdList": [2, 8, 14, 20, 26, 32, 38, 44, 50, 56, 62, 68, 74, 80, 86, 92, 98, 104, 110, 116, 122, 128, 134, 140, 146, 152, 158, 164, 170, 176, 182],
	"propertyRoomFeatureTypeList": null,
	"hasIssue": false
}, {
	"moduleId": 3,
	"code": "103",
	"name": null,
	"floorCode": "1",
	"floorName": "Floor 1",
	"floorOrder": 1,
	"moduleOrder": 0,
	"propertyRoomTypeId": 26,
	"propertyRoomSubTypeId": 2,
	"status": 2,
	"situation": "O",
	"moduleLockId": null,
	"reservationId": 680,
	"reservationRoomStayId": 860,
	"adultsCheckin": null,
	"adultsInhouse": 1,
	"checkin": false,
	"checkout": true,
	"assembly": true,
	"propertyRoomFeatureTypeIdList": [2, 8, 14, 20, 26, 32, 38, 44, 50, 56, 62, 68, 74, 80, 86, 92, 98, 104, 110, 116, 122, 128, 134, 140, 146, 152, 158, 164, 170, 176, 182],
	"propertyRoomFeatureTypeList": null,
	"hasIssue": false
}]