[GET] List Room
Operation
Returns a list of all the Room by chain and property.
GET
http://{urlName}/tesiproPMS/api/{version}/chain/{chainId}/property/{propertyId}/room
Request
Property | Type | Required | Default value | Description |
---|---|---|---|---|
chainId | Integer | true | The id of the chain. This parameter will be in the URL. Path parameter. | |
propertyId | Integer | true | The id of the property. This parameter will be in the URL. Path parameter. | |
roomTypeIdList | Integer Array | false | Filter by roomType. | |
roomSubTypeIdList | Integer Array | false | Filter by roomSubType. | |
roomFeatureIdList | Integer Array | false | Filter by roomFeature. | |
search | String | false | Search text | |
offset | Integer | false | 0 | The offset of the list of results |
limit | Integer | false | 10 | The limit amount of the list of results |
sort | String | false | Id | Field of Module to sort by. |
sortMode | String | false | Asc | Mode of sorting: asc, desc.. |
Example request
GET http://81.184.0.161:9696/tesiproPMS/api/v1/chain/1/property/2/room
Response
Property | Type | Required | Description |
---|---|---|---|
Page | Page | true | Response |
Example response
{ "count": 2, "offset": 0, "limit": 10, "list": [{ "id": 1, "createdDate": "2018-08-03T13:51:41.730Z", "modifiedDate": "2018-08-06T10:24:21.680Z", "createdUser": 0, "modifiedUser": 1, "code": "101", "name": "R101", "propertyRoomTypeRoomSubType": { "id": 8, "createdDate": "2018-08-03T13:51:41.353Z", "modifiedDate": "2018-08-03T13:51:41.357Z", "createdUser": 0, "modifiedUser": 0, "propertyRoomType": { "id": 26, "createdDate": "2018-08-03T13:50:38.297Z", "modifiedDate": "2018-08-03T13:50:38.307Z", "createdUser": 0, "modifiedUser": 0, "property": null, "chainRoomType": null, "name": "Junior Suite", "propertyRoomTypeRoomSubTypeSet": null }, "propertyRoomSubType": { "id": 2, "createdDate": "2018-08-03T13:50:38.423Z", "modifiedDate": "2018-08-03T13:50:38.437Z", "createdUser": 0, "modifiedUser": 0, "property": null, "chainRoomSubType": null, "name": "RunOfTheHouse", "propertyRoomTypeRoomSubTypeSet": null }, "roomSet": null, "propertyBookingForecastSet": null, "propertyRoomTypeRoomSubTypeInventorySet": null }, "moduleStatusId": 2, "moduleStatusName": "Dirty", "moduleStatusColorCode": "#f44336", "moduleFloorCode": "1", "moduleFloorName": "Floor 1", "moduleFloorOrder": 1, "roomFeatureTypeSet": [{ "id": 11, "createdDate": "2018-08-03T13:51:41.753Z", "modifiedDate": "2018-08-03T13:51:41.757Z", "createdUser": 0, "modifiedUser": 0, "propertyRoomFeatureType": { "id": 20, "createdDate": "2018-08-03T13:50:38.690Z", "modifiedDate": "2018-08-03T13:50:38.700Z", "createdUser": 0, "modifiedUser": 0, "name": "Packed lunches" } }, { "id": 21, "createdDate": "2018-08-03T13:51:41.767Z", "modifiedDate": "2018-08-03T13:51:41.770Z", "createdUser": 0, "modifiedUser": 0, "propertyRoomFeatureType": { "id": 8, "createdDate": "2018-08-03T13:50:38.643Z", "modifiedDate": "2018-08-03T13:50:38.653Z", "createdUser": 0, "modifiedUser": 0, "name": "Heating" } } ], "reservationRoomStayAssignDailySet": null, "hasIssue": true }, { "id": 2, "createdDate": "2018-08-03T13:51:41.907Z", "modifiedDate": "2018-08-04T18:53:33.487Z", "createdUser": 0, "modifiedUser": 14, "code": "102", "name": "R102", "propertyRoomTypeRoomSubType": { "id": 2, "createdDate": "2018-08-03T13:51:40.703Z", "modifiedDate": "2018-08-03T13:51:40.710Z", "createdUser": 0, "modifiedUser": 0, "propertyRoomType": { "id": 2, "createdDate": "2018-08-03T13:50:38.143Z", "modifiedDate": "2018-08-03T13:50:38.153Z", "createdUser": 0, "modifiedUser": 0, "property": null, "chainRoomType": null, "name": "Single", "propertyRoomTypeRoomSubTypeSet": null }, "propertyRoomSubType": { "id": 14, "createdDate": "2018-08-03T13:50:38.470Z", "modifiedDate": "2018-08-03T13:50:38.483Z", "createdUser": 0, "modifiedUser": 0, "property": null, "chainRoomSubType": null, "name": "Deluxe", "propertyRoomTypeRoomSubTypeSet": null }, "roomSet": null, "propertyBookingForecastSet": null, "propertyRoomTypeRoomSubTypeInventorySet": null }, "moduleStatusId": 2, "moduleStatusName": "Dirty", "moduleStatusColorCode": "#f44336", "moduleFloorCode": "1", "moduleFloorName": "Floor 1", "moduleFloorOrder": 1, "roomFeatureTypeSet": [{ "id": 55, "createdDate": "2018-08-03T13:51:41.933Z", "modifiedDate": "2018-08-03T13:51:41.937Z", "createdUser": 0, "modifiedUser": 0, "propertyRoomFeatureType": { "id": 26, "createdDate": "2018-08-03T13:50:38.710Z", "modifiedDate": "2018-08-03T13:50:38.723Z", "createdUser": 0, "modifiedUser": 0, "name": "Soundproof rooms" } }, { "id": 60, "createdDate": "2018-08-03T13:51:41.937Z", "modifiedDate": "2018-08-03T13:51:41.940Z", "createdUser": 0, "modifiedUser": 0, "propertyRoomFeatureType": { "id": 98, "createdDate": "2018-08-03T13:50:39.010Z", "modifiedDate": "2018-08-03T13:50:39.023Z", "createdUser": 0, "modifiedUser": 0, "name": "Tour desk" } } ], "reservationRoomStayAssignDailySet": null, "hasIssue": false } ] }