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/public/api/v1/con/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

reservationStatusTypeIdlist of intfalse

roomIdlist of intfalse

offsetintfalse0
limitintfalse10
sortstringfalseId
sortModestringfalseDesc


Example request

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



Response

PropertyTypeRequiredDescription
PagePagetrue

Entity


Insert excerpt
ReservationRoomStay
ReservationRoomStay
nopaneltrue

Example response

Code Block
themeDJango
{
  "count": 3925,
  "offset": 1,
  "limit": 110,
  "list": [
    {
      "id": 2,
      "reservationStatusType": {
        "id": 5,
        "code": "CO",
        "name": "CheckedOut",
        "nameI18n": "CheckedOut",
		
        "colorCode": "#757575"
      },
      "arrival": "2020-0105-1410",
      "departure": "2020-0105-1513",
      "arrivalTime": null,
      "departureTime": null,
      "quantity": 1,
      "accommodation": {
			        "id": 632692,
			        "name": "SingleDouble Deluxe",
			
        "roomType": {
				
          "id": 217,
				"name          "name": "Double",
          "nameI18n": "SingleDouble"
			}
	  },
      "room": {,
          "mainImage": "1/2/propertyroomtypeimages/1cb6be6d-5056-484d-9c95-c574f4603a35.jpg"
        }
      },
      "room": {
        "id": 10,
        "code": "110",
        "name": "110",
        "roomSpaceStatusType": {
          "id": 2,
          "code": "DI",
          "name": "Dirty",
          "nameI18n": "Dirty"
        },
        "reservationRoomStay": null,
        "roomSituationType": {
          "id": 1,
          "code": "EM",
          "name": "Empty",
          "nameI18n": "Empty"
        }
      },
      "adult": 1,
      "junior": 0,
      "child": 0,
      "infant": 0,
      "productFee": {
        "id": 797,
        "name": "City Tax Mallorca"
      },
      "adultFee": 0,
      "juniorFee": 0,
      "childFee": 0,
      "infantFee": 0,
      "pmsLocator": "ALI00000001/2",
      "crsLocator": null,
      "otaLocator": null,
      "cmLocator": null,
      "remark": null,
      "reservationRoomStayGuests": [
        {
          "id": 3,
          "documentType": {
            "id": 2,
            "code": "P",
            "name": "Passport",
            "nameI18n": "Passport"
          },
          "documentNumber": "HtXlGovS",
          "givenName": "Lisa",
          "surName": "Bécassine",
          "secondSurName": "Mcdonald",
          "genderType": {
            "id": 1,
            "code": "M",
            "name": "Male",
            "nameI18n": "Male"
          },
          "birthDate": "2002-06-09",
          "birthCountryCode": "EG",
          "birthPlace": "San Jose",
          "effectiveDate": "2019-06-09",
          "expireDate": "2019-06-09",
          "street": "32 Monica Road",
          "city": "San Jose",
          "stateProvName": "California",
          "stateProvCode": null,
          "countryCode": "EG",
          "postalCode": "95133",
          "nationalityCountryCode": "EG",
          "countryOfIssuanceCode": "EG",
          "ocr": null,
          "email": "nwestrb@lycos.com",
          "phoneNumber": "1-(408)161-2172"
        }
      ],
      "mainBoard": {
        "id": 7,
        "code": null,
        "name": "HalfBoard",
        "serviceList": [
          {
            "id": 63,
            "code": "BRK",
            "name": "Breakfast"
          },
          {
            "id": 68,
            "code": "DINNER",
            "name": "Dinner"
          }
        ]
      },
      "reservationRoomStayDaily": [
        {
          "id": 4,
          "date": "2020-05-10",
          "room": {
            "id": 10,
            "code": "110",
            "name": "110",
            "roomSpaceStatusType": {
              "id": 2,
              "code": "DI",
              "name": "Dirty",
              "nameI18n": "Dirty"
            },
            "reservationRoomStay": null,
            "roomSituationType": {
              "id": 1,
              "code": "EM",
              "name": "Empty",
              "nameI18n": "Empty"
            }
          },
          "allotment": null,
          "rate": {
            "id": 2,
            "code": "BAR",
            "name": "Best Available Rate"
          },
          "amountAfterTax": 206.000000,
          "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro",
            "nameI18n": "Euro"
          },
          "offer": null,
          "offerAmountDiscount": null,
          "offerPercentDiscount": null,
          "promotion": null,
          "promotionAmountDiscount": null,
          "promotionPercentDiscount": null,
          "board": {
            "id": 7,
            "code": null,
            "name": "HalfBoard",
            "serviceList": [
              {
                "id": 63,
                "code": "BRK",
                "name": "Breakfast"
              },
              {
                "id": 68,
                "code": "DINNER",
                "name": "Dinner"
              }
            ]
          },
          "boardPriceAdult": 56.000000,
          "boardPriceJunior": 77.000000,
          "boardPriceChild": 0.000000,
          "boardPriceInfant": 0.000000,
          "paymentType": {
            "id": 2,
            "code": "GG",
            "name": "Pay Guest Guest",
            "nameI18n": "Pay Guest Guest"
          },
          "propertyPolicy": {
            "id": 12,
            "code": "24H",
            "name": "24 Hours 1 Night"
          },
          "propertySource": {
            "id": 13,
            "code": "PHO",
            "name": "Phone"
          },
          "propertySegment": {
            "id": 18,
            "code": "WEDD",
            "name": "Wedding"
          },
          "propertyChannel": {
            "id": 10,
            "code": "OTA",
            "name": "Online Travel Agency"
          },
          "booker": null,
          "billTo": {
            "id": 994,
            "name": "Janyx",
            "code": "JANYX3",
            "taxId": "84105983",
            "companyEmailList": [
              {
                "id": 994,
                "primary": true,
                "emailAddressType": {
                  "id": 1,
                  "code": "1",
                  "name": "Personal",
                  "nameI18n": "Personal"
                },
                "email": "jrobinsonra@mit.edu",
                "remark": null
              }
            ],
            "companyAddressList": [
              {
                "id": 994,
                "primary": true,
                "communicationLocationType": {
                  "id": 1,
                  "code": "1",
                  "name": "Home"
                },
                "street": "48 Northwestern Street",
                "city": "Salt Lake City",
                "stateProvName": "Utah",
                "stateProvCode": null,
                "postalCode": "84105",
                "countryCode": "CY",
                "remark": "Address Remark"
              }
            ],
            "companyPhoneList": [
              {
                "id": 994,
                "primary": true,
                "phoneLocationType": {
                  "id": 6,
                  "code": "6",
                  "name": "Home",
                  "nameI18n": "Home"
                },
                "phoneTechType": {
                  "id": 1,
                  "code": "1",
                  "name": "Voice",
                  "nameI18n": "Voice"
                },
                "countryAccessCode": "+34",
                "areaCityCode": "B",
                "phoneNumber": "1-(801)421-8231",
                "extension": "1",
                "remark": "Phone Remark"
              }
            ],
            "companyTaxAddress": {
              "id": 984,
              "communicationLocationType": null,
              "street": "48 Northwestern Street",
              "city": "Salt Lake City",
              "stateProvName": "Utah",
              "stateProvCode": null,
              "postalCode": "84105",
              "countryCode": "SH",
              "remark": "Address Remark"
            },
            "remark": "Company Remarks"
          },
          "central": null,
          "company": null
        },
        {
"id": 8,         "codeid": "108"5,
          "namedate": "1082020-05-11",
          "roomSpaceStatusTyperoom": {
            "id": 210,
            "code": "DI110",
            "name": "Dirty"
    110",
   },         "reservationRoomStayroomSpaceStatusType": null{
       },       "adultid": 12,
      "junior": 0,       "childcode": 0"DI",
      "infant": 0,       "productFeename": {"Dirty",
              "idnameI18n": 767,"Dirty"
        "name": "City Tax Barcelona" },
     },       "adultFeereservationRoomStay": 0null,
      "juniorFee": 0,       "childFeeroomSituationType": 0,{
      "infantFee": 0,       "pmsLocatorid": "ALI00000002/2"1,
      "crsLocator": null,       "otaLocatorcode": null"EM",
      "cmLocator": null,       "remarkname": null"Empty",
      "mainBoard": {        "nameI18n": "idEmpty":
 6,         "code": null, }
       "name": "Bed And Breakfast"},
          "serviceListallotment": [null,
          "rate": {
            "id": 612,
            "namecode": "BreakfastBAR",
          }  "name": "Best Available Rate"
   ]       },
          "reservationRoomStayGuestsamountAfterTax": [206.000000,
          "currency": {
            "id": 21,
            "documentTypecode": {"EUR",
            "idname": 2"Euro",
            "codenameI18n": "2",
 Euro"
          },
          "offer": null,
          "nameofferAmountDiscount": "Passport"null,
          "offerPercentDiscount": }null,
          "documentNumberpromotion": "swgcACUU"null,
          "givenNamepromotionAmountDiscount": "Marie"null,
          "secondSurNamepromotionPercentDiscount": "Mélodie"null,
          "surNameboard": "Hunt", {
            "genderTypeid": {7,
            "idcode": 1null,
            "codename": "MHalfBoard",
            "nameserviceList": "Male" [
              {
     },           "birthDateid": "2002-02-13",63,
                "birthCountryCodecode": "VU","BRK",
                "birthPlacename": "MemphisBreakfast",
          "effectiveDate": "2019-02-13",   },
       "expireDate": "2019-02-13",      {
    "street": "2603 Cherokee Drive",           "cityid": "Memphis"68,
                "stateProvNamecode": "TennesseeDINNER",
                "stateProvCodename": null,"Dinner"
             "countryCode": "VU", }
          "postalCode": "38104", ]
         "nationalityCountryCode": "VU" },
          "ocrboardPriceAdult": null56.000000,
          "emailboardPriceJunior": "bhernandezo@instagram77.com"000000,
          "phoneNumberboardPriceChild": "1-(901)206-4293"0.000000,
        }  "boardPriceInfant": 0.000000,
   ],       "reservationRoomStayDailypaymentType": [
     {
  {           "id": 62,
            "datecode": "2020-01-14GG",
            "roomname": {"Pay             "id": 8Guest Guest",
            "codenameI18n": "108",Pay Guest Guest"
          "name": "108",
 },
          "roomSpaceStatusTypepropertyPolicy": {
 
            "id": 212,
              "code": "DI24H",
 
            "name": "Dirty"24 Hours 1 Night"
          },
            "reservationRoomStaypropertySource": {
null            "id": }13,
            "allotmentcode": null"PHO",
            "ratename": { "Phone"
          },
          "idpropertySegment": 1,{
            "codeid": "BAR"18,
            "namecode": "WEDD"Best,
 Available Rate"           },"name": "Wedding"
          "amountAfterTax": 124.200000},
          "currencypropertyChannel": {
            "id": 110,
            "code": "EUROTA",
            "name": "EuroOnline Travel Agency"
          },
          "offerbooker": {
 null,
          "idbillTo": 1,{
            "codeid": "NR"994,
            "name": "Janyx"Non,
  Refundable"           }"code": "JANYX3",
            "offerAmountDiscounttaxId": 0.000000,"84105983",
            "offerPercentDiscountcompanyEmailList": 10.000000,[
              {
   "promotion": null,             "promotionAmountDiscountid": null, 994,
                "promotionPercentDiscountprimary": nulltrue,
          "board      "emailAddressType": {
                  "id": 61,
                  "code": null"1",
                  "name": "Bed And Breakfast",Personal",
                  "serviceListnameI18n": "Personal"
[                {},
                "idemail": 61"jrobinsonra@mit.edu",
                "nameremark": "Breakfast"null
              }
            ],
          },  "companyAddressList": [
              {
    "boardPriceAdult": 22.000000,           "boardPriceJuniorid": 49.000000,994,
                "boardPriceChildprimary": 0.000000true,
          "boardPriceInfant": 0.000000,     "communicationLocationType": {
    "paymentType": {             "id": 51,
                  "code": "AG1",
                  "name": "Pay Agency Guest""Home"
                },
                "propertyPolicystreet": {"48 Northwestern Street",
                "idcity": 7, "Salt Lake City",
                "codestateProvName": "NRUtah",
                "namestateProvCode": "Nonnull,
Refundable"           },     "postalCode": "84105",
    "propertySource": {
            "idcountryCode": 8"CY",
                "coderemark": "AGE",Address Remark"
              }
"name": "Agency"           }],
            "propertySegmentcompanyPhoneList": [
  {            {
 "id": 31,               "codeid": "CREWS"994,
                "nameprimary": "Crews"true,
           },     "phoneLocationType": {
    "propertyChannel": {             "id": 11,6,
                  "code": "WEB6",
                  "name": "Booking EngineHome",
          },        "nameI18n":   "bookerHome":
null,           "billTo": {    },
        "id": 172,       "phoneTechType": {
    "name": "Tagfeed",             "codeid": null1,
            "taxId      "code": "753101611",
                  "iataIdname": null,"Voice",
                   "nameI18n": "companyEmailListVoice":
 [               {},
                "idcountryAccessCode": 172"+34",
                "primaryareaCityCode": true"B",
                "emailAddressTypephoneNumber": {"1-(801)421-8231",
                  "idextension": "1",
 
                "coderemark": "1",Phone Remark"
              }
     "name": "Personal"       ],
           }, "companyTaxAddress": {
              "emailid": "rsnyder4g@quantcast.com"984,
                "remarkcommunicationLocationType": null,
              "street": "48 Northwestern Street",
      }        "city": "Salt Lake City",
 ],             "companyAddressListstateProvName": ["Utah",
              {
"stateProvCode": null,
               "idpostalCode": 172"84105",
                "primarycountryCode": true"SH",
              "remark": "Address "communicationLocationType": {Remark"
            },
            "idremark": 1,"Company Remarks"
          },
          "codecentral": "1"null,
          "company": null
      "name": "Home"  },
        {
     },     "id": 6,
          "streetdate": "09914 Lunder Point2020-05-12",
                "city"room": "Dallas",{
                "stateProvNameid": "Texas",
   10,
            "stateProvCodecode": null,
  "110",
             "postalCodename": "75310110",
  
             "countryCoderoomSpaceStatusType": "HT",{
                "remarkid": "Address Remark"2,
              "code": "DI",
 }              ],"name": "Dirty",
              "companyPhoneListnameI18n": ["Dirty"
              {
   },
            "idreservationRoomStay": 172null,
                "primaryroomSituationType": true,
{
               "phoneLocationTypeid": {
 1,
                "idcode": 6,
   "EM",
              "codename": "6Empty",

                 "namenameI18n": "HomeEmpty"
            }
    },      },
          "phoneTechTypeallotment": {null,
          "rate": {
      "id": 1,     "id": 2,
            "code": "1BAR",
     
            "name": "Voice "Best Available Rate"
          },
     },     "amountAfterTax": 206.000000,
          "countryAccessCodecurrency": "+34",
{
               "areaCityCodeid": "B"1,
                "phoneNumbercode": "1-(214)166-4006EUR",
   
            "extensionname": "1Euro",
                "remarknameI18n": "Phone RemarkEuro"

             },
            ],
 "offer": null,
          "companyTaxAddressofferAmountDiscount": {
  null,
           "idofferPercentDiscount": 162null,
   
          "communicationLocationTypepromotion": null,
   
          "streetpromotionAmountDiscount": "09914 Lunder Point",
   null,
          "citypromotionPercentDiscount": "Dallas",
  null,
           "stateProvNameboard": "Texas",{
              "stateProvCodeid": null7,
              "postalCodecode": "75310"null,
 
            "countryCodename": "NZHalfBoard",
 
            "remarkserviceList": "Address Remark"[
              {
   },             "remarkid": "Company63,
Remarks"           },     "code": "BRK",
    "central": null,           "companyname": "Breakfast"
 null          }   },
   ],       "reservationRoomStayServiceList": [   {
     {           "id": 168,
                "servicecode": {"DINNER",
                "idname": 70,"Dinner"
              "name": "Hostess"}
           }, ]
         "startDate": "2020-01-14" },
          "endDateboardPriceAdult": "2020-01-15"56.000000,
          "quantityboardPriceJunior": 177.000000,
          "reservationRoomStayServiceDailyListboardPriceChild": [0.000000,
            {
   "boardPriceInfant": 0.000000,
          "idpaymentType": 1,{
              "dateid": "2020-01-14"2,
              "ratecode": null"GG",
              "amountAfterTaxname": 10.000000,
 "Pay Guest Guest",
            "currencynameI18n": { "Pay Guest Guest"
          },
      "id": 1,   "propertyPolicy": {
            "codeid": "EUR"12,
                "namecode": "Euro24H",
            "name": "24 },Hours 1 Night"
            "offer": null,    },
          "offerAmountDiscountpropertySource": null,
 {
            "offerPercentDiscountid": null13,
 
            "promotioncode": null"PHO",
            "name":  "promotionAmountDiscount": null,Phone"
          },
          "promotionPercentDiscountpropertySegment": null,
{
             "postingDateid": "2020-02-13"18,
            }
"code": "WEDD",
         ]   "name": "Wedding"
    },       },
 {           "idpropertyChannel": {
 2,           "serviceid": 8,
{            "code": "idGDS": 72,
            "name": "TelevisionGlobal Distribution System"
          },
          "startDatebooker": "2020-01-14"null,
          "endDatebillTo": {
 "2020-01-15",           "id": 994,
            "quantityname": 1"Janyx",
            "reservationRoomStayServiceDailyListcode": ["JANYX3",
            {
"taxId": "84105983",
             "idcompanyEmailList": 2,[
              "date": "2020-01-14",{
                "rateid": null994,
                "amountAfterTaxprimary": 10.000000true,
                "currencyemailAddressType": {
                  "id": 1,
                  "code": "EUR1",
                  "name": "EuroPersonal",
               },   "nameI18n": "Personal"
               "offer": null},
                "offerAmountDiscountemail": null,"jrobinsonra@mit.edu",
                "offerPercentDiscountremark": null,
              "promotion": null,}
               "promotionAmountDiscount": null],
              "promotionPercentDiscountcompanyAddressList": null,[
              "postingDate": "2020-02-13"{
             }   "id": 994,
      ]         },  "primary": true,
     {           "idcommunicationLocationType": 3,{
          "service": {       "id": 1,
    "id": 74,             "namecode": "Parking1",
          },           "startDatename": "2020-01-14",
Home"
         "endDate": "2020-01-15",      },
    "quantity": 1,           "reservationRoomStayServiceDailyListstreet": ["48 Northwestern Street",
          {      "city": "Salt Lake City",
     "id": 3,
              "datestateProvName": "2020-01-14"Utah",
                "ratestateProvCode": null,
                "amountAfterTaxpostalCode": 10.000000"84105",
                "currencycountryCode": {"CY",
                "idremark": 1,"Address Remark"
              }
       "code": "EUR",    ],
            "namecompanyPhoneList": "Euro"[
              {
 },               "offerid": null994,
                "offerAmountDiscountprimary": nulltrue,
                "offerPercentDiscountphoneLocationType": null, {
                  "promotionid": null6,
              "promotionAmountDiscount": null,    "code": "6",
                  "promotionPercentDiscountname": null,"Home",
                  "postingDatenameI18n": "2020-02-13Home"
            }    },
      ]          },
"phoneTechType": {
       {           "id": 41,
          "service": {        "code": "1",
                  "idname": 72"Voice",
                  "namenameI18n": "TelevisionVoice"
                },
          "startDate      "countryAccessCode": "2020-01-14+34",
                "endDateareaCityCode": "2020-01-15B",
                "quantityphoneNumber": "1-(801)421-8231",
          "reservationRoomStayServiceDailyList": [     "extension": "1",
      {               "idremark": 4,"Phone Remark"
             "date": "2020-01-14", }
              "rate": null,
],
             "amountAfterTaxcompanyTaxAddress": 10.000000,{
              "currencyid": {984,
                "idcommunicationLocationType": 1null,
 
              "codestreet": "EUR48 Northwestern Street",

               "namecity": "EuroSalt Lake City",
              }"stateProvName": "Utah",
              "offerstateProvCode": null,
              "offerAmountDiscountpostalCode": null"84105",
              "offerPercentDiscountcountryCode": null"SH",
              "promotionremark": null,"Address Remark"
            },
"promotionAmountDiscount": null,           "remark": "Company Remarks"
 "promotionPercentDiscount": null,        },
      "postingDate": "2020-02-13"   "central": null,
        }  "company": null
       ] }
      ],
}      "reservationRoomStayServiceList": ]null
    }
  ]
}