Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Get a single element of ReservationRoomStay by its id

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.reservation


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

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



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdStringtruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
reservationRoomStayIdIntegertruepath parameter
Unique identificator of the reservationRoomStay.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationRoomStay/1



Response

The response is an entity of type ReservationRoomStay or an error if it's not found.

Entity

Insert excerpt
ReservationRoomStay
ReservationRoomStay
nopaneltrue


Example response

Code Block
themeDJango
{
	"id": 11766,
	"reservationStatusType": {
		"id": 1,
		"code": "RES",
		"name": "Reserved",
		"nameI18n": "Reserved",
		"colorCode": "#43a047"
	},
	"arrival": "2021-08-01",
	"departure": "2021-08-02",
	"arrivalTime": null,
	"departureTime": null,
	"quantity": 1,
	"accommodation": {
		"id": 707,
		"name": "Double",
		"roomType": {
			"id": 17,
			"name": "Double",
			"nameI18n": "Double",
			"mainImage": "1/2/propertyroomtypeimages/6e8184e4-ecc6-4d86-a56d-24d3776688df.jpg"
		}
	},
	"room": null,
	"adult": 2,
	"junior": 0,
	"child": 0,
	"infant": 0,
	"accommodationAmount": null,
	"boardAmount": null,
	"serviceAmount": null,
	"totalAmount": null,
	"productFee": {
		"id": 812,
		"name": "City Tax Barcelona"
	},
	"pmsLocator": "ALI00006915/11766",
	"crsLocator": null,
	"otaLocator": null,
	"cmLocator": null,
	"remark": null,
	"reservationRoomStayGuests": [{
		"id": 22045,
		"documentType": null,
		"documentNumber": null,
		"givenName": "test",
		"surName": "test",
		"secondSurName": null,
		"genderType": null,
		"birthDate": null,
		"birthCountryCode": null,
		"birthPlace": null,
		"effectiveDate": null,
		"expireDate": null,
		"street": null,
		"city": null,
		"stateProvName": null,
		"stateProvCode": null,
		"countryCode": "ES",
		"postalCode": null,
		"nationalityCountryCode": null,
		"countryOfIssuanceCode": null,
		"ocr": null,
		"email": null,
		"phoneNumber": null,
		"allowMarketing": null,
		"allowThirdParty": null,
		"language": {
			"id": 1,
			"code": "ES",
			"name": "Spanish",
			"nameI18n": "Spanish"
		}
	}],
	"mainBoard": {
		"id": 5,
		"code": "RO",
		"name": "Room Only",
		"serviceList": null
	},
	"reservationRoomStayDaily": [{
		"id": 56374,
		"date": "2021-08-01",
		"room": null,
		"allotment": null,
		"rate": null,
		"amountBeforeTax": 0.000000,
		"amountAfterTax": 0.000000,
		"amountNetAfterTax": 0.000000,
		"amountNetBeforeTax": 0.000000,
		"amountInvoiceAfterTax": 0.000000,
		"amountInvoiceBeforeTax": 0.000000,
		"accommodationAmount": 0.000000,
		"accommodationAmountAfterDiscount": 0.000000,
		"accommodationAmountAfterTax": 0.000000,
		"accommodationAmountBeforeTax": 0.000000,
		"accommodationAmountNetAfterTax": 0.000000,
		"accommodationAmountNetBeforeTax": 0.000000,
		"accommodationAmountInvoiceAfterTax": 0.000000,
		"accommodationAmountInvoiceBeforeTax": 0.000000,
		"centralAccommodationPercentageCommission": null,
		"centralAccommodationAmountCommission": null,
		"centralBoardPercentageCommission": null,
		"centralBoardAmountCommission": null,
		"companyAccommodationPercentageCommission": null,
		"companyAccommodationAmountCommission": null,
		"companyBoardPercentageCommission": null,
		"companyBoardAmountCommission": null,
		"bookerAccommodationPercentageCommission": null,
		"bookerAccommodationAmountCommission": null,
		"bookerBoardPercentageCommission": null,
		"bookerBoardAmountCommission": null,
		"billToAccommodationPercentageCommission": null,
		"billToAccommodationAmountCommission": null,
		"billToBoardPercentageCommission": null,
		"billToBoardAmountCommission": null,
		"billToAccommodationPercentageDiscount": null,
		"billToAccommodationAmountDiscount": null,
		"billToBoardPercentageDiscount": null,
		"billToBoardAmountDiscount": null,
		"currency": {
			"id": 1,
			"code": "EUR",
			"name": "Euro",
			"nameI18n": "Euro",
			"symbol": "€",
			"decimalPlaces": 2
		},
		"offer": null,
		"offerAmountDiscount": null,
		"offerPercentDiscount": null,
		"promotion": null,
		"promotionAmountDiscount": null,
		"promotionPercentDiscount": null,
		"board": {
			"id": 5,
			"code": "RO",
			"name": "Room Only",
			"serviceList": null
		},
		"boardAmountAfterDiscountAdult": 0.000000,
		"boardAmountAdult": 0.000000,
		"boardAmountAfterTaxAdult": 0.000000,
		"boardAmountBeforeTaxAdult": 0.000000,
		"boardAmountNetAfterTaxAdult": 0.000000,
		"boardAmountNetBeforeTaxAdult": 0.000000,
		"boardAmountInvoiceAfterTaxAdult": 0.000000,
		"boardAmountInvoiceBeforeTaxAdult": 0.000000,
		"boardAmountAfterDiscountJunior": 0.000000,
		"boardAmountJunior": 0.000000,
		"boardAmountAfterTaxJunior": 0.000000,
		"boardAmountBeforeTaxJunior": 0.000000,
		"boardAmountNetAfterTaxJunior": 0.000000,
		"boardAmountNetBeforeTaxJunior": 0.000000,
		"boardAmountInvoiceAfterTaxJunior": 0.000000,
		"boardAmountInvoiceBeforeTaxJunior": 0.000000,
		"boardAmountAfterDiscountChild": 0.000000,
		"boardAmountChild": 0.000000,
		"boardAmountAfterTaxChild": 0.000000,
		"boardAmountBeforeTaxChild": 0.000000,
		"boardAmountNetAfterTaxChild": 0.000000,
		"boardAmountNetBeforeTaxChild": 0.000000,
		"boardAmountInvoiceAfterTaxChild": 0.000000,
		"boardAmountInvoiceBeforeTaxChild": 0.000000,
		"boardAmountAfterDiscountInfant": 0.000000,
		"boardAmountInfant": 0.000000,
		"boardAmountAfterTaxInfant": 0.000000,
		"boardAmountBeforeTaxInfant": 0.000000,
		"boardAmountNetAfterTaxInfant": 0.000000,
		"boardAmountNetBeforeTaxInfant": 0.000000,
		"boardAmountInvoiceAfterTaxInfant": 0.000000,
		"boardAmountInvoiceBeforeTaxInfant": 0.000000,
		"paymentType": {
			"id": 1,
			"code": "G",
			"name": "Pay Guest",
			"nameI18n": "Pay Guest"
		},
		"propertyPolicy": {
			"id": 12,
			"code": "24H",
			"name": "24 Hours 1 Night"
		},
		"propertySource": {
			"id": 13,
			"code": "PHO",
			"name": "Phone"
		},
		"propertySegment": {
			"id": 19,
			"code": "HACC",
			"name": "Home Account"
		},
		"propertyChannel": {
			"id": 11,
			"code": "WEB",
			"name": "Booking Engine"
		},
		"booker": null,
		"billTo": null,
		"central": null,
		"company": null,
		"reservationGroup": null
	}],
	"reservationRoomStayServiceList": [{
		"id": 17477,
		"service": {
			"id": 64,
			"code": "COT",
			"name": "Cot"
		},
		"startDate": "2021-08-01",
		"endDate": "2021-08-05",
		"quantity": 7,
		"totalAmountAfterTax": 128.000000,
		"totalAmountBeforeTax": 160.000000,
		"reservationRoomStayServiceDailyList": [{
				"id": 83330,
				"date": "2021-08-04",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			},
			{
				"id": 83334,
				"date": "2021-08-03",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			},
			{
				"id": 83335,
				"date": "2021-08-02",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			},
			{
				"id": 83336,
				"date": "2021-08-01",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			}
		]
	}],
	"createdDate": "2021-06-24T15:54:16.890Z",
	"modifiedDate": "2021-06-24T16:32:29.219Z"
}