List of Room with ReservationRoomStay[GET]

Operation

A list of Room from the Property with the current assigned ReservationRoomStay

GET

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

Request

Property	Type	Required	Type parameter	Default value	Description
chainId	Integer	true	path parameter		Unique identificator of the chain.
propertyId	Integer	true	path parameter		Unique identificator of the property.

Example request

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

Response

Property	Type	Required	Description
List of Room	List	true

Entity

Field	Type	Required	Description
id	Integer	true	Unique identificator of the Room.
code	string	true	Code of the Room
name	string	true	Name of the Room
startDate	LocalDate	false	Start date of Room
endDate	LocalDate	false	End date of Room
description	string	false	Description of Room.
descriptionI18n	string	false	Description of Room in I18n.
roomSituationType	RoomSituationType	true	Situation of the Room (see ref. table).
roomSpaceStatusType	RoomSpaceStatusType	false	Status of the inner Space.
reservationRoomStay	ReservationRoomStay	false	Related stay that has this Room assigned.
reservationRoomStaySummary	ReservationRoomStaySummary	false	Related stay summary that has this room assigned. Only show if have data.
spaceLock	SpaceLock	false	Space lock. Only show if have data.
roomType	RoomType	false	Room Type. Only show if have data.

Example response

[{
	"id": 9,
	"code": "109",
	"name": "109",
    "startDate": "2023-09-23",
    "endDate": "2024-09-23",
    "description": "Room 101, at first floor.",
    "descriptionI18n": "Room 101, at first floor.",
	"roomSpaceStatusType": {
		"id": 1,
		"code": "CL",
		"name": "Clean"
	},
	"roomSituationType": {
      "id": 3,
      "code": "BL",
      "name": "Blocked"
    },
	"reservationRoomStay": {
		"id": 20,
		"reservationStatusType": {
			"id": 4,
			"code": "IH",
			"name": "InHouse"
		},
		"arrival": "2020-01-18",
		"departure": "2020-01-19",
		"arrivalTime": null,
		"departureTime": null,
		"quantity": 1,
		"accommodation": {
			"id": 632,
			"name": "Single"
		},
		"room": null,
		"adult": 1,
		"junior": 0,
		"child": 0,
		"infant": 0,
		"productFee": {
			"id": 767,
			"name": "City Tax Barcelona"
		},
		"adultFee": 0,
		"juniorFee": 0,
		"childFee": 0,
		"infantFee": 0,
		"pmsLocator": "ALI00000020/25",
		"crsLocator": null,
		"otaLocator": null,
		"cmLocator": null,
		"remark": null,
		"mainBoard": {
			"id": 6,
			"code": null,
			"name": "Bed And Breakfast",
			"serviceList": [{
				"id": 61,
				"name": "Breakfast"
			}]
		},
		"reservationRoomStayGuests": [{
			"id": 35,
			"documentType": {
				"id": 2,
				"code": "2",
				"name": "Passport"
			},
			"documentNumber": "cagdROWL",
			"givenName": "Gregory",
			"secondSurName": "Bénédicte",
			"surName": "Ferguson",
			"genderType": {
				"id": 1,
				"code": "M",
				"name": "Male"
			},
			"birthDate": "2002-02-13",
			"birthCountryCode": "CF",
			"birthPlace": "Van Nuys",
			"effectiveDate": "2019-02-13",
			"expireDate": "2019-02-13",
			"street": "9417 Buena Vista Terrace",
			"city": "Van Nuys",
			"stateProvName": "California",
			"stateProvCode": null,
			"countryCode": "CF",
			"postalCode": "91411",
			"nationalityCountryCode": "CF",
			"ocr": null,
			"email": "alongf4@seesaa.net",
			"phoneNumber": "1-(661)969-2605"
		}],
		"reservationRoomStayDaily": [{
			"id": 65,
			"date": "2020-01-18",
			"room": null,
			"allotment": null,
			"rate": {
				"id": 1,
				"code": "BAR",
				"name": "Best Available Rate"
			},
			"amountAfterTax": 124.200000,
			"currency": {
				"id": 1,
				"code": "EUR",
				"name": "Euro"
			},
			"offer": {
				"id": 1,
				"code": "NR",
				"name": "Non Refundable"
			},
			"offerAmountDiscount": 0.000000,
			"offerPercentDiscount": 10.000000,
			"promotion": null,
			"promotionAmountDiscount": null,
			"promotionPercentDiscount": null,
			"board": {
				"id": 6,
				"code": null,
				"name": "Bed And Breakfast",
				"serviceList": [{
					"id": 61,
					"name": "Breakfast"
				}]
			},
			"boardPriceAdult": 22.000000,
			"boardPriceJunior": 49.000000,
			"boardPriceChild": 0.000000,
			"boardPriceInfant": 0.000000,
			"paymentType": {
				"id": 1,
				"code": "G",
				"name": "Pay Guest"
			},
			"propertyPolicy": {
				"id": 7,
				"code": "NR",
				"name": "Non Refundable"
			},
			"propertySource": {
				"id": 12,
				"code": "EMA",
				"name": "Email"
			},
			"propertySegment": {
				"id": 25,
				"code": "CAGE",
				"name": "Company Agent"
			},
			"propertyChannel": {
				"id": 8,
				"code": "GDS",
				"name": "GDS"
			},
			"booker": null,
			"billTo": {
				"id": 121,
				"name": "Jaxnation",
				"code": null,
				"taxId": "78230110",
				"iataId": null,
				"companyEmailList": [{
					"id": 121,
					"primary": true,
					"emailAddressType": {
						"id": 1,
						"code": "1",
						"name": "Personal"
					},
					"email": "wpeters31@ning.com",
					"remark": null
				}],
				"companyAddressList": [{
					"id": 121,
					"primary": true,
					"communicationLocationType": {
						"id": 1,
						"code": "1",
						"name": "Home"
					},
					"street": "29 Farmco Drive",
					"city": "San Antonio",
					"stateProvName": "Pontevedra",
					"stateProvCode": "ES-PO",
					"postalCode": "78230",
					"countryCode": "ES",
					"remark": "Address Remark"
				}],
				"companyPhoneList": [{
					"id": 121,
					"primary": true,
					"phoneLocationType": {
						"id": 6,
						"code": "6",
						"name": "Home"
					},
					"phoneTechType": {
						"id": 1,
						"code": "1",
						"name": "Voice"
					},
					"countryAccessCode": "+34",
					"areaCityCode": "B",
					"phoneNumber": "1-(830)708-5101",
					"extension": "1",
					"remark": "Phone Remark"
				}],
				"companyTaxAddress": {
					"id": 111,
					"communicationLocationType": null,
					"street": "29 Farmco Drive",
					"city": "San Antonio",
					"stateProvName": "Zamora",
					"stateProvCode": "ES-ZA",
					"postalCode": "78230",
					"countryCode": "ES",
					"remark": "Address Remark"
				},
				"remark": "Company Remarks"
			},
			"central": null,
			"company": {
				"id": 997,
				"name": "Oozz",
				"code": null,
				"taxId": "87110986",
				"iataId": null,
				"companyEmailList": [{
					"id": 997,
					"primary": true,
					"emailAddressType": {
						"id": 1,
						"code": "1",
						"name": "Personal"
					},
					"email": "ldayrd@phpbb.com",
					"remark": null
				}],
				"companyAddressList": [{
					"id": 997,
					"primary": true,
					"communicationLocationType": {
						"id": 1,
						"code": "1",
						"name": "Home"
					},
					"street": "8581 Delladonna Trail",
					"city": "Albuquerque",
					"stateProvName": "Albacete",
					"stateProvCode": "ES-AB",
					"postalCode": "87110",
					"countryCode": "ES",
					"remark": "Address Remark"
				}],
				"companyPhoneList": [{
					"id": 997,
					"primary": true,
					"phoneLocationType": {
						"id": 6,
						"code": "6",
						"name": "Home"
					},
					"phoneTechType": {
						"id": 1,
						"code": "1",
						"name": "Voice"
					},
					"countryAccessCode": "+34",
					"areaCityCode": "B",
					"phoneNumber": "1-(505)216-1400",
					"extension": "1",
					"remark": "Phone Remark"
				}],
				"companyTaxAddress": {
					"id": 987,
					"communicationLocationType": null,
					"street": "8581 Delladonna Trail",
					"city": "Albuquerque",
					"stateProvName": "Barcelona",
					"stateProvCode": "ES-B",
					"postalCode": "87110",
					"countryCode": "ES",
					"remark": "Address Remark"
				},
				"remark": "Company Remarks"
			}
		}],
		"reservationRoomStayServiceList": [{
				"id": 27,
				"service": {
					"id": 74,
					"name": "Parking"
				},
				"startDate": "2020-01-18",
				"endDate": "2020-01-19",
				"quantity": 1,
				"reservationRoomStayServiceDailyList": [{
					"id": 72,
					"date": "2020-01-18",
					"rate": null,
					"amountAfterTax": 10.000000,
					"currency": {
						"id": 1,
						"code": "EUR",
						"name": "Euro"
					},
					"offer": null,
					"offerAmountDiscount": null,
					"offerPercentDiscount": null,
					"promotion": null,
					"promotionAmountDiscount": null,
					"promotionPercentDiscount": null,
					"postingDate": "2020-02-13"
				}]
			},
			{
				"id": 28,
				"service": {
					"id": 74,
					"name": "Parking"
				},
				"startDate": "2020-01-18",
				"endDate": "2020-01-19",
				"quantity": 1,
				"reservationRoomStayServiceDailyList": [{
					"id": 73,
					"date": "2020-01-18",
					"rate": null,
					"amountAfterTax": 10.000000,
					"currency": {
						"id": 1,
						"code": "EUR",
						"name": "Euro"
					},
					"offer": null,
					"offerAmountDiscount": null,
					"offerPercentDiscount": null,
					"promotion": null,
					"promotionAmountDiscount": null,
					"promotionPercentDiscount": null,
					"postingDate": "2020-02-13"
				}]
			}
		]
	}
}]

UlysesCloud Open API