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://prodpublicapi-providers.ulysescloud.com/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
{
	"idReservationRoomStayid": 111766,
	"reservationStatusType": {
		"id": 41,
		"code": "COMRES",
		"name": "CommittedReserved",
	},
	"reservationSituationTypenameI18n": { 		"idReserved": 2,
		"codecolorCode": "CO#43a047"
	},
		"namearrival": "CheckOut"
	},
	"arrival": "2019-04-202021-08-01",
	"departure": "20192021-0408-2102",
	"arrivalTime": null,
	"departureTime": null,
	"quantity": 1,
	"accommodation": {
		"id": 24707,
		"name": "Double",
	},
	"adultroomType": 2,{
			"juniorid": 017,
			"childname": 0"Double",
			"infantnameI18n": 0"Double",
			"productFeemainImage": {"1/2/propertyroomtypeimages/6e8184e4-ecc6-4d86-a56d-24d3776688df.jpg"
		"id": 24}
	},
		"nameroom": "Double"
	}null,
	"adultFeeadult": 2,
	"juniorFeejunior": 0,
	"childFeechild": 0,
	"infantFeeinfant": 0,
	"pmsLocatoraccommodationAmount": "0000000001/1"null,
	"crsLocatorboardAmount": null,
	"otaLocatorserviceAmount": null,
	"cmLocatortotalAmount": null,
	"remarkproductFee": null,{
		"mainProductBoardid": null812,
		"reservationRoomStayGuestsname": [{ "City Tax Barcelona"
	},
		"idpmsLocator": 1"ALI00006915/11766",
			"documentTypecrsLocator": {null,
				"idotaLocator": 2null,
				"codecmLocator": null,
	"2remark": null,
		"reservationRoomStayGuests": [{
		"nameid": 22045,
		"PassportdocumentType": 			}null,
			"documentNumber": "MNZLDtSw"null,
			"givenName": "Jeremytest",
			"middleNamesurName": "Stéphanietest",
			"surNamesecondSurName": "Gardner"null,
			"genderType": {null,
				"idbirthDate": 2null,
		"birthCountryCode": null,
		"createdDatebirthPlace": null,
				"modifiedDateeffectiveDate": null,
				"createdUserexpireDate": null,
				"modifiedUserstreet": null,
				"codecity": "F"null,
				"namestateProvName": null,
		"FemalestateProvCode": 			}null,
			"birthDatecountryCode": ["ES",
				2001"postalCode": null,
				4"nationalityCountryCode": null,
				30
			]"countryOfIssuanceCode": null,
			"birthCountryocr": {null,
				"idemail": 231null,
				"codephoneNumber": "VEN"null,
				"nameallowMarketing": "VENEZUELA"null,
			}"allowThirdParty": null,
			"birthPlacelanguage": "Waterbury",{
			"effectiveDateid": [1,
				2018"code": "ES",
				4"name": "Spanish",
				30"nameI18n": "Spanish"
		}
	}],
			"expireDatemainBoard": [{
				2018,
				4,
				30
			],
			"street"id": "03 Rusk Park"5,
			"citycode": "WaterburyRO",
			"stateProvNamename": "ConnecticutRoom Only",
			"stateProvserviceList": null
	},
			"countryreservationRoomStayDaily": [{
				"id": 23156374,
				"codedate": "VEN2021-08-01",
				"nameroom": "VENEZUELA"
			}null,
			"postalCodeallotment": "6726"null,
			"nationalityCountryrate": {null,
				"idamountBeforeTax": 2310.000000,
				"codeamountAfterTax": "VEN"0.000000,
				"nameamountNetAfterTax": "VENEZUELA"
			}0.000000,
			"ocramountNetBeforeTax": null0.000000,
			"emailamountInvoiceAfterTax": "phill8m@usnews0.com"000000,
			"phoneNumberamountInvoiceBeforeTax": "1-(203)205-9014"
		},
		{0.000000,
			"idaccommodationAmount": 20.000000,
			"documentTypeaccommodationAmountAfterDiscount": {0.000000,
				"idaccommodationAmountAfterTax": 20.000000,
				"codeaccommodationAmountBeforeTax": "2"0.000000,
				"nameaccommodationAmountNetAfterTax": "Passport"
			}0.000000,
			"documentNumberaccommodationAmountNetBeforeTax": "aohhZTZj"0.000000,
			"givenNameaccommodationAmountInvoiceAfterTax": "Gregory"0.000000,
			"middleNameaccommodationAmountInvoiceBeforeTax": "Marie-françoise"0.000000,
			"surNamecentralAccommodationPercentageCommission": "Owens"null,
			"genderTypecentralAccommodationAmountCommission": {null,
				"idcentralBoardPercentageCommission": 2null,
				"createdDatecentralBoardAmountCommission": null,
				"modifiedDatecompanyAccommodationPercentageCommission": null,
				"createdUsercompanyAccommodationAmountCommission": null,
				"modifiedUsercompanyBoardPercentageCommission": null,
				"codecompanyBoardAmountCommission": "F"null,
				"namebookerAccommodationPercentageCommission": "Female"
			}null,
			"birthDatebookerAccommodationAmountCommission": [null,
				2001,
				4"bookerBoardPercentageCommission": null,
				30
			]"bookerBoardAmountCommission": null,
			"birthCountrybillToAccommodationPercentageCommission": {null,
				"idbillToAccommodationAmountCommission": 102null,
				"codebillToBoardPercentageCommission": null,
		"IRQbillToBoardAmountCommission": null,
		"billToAccommodationPercentageDiscount": null,
		"namebillToAccommodationAmountDiscount": null,
		"IRAQbillToBoardPercentageDiscount": 			}null,
			"birthPlacebillToBoardAmountDiscount": "Kansas City"null,
			"effectiveDatecurrency": [{
				2018"id": 1,
				4"code": "EUR",
				30
			]"name": "Euro",
			"expireDatenameI18n": ["Euro",
				2018"symbol": "€",
				4,
				30"decimalPlaces": 2
			]},
			"streetoffer": "47 Dexter Place",
	null,
		"offerAmountDiscount": null,
		"cityofferPercentDiscount": null,
		"promotion"Kansas: City"null,
			"stateProvNamepromotionAmountDiscount": "Missouri"null,
			"stateProvpromotionPercentDiscount": null,
			"countryboard": {
				"id": 1025,
				"code": "IRQRO",
				"name": "IRAQ"
			}Room Only",
			"postalCodeserviceList": "64199"null
		},
			"nationalityCountryboardAmountAfterDiscountAdult": {
		0.000000,
		"idboardAmountAdult": 1020.000000,
				"codeboardAmountAfterTaxAdult": "IRQ"0.000000,
				"nameboardAmountBeforeTaxAdult": "IRAQ"
			}0.000000,
			"ocrboardAmountNetAfterTaxAdult": null0.000000,
			"emailboardAmountNetBeforeTaxAdult": "jmartinezp7@bigcartel0.com"000000,
			"phoneNumberboardAmountInvoiceAfterTaxAdult": "1-(816)452-4459"0.000000,
		}
	]"boardAmountInvoiceBeforeTaxAdult": 0.000000,
		"reservationRoomStayDailyboardAmountAfterDiscountJunior": [{0.000000,
		"dateboardAmountJunior": "2019-04-20"0.000000,
		"allotmentboardAmountAfterTaxJunior": null0.000000,
		"rateboardAmountBeforeTaxJunior": {0.000000,
			"idboardAmountNetAfterTaxJunior": 10.000000,
			"codeboardAmountNetBeforeTaxJunior": "BAR"0.000000,
			"nameboardAmountInvoiceAfterTaxJunior": "Best Rate Available"
		}0.000000,
		"priceboardAmountInvoiceBeforeTaxJunior": 1460.000000,
		"currencyboardAmountAfterDiscountChild": {0.000000,
			"codeboardAmountChild": "EUR",
	0.000000,
		"nameboardAmountAfterTaxChild": "Euro"
		}0.000000,
		"offerboardAmountBeforeTaxChild": null0.000000,
		"offerAmountDiscountboardAmountNetAfterTaxChild": null0.000000,
		"offerPercentDiscountboardAmountNetBeforeTaxChild": null0.000000,
		"promotionboardAmountInvoiceAfterTaxChild": null0.000000,
		"promotionAmountDiscountboardAmountInvoiceBeforeTaxChild": null0.000000,
		"promotionPercentDiscountboardAmountAfterDiscountInfant": null0.000000,
		"productBoardboardAmountInfant": null0.000000,
		"boardPriceAdultboardAmountAfterTaxInfant": null0.000000,
		"boardPriceJuniorboardAmountBeforeTaxInfant": null0.000000,
		"boardPriceChildboardAmountNetAfterTaxInfant": null0.000000,
		"boardPriceInfantboardAmountNetBeforeTaxInfant": null0.000000,
		"paymentTypeboardAmountInvoiceAfterTaxInfant": {0.000000,
			"codeboardAmountInvoiceBeforeTaxInfant": "GG"0.000000,
			"namepaymentType": "Pay Guest Guest"
		},
{
			"propertyPolicyid": {1,
			"idcode": 57"G",
			"codename": "24HPay Guest",
			"namenameI18n": "24 Hours Before ArrivalPay Guest"
		},
		"propertySourcepropertyPolicy": {
			"id": 1312,
			"code": "COM24H",
			"name": "Company24 Hours 1 Night"
		},
		"propertySegmentpropertySource": {
			"id": 2413,
			"code": "HACCPHO",
			"name": "Home AccountPhone"
		},
		"propertyChannelpropertySegment": {
			"id": 2419,
			"code": "IDSHACC",
			"name": "IDSHome Account"
		},
		"postingDatepropertyChannel": "2019-04-30{
			"id": 11,
			"code": "WEB",
			"name": "Booking Engine"
	}]	},
		"booker": null,
		"reservationRoomStayServiceList": nullbillTo": 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",
	"deposit": {
    	"productPayment" : {
	        "code" : "VI"
	    },
	    "amount" : 100,
	    "productDeposit" : {
	        "code" : "DEPRE"
	    },
	    "chargeId":"ch_3MA9wDGjGBQ6ROtO0Rm9mtudss"
	},
	"reservationType" : {
   		"id": 2,
        "chainId": 1,
        "propertyId": 2,
        "code": "PREVIEW",
        "name": "Pending Review",
        "colorCode": "#FDD835",
        "active": true
	}
}