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": 1,
      		"reservationStatusType": {
        			"id": 4,
        			"code": "COM",
        			"name": "Committed"
      		},
      		"reservationSituationType": {
        			"id": 2,
        			"code": "CO",
        			"name": "CheckOut"
      		},
      		"arrival": "2019-04-20",
      		"departure": "2019-04-21",
      		"arrivalTime": null,
      		"departureTime": null,
      		"quantity": 1,
      		"accommodation": {
        			"id": 24,
        			"name": "Double"
      		},
      		"adult": 30,
      		"junior": 0,
      		"child": 0,
      		"infant": 0,
      		"productFee": {
        			"id": 24,
        			"name": "Double"
      		},
      		"adultFee": 2,
      		"juniorFee": 0,
      		"childFee": 0,
      		"infantFee": 0,
      		"pmsLocator": "0000000001/1",
      		"crsLocator": null,
      		"otaLocator": null,
      		"cmLocator": null,
      		"remark": null,
      		"mainProductBoard": null,
      		"reservationRoomStayGuests": [
        {
          {
				"id": 1,
          				"documentType": {
            					"id": 2,
            					"code": "2",
            					"name": "Passport"
          },
          				},
				"documentNumber": "MNZLDtSw",
          				"givenName": "Jeremy",
          				"middleName": "Stéphanie",
          				"surName": "Gardner",
          				"genderType": {
            					"id": 2,
            					"code": "F",
            					"name": "Female"
          },
          				},
				"birthDate": "2001-04-30",
          				"birthCountry": {
            					"id": 231,
            					"code": "VEN",
            					"name": "VENEZUELA"
          },
          				},
				"birthPlace": "Waterbury",
          				"effectiveDate": "2018-04-30",
          				"expireDate": "2018-04-30",
				"street": "03         "street": "03 Rusk Park",
          Rusk Park",
				"city": "Waterbury",
          				"stateProvName": "Connecticut",
          				"stateProv": null,
          				"country": {
            					"id": 231,
            					"code": "VEN",
            					"name": "VENEZUELA"
          },
          				},
				"postalCode": "6726",
          				"nationalityCountry": {
            					"id": 231,
					"code":            "code": "VEN",
            ""VEN",
					"name": "VENEZUELA"
          },
          				},
				"ocr": null,
          				"email": "phill8m@usnews.com",
          				"phoneNumber": "1-(203)205-9014"
        },
        {
          			},
			{
				"id": 2,
          				"documentType": {
            					"id": 2,
            					"code": "2",
					"name":            "name": "Passport"
          },
          "Passport"
				},
				"documentNumber": "aohhZTZj",
          				"givenName": "Gregory",
          				"middleName": "Marie-françoise",
          				"surName": "Owens",
				"genderType":          "genderType": {
            "{
					"id": 2,
            					"code": "F",
            					"name": "Female"
          },
          				},
				"birthDate": "2001-04-30",
          				"birthCountry": {
            					"id": 102,
            					"code": "IRQ",
            					"name": "IRAQ"
          },
          				},
				"birthPlace": "Kansas City",
          "effectiveDate": "2018				"effectiveDate": "2018-04-30",
          				"expireDate": "2018-04-30",
          				"street": "47 Dexter Place",
          				"city": "Kansas City",
          				"stateProvName": "Missouri",
          				"stateProv": null,
          				"country": {
            					"id": 102,
            					"code": "IRQ",
            					"name": "IRAQ"
          },
          				},
				"postalCode": "64199",
          				"nationalityCountry": {
            					"id": 102,
            					"code": "IRQ",
            					"name": "IRAQ"
          },
          				},
				"ocr": null,
          				"email": "jmartinezp7@bigcartel.com",
          "phoneNumber": "				"phoneNumber": "1-(816)452-4459"
        },
        {
          			}
		],
		"reservationRoomStayDaily": [{
			"id": 13161,
          "documentType			"date": null,
          "documentNumber"2019-04-20",
			"allotment": null,
          "givenName			"rate": {
				"id": 1,
				"code": "BAR",
				"name": "Best Rate Available"
			},
			"price": 146,
			"currency": {
 "middleName				"id": "",
          "surName1,
				"code": "EUR",
          "genderType				"name": "Euro"
			},
			"offer": null,
          "birthDate			"offerAmountDiscount": null,
          "birthCountry			"offerPercentDiscount": null,
          "birthPlace			"promotion": null,
          "effectiveDate			"promotionAmountDiscount": null,
          "expireDate			"promotionPercentDiscount": null,
          "street			"productBoard": null,
          "city			"boardPriceAdult": null,
          "stateProvName			"boardPriceJunior": null,
          "stateProv			"boardPriceChild": null,
          "country			"boardPriceInfant": null,
			"paymentType":          "postalCode{
				"id": null2,
				"code": "GG",
				"name": "Pay Guest Guest"
			},
			"propertyPolicy": {
 "nationalityCountry				"id": null57,
          "ocr				"code": null"24H",
				"name": "24 Hours Before Arrival"
     "email			},
			"propertySource": null,
          "phoneNumber": null
        },
        {
          {
				"id": 13,
				"code": "COM",
				"name": "Company"
			},
			"propertySegment": {
				"id": 131724,
          "documentType				"code": null"HACC",
				"name": "Home Account"
			},
			"propertyChannel":      "documentNumber{
				"id": null24,
          "givenName				"code": "IDS",
          "middleName				"name": "IDS",
          "surName
			},
			"postingDate": "2019-04-30",
		}],
		"reservationRoomStayServiceList": [{
			"service":       "genderType{
				"id": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1318,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1319,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1320,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1321,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1322,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1323,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1324,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1325,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1326,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1327,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1328,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1329,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1330,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1331,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1332,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1333,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1334,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1335,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1336,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1337,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1338,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1339,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1340,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1341,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1342,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        },
        {
          "id": 1343,
          "documentType": null,
          "documentNumber": null,
          "givenName": "",
          "middleName": "",
          "surName": "",
          "genderType": null,
          "birthDate": null,
          "birthCountry": null,
          "birthPlace": null,
          "effectiveDate": null,
          "expireDate": null,
          "street": null,
          "city": null,
          "stateProvName": null,
          "stateProv": null,
          "country": null,
          "postalCode": null,
          "nationalityCountry": null,
          "ocr": null,
          "email": null,
          "phoneNumber": null
        }
      ],
      "reservationRoomStayDaily": [
        {
          "id": 1,
          "date": "2019-04-20",
          "allotment": null,
          "rate": {
            "id": 1,
            "code": "BAR",
            "name": "Best Rate Available"
          },
          "price": 146,
          "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro"
          },
          "offer": null,
          "offerAmountDiscount": null,
          "offerPercentDiscount": null,
          "promotion": null,
          "promotionAmountDiscount": null,
          "promotionPercentDiscount": null,
          "productBoard": null,
          "boardPriceAdult": null,
          "boardPriceJunior": null,
          "boardPriceChild": null,
          "boardPriceInfant": null,
          "paymentType": {
            "id": 2,
            "code": "GG",
            "name": "Pay Guest Guest"
          },
          "propertyPolicy": {
            "id": 57,
            "code": "24H",
            "name": "24 Hours Before Arrival"
          },
          "propertySource": {
            "id": 13,
            "code": "COM",
            "name": "Company"
          },
          "propertySegment": {
            "id": 24,
            "code": "HACC",
            "name": "Home Account"
          },
          "propertyChannel": {
            "id": 24,
            "code": "IDS",
            "name": "IDS"
          },
          "postingDate": "2019-04-30"
        }
      ],
      "reservationRoomStayServiceList": null
    }
  233,
				"name": "Pet"
			},
			"startDate": "2018-12-02",
			"endDate": "2018-12-03",
			"quantity": 1,
			"reservationRoomStayServiceDailyModelList": [{
					"date": "2018-12-02",
					"rate": null,
					"price": 10,
					"currency": {
						"code": "EUR",
						"name": "Euro"
					},
					"offer": null,
					"offerAmountDiscount": null,
					"offerPercentDiscount": null,
					"promotion": null,
					"promotionAmountDiscount": null,
					"promotionPercentDiscount": null,
					"postingDate": null
				},
				{
					"date": "2018-12-03",
					"rate": null,
					"price": 11,
					"currency": {
						"code": "EUR",
						"name": "Euro"
					},
					"offer": null,
					"offerAmountDiscount": null,
					"offerPercentDiscount": null,
					"promotion": null,
					"promotionAmountDiscount": null,
					"promotionPercentDiscount": null,
					"postingDate": null
				}
			]
		}]
	}]
}