Room Type Listing

The Room Type Listing call is used to retrieve the list of Room Types created for existing property. By using this call, PMS will be able to fetch details on the property's existing room types and details related to the room types such as, Name, Type, Min/Max. Occupancy, Status, and Size.

Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/roomdetails

Attributes

hotelid string (Required)

Hotel id for which you want to retrieve the list of Room Types created for the property.

Maximum 20 characters allowed.

Sample Request

{
   "hotelid": "new1"
}

Response

Response Model — No Rooms Found

In this case there is no Room Type available for the provider based on the request parameters.

Sample Error Response (938)

{
  "Status": "Fail",
  "Errors": {
    "Code": "938",
    "ShortText": "No rooms found"
  }
}

Success

rooms array

rooms array contains all the room in the listing an all the required details for the rooms such as room name, id, occupancy, quantity, and the status of the room.


roomid string

The room ID / Listing ID as assigned by the provider.


roomname string

Name of the room.


roomtype string

Type of the room.


maximumoccupancy string

Maximum occupancy allowed in the room.


status string

Status of the room.


quantity string

Quantity of the room available in the property.


sizemeasurement string

Size of the room.


sizemeasurementunit string

Units which are used to measure the room.


rate string

Rate for the room.

Sample Success Response

{
	"rooms": [{
		"roomid": "STD",
		"roomname": "Superior Room with Balcony",
		"roomtype": "Double",
		"maximumoccupancy": "2",
		"status": "Active",
		"quantity": "8",
		"sizemeasurement": "20",
		"sizemeasurementunit": "sqm",
		"rate": "200"
	}, {
		"roomid": "KNG",
		"roomname": "Twin Room",
		"roomtype": "Twin",
		"maximumoccupancy": "4",
		"status": "Active",
		"quantity": "4",
		"sizemeasurement": "20",
		"sizemeasurementunit": "sqm",
		"rate": "200"
	}]
}

Error

Errors 400 due to invalid parameters

This error will be received if allocated with incorrect Hotel/Client id.

Sample Error Response (400)

{
  "Status": "Fail",
  "Errors": {
    "Code": "400",
    "ShortText": "Invalid HotelCode (ne1)"
  }
}

Last updated

Was this helpful?