Versions Compared

Key

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

Operation

Returns a paginated list of ReservationRoomStay

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/api/v1/chain/{chainId}/property/{propertyId}/reservationRoomStay



Request

PropertyTypeRequiredDefault valueDescription
chainIdinttrue
Unique identificator of the chain.
propertyIdinttrue
Unique identificator of the property.

otaLocator

Stringfalse

pmsLocator

Stringfalse

crsLocator

Stringfalse

cmLocator

Stringfalse

arrivalFromdatefalse

arrivalTodatefalse

departureFromdatefalse

departureTodatefalse

stayFromdatefalse

stayTodatefalse

createdFromdateTimefalse

createdTodateTimefalse

reservationStatusTypeIdintfalse

reservationSituationTypeIdintfalse

offsetintfalse0
limitintfalse10
sortstringfalseId
sortModestringfalseDesc


Example request

Code Block
languagepowershell
themeDJango
GET https://prod.ulysescloud.com/api/v1/chain/1/property/1/reservationRoomStay



Response

PropertyTypeRequiredDescription
PagePagetrue

Entity


Insert excerpt
ReservationRoomStay
ReservationRoomStay
nopaneltrue

Example response

Code Block
themeDJango
{
	"count": 38,
	"offset": 0,
	"limit": 1,
	"list": [{
		"id": 3,
		"reservationStatusType": {
			"id": 5,
			"code": "CO",
			"name": "CheckedOut"
		},
		"arrival": "2019-06-20",
		"departure": "2019-06-21",
		"arrivalTime": null,
		"departureTime": null,
		"quantity": 1,
		"accommodation": {
			"id": 92,
			"name": "Family"
		},
		"adult": 1,
		"junior": 0,
		"child": 0,
		"infant": 0,
		"productFee": {
			"id": 921,
			"name": "FamilyCity Tax Barcelona"
		},
		"adultFee": 1,
		"juniorFee": 0,
		"childFee": 0,
		"infantFee": 0,
		"pmsLocator": "XS0000000003/3",
		"crsLocator": null,
		"otaLocator": null,
		"cmLocator": null,
		"remark": null,
		"mainProductBoard": null,
		"reservationRoomStayGuests": [{
			"id": 6,
			"documentType": {
				"id": 5,
				"code": "5",
				"name": "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,
				"code": "106",
				"name": "R106",
				"roomModuleStatusType": {
					"id": 2,
					"code": "DI",
					"name": "Dirty"
				}
			}
		}]
	}]
}