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
{
    	"id": 311766,
    	"reservationStatusType": {
        		"id": 51,
        		"code": "CORES",
		"name": "Reserved",
		"nameI18n":      "name"Reserved",
		"colorCode": "CheckedOut#43a047"
    	},
    	"arrival": "20192021-0608-2001",
    	"departure": "20192021-0608-2102",
    	"arrivalTime": null,
    	"departureTime": null,
    	"quantity": 1,
    	"accommodation": {
        		"id": 92707,
        		"name": "Family"
    },
    "adultDouble",
		"roomType": 1,
    "junior{
			"id": 017,
    "child			"name": 0"Double",
    "infant			"nameI18n": 0"Double",
    "productFee			"mainImage": {
        "id": 1,
        "name": "City Tax Barcelona"
    },
    "adultFee": 1,
    "juniorFee"1/2/propertyroomtypeimages/6e8184e4-ecc6-4d86-a56d-24d3776688df.jpg"
		}
	},
	"room": null,
	"adult": 2,
	"junior": 0,
	"child": 0,
    "childFee	"infant": 0,
    "infantFee	"accommodationAmount": 0null,
    "pmsLocator	"boardAmount": "XS0000000003/3",
    "crsLocatornull,
	"serviceAmount": null,
    "otaLocator	"totalAmount": null,
	"productFee": {
		"id": 812,
		"cmLocatorname": null,"City Tax Barcelona"
	},
 	"remarkpmsLocator": null"ALI00006915/11766",
    "mainProductBoard	"crsLocator": null,
    "reservationRoomStayGuests	"otaLocator": null,
	"cmLocator": [{
        "idnull,
	"remark": 6null,
        "documentType	"reservationRoomStayGuests": [{
            		"id": 522045,
		"documentType": null,
		"documentNumber": null,
		"givenName":        "code"test",
		"surName": "5test",
		"secondSurName": null,
		"genderType": null,
		"birthDate":        "namenull,
		"birthCountryCode": "National identity document"
        },
        "documentNumber": "cJlUaQaW",
        "givenName": "Martha",
        "middleName": "Mégane",
        "surName": "Peterson",
        "genderType": {
            "id": 2,
            "code": "F",
            "name": "Female"
        },
        "birthDate": "2001-07-18",
        "birthCountry": {
            "id": 199,
            "code": "ESP",
            "name": "SPAIN"
        },
        "birthPlace": "Chicago",
        "effectiveDate": "2018-07-18",
        "expireDate": "2018-07-18",
        "street": "9036 Lien Place",
        "city": "Chicago",
        "stateProvName": null,
        "stateProv": {
            "id": 24,
            "code": "ES-H",
            "name": "Huelva",
            "country": {
                "id": 199,
                "code": "ESP",
                "name": "SPAIN"
            }
        },
        "country": {
            "id": 199,
            "code": "ESP",
            "name": "SPAIN"
        },
        "postalCode": "60636",
        "nationalityCountry": {
            "id": 199,
            "code": "ESP",
            "name": "SPAIN"
        },
        "ocr": null,
        "email": "bbutler65@hao123.com",
        "phoneNumber": "1-(773)942-9428"
    }],
    "reservationRoomStayDaily": [{
        "id": 3,
        "date": "2019-06-20",
        "allotment": null,
        "rate": {
            "id": 2,
            "code": "BB",
            "name": "Bed And Breakfast"
        },
        "price": 248.800000,
        "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro"
        },
        "offer": {
            "id": 3,
            "code": "MIN7N",
            "name": "Minimum 7 nights"
        },
        "offerAmountDiscount": 0.000000,
        "offerPercentDiscount": 20.000000,
        "promotion": null,
        "promotionAmountDiscount": null,
        "promotionPercentDiscount": null,
        "productBoard": {
            "id": 167,
            "name": "FullBoard"
        },
        "boardPriceAdult": 20.000000,
        "boardPriceJunior": 15.000000,
        "boardPriceChild": null,
        "boardPriceInfant": null,
        "paymentType": {
            "id": 3,
            "code": "A",
            "name": "Pay Agency"
        },
        "propertyPolicy": {
            "id": 62,
            "code": "48H",
            "name": "48 Hours Before Arrival"
        },
        "propertySource": {
            "id": 62,
            "code": "EMA",
            "name": "Email"
        },
        "propertySegment": {
            "id": 107,
            "code": "DUSE",
            "name": "Day Use"
        },
        "propertyChannel": {
            "id": 17,
            "code": "GDS",
            "name": "GDS"
        },
        "booker": null,
        "billTo": {
            "id": 377,
            "name": "World 2 Meet"
        },
        "central": null,
        "company": {
            "id": 132,
            "name": "BestDay"
        }
    }],
    "reservationRoomStayServiceList": [{
        "id": 6,
        "service": {
            "id": 347,
            "name": "Meeting Room"
        },
        "startDate": "2019-06-20",
        "endDate": "2019-06-21",
        "quantity": 1,
        "reservationRoomStayServiceDailyList": [{
                "id": 11,
                "date": "2019-06-20",
                "rate": null,
                "price": 10.000000,
                "currency": {
                    "id": 1,
                    "code": "EUR",
                    "name": "Euro"
                },
                "offer": null,
                "offerAmountDiscount": null,
                "offerPercentDiscount": null,
                "promotion": null,
                "promotionAmountDiscount": null,
                "promotionPercentDiscount": null,
                "postingDate": null
            },
            {
                "id": 12,
                "date": "2019-06-21",
                "rate": null,
                "price": 10.000000,
                "currency": {
                    "id": 1,
                    "code": "EUR",
                    "name": "Euro"
                },
                "offer": null,
                "offerAmountDiscount": null,
                "offerPercentDiscount": null,
                "promotion": null,
                "promotionAmountDiscount": null,
                "promotionPercentDiscount": null,
                "postingDate": "2019-07-18"
            }
        ]
    }],
    "reservationRoomStayAssignDailyList": [{
        "id": 3,
        "date": "2019-06-20",
        "room": {
            "id": 6,
    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",
	"deposit": {
    	"productPayment" : {
	        "code" : "VI"
	    },
	    "amount" : 100,
	    "productDeposit" : {
	        "code" : "106DEPRE",
	    },
   	    "namechargeId": "R106",
        ch_3MA9wDGjGBQ6ROtO0Rm9mtudss"
	},
	"reservationType" : {
   		"roomModuleStatusTypeid": {2,
        "chainId": 1,
        "idpropertyId": 2,
       
        "code": "DIPREVIEW",
   
            "name": "DirtyPending Review",
        "colorCode": "#FDD835",
  }      "active":   }
    }]true
	}
}