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

PropertyTypeRequiredDefault valueDescription
chainIdStringtrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
reservationRoomStayIdIntegertrue
Unique identificator of the reservationRoomStay.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/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": 21,
  "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": 632,
		"name
    "id": "Single"677,
		"roomType": { 			"id": 2, 			"name": "Single"
		}Double",
  },   "roomroomType": {
      "id": 817,
      "codename": "108Double",
      "namenameI18n": "108Double",
      "roomSpaceStatusTypemainImage": { "1/2/propertyroomtypeimages/1cb6be6d-5056-484d-9c95-c574f4603a35.jpg"
    }
  },
  "room": {
    "id": 27,

     "code": "DI107",
 
    "name": "Dirty"
    }107",
    "reservationRoomStayroomSpaceStatusType": null{
   },   "adultid": 12,
  "junior": 0,   "childcode": 0"DI",
  "infant": 0,   "productFeename": {"Dirty",
      "idnameI18n": 767 "Dirty"
    },
    "namereservationRoomStay": null,
    "City Tax Barcelona""roomSituationType": {
      "id": 1,
   },   "adultFeecode": 0"EM",
      "juniorFeename": 0,"Empty",
      "childFeenameI18n": 0 "Empty"
    }
  },
  "infantFeeadult": 0,
  "pmsLocator": "ALI00000002/2",
  "crsLocator": null,
  "otaLocator": null,
  "cmLocator": null,
  "remark": null,
  "mainBoard": {
    "id": 6,
    "code": null,
    "name": "Bed And Breakfast",
    "serviceList": [
      {2,
  "junior": 0,
  "child": 0,
  "infant": 0,
  "productFee": {
    "id": 797,
    "name": "City Tax Mallorca"
  },
  "adultFee": 0,
  "juniorFee": 0,
  "childFee": 0,
  "infantFee": 0,
  "pmsLocator": "ALI00000001/1",
  "crsLocator": null,
  "otaLocator": null,
  "cmLocator": null,
  "remark": null,
  "reservationRoomStayGuests": [
    {
      "id": 1,
      "documentType": {
        "id": 2,
        "code": "P",
        "name": "Passport",
        "nameI18n": "Passport"
      },
      "documentNumber": "bWhYuWTG",
      "givenName": "Ruth",
      "surName": "Nélie",
      "secondSurName": "Larson",
      "genderType": {
        "id": 1,
        "code": "M",
        "name": "Male",
        "nameI18n": "Male"
      },
      "birthDate": "2002-06-09",
      "birthCountryCode": "LB",
      "birthPlace": "Jacksonville",
      "effectiveDate": "2019-06-09",
      "expireDate": "2019-06-09",
      "street": "8 Oak Avenue",
      "city": "Jacksonville",
      "stateProvName": "Florida",
      "stateProvCode": null,
      "countryCode": "LB",
      "postalCode": "32230",
      "nationalityCountryCode": "LB",
      "countryOfIssuanceCode": "LB",
      "ocr": null,
      "email": "jryanpt@skyrock.com",
      "phoneNumber": "1-(904)418-8705"
    },
    {
      "id": 2,
      "documentType": {
        "id": 2,
        "code": "P",
        "name": "Passport",
        "nameI18n": "Passport"
      },
      "documentNumber": "gnZARTzi",
      "givenName": "Sara",
      "surName": "Publicité",
      "secondSurName": "Mendoza",
      "genderType": {
        "id": 2,
        "code": "F",
        "name": "Female",
        "nameI18n": "Female"
      },
      "birthDate": "2002-06-09",
      "birthCountryCode": "HU",
      "birthPlace": "New York City",
      "effectiveDate": "2019-06-09",
      "expireDate": "2019-06-09",
      "street": "86593 Sachtjen Terrace",
      "city": "New York City",
      "stateProvName": "New York",
      "stateProvCode": null,
      "countryCode": "HU",
      "postalCode": "10115",
      "nationalityCountryCode": "HU",
      "countryOfIssuanceCode": "HU",
      "ocr": null,
      "email": "bbella7@ebay.com",
      "phoneNumber": "1-(212)600-0055"
    }
  ],
  "mainBoard": {
    "id": 8,
    "code": null,
    "name": "FullBoard",
    "serviceList": [
      {
        "id": 63,
        "code": "BRK",
        "name": "Breakfast"
      },
      {
        "id": 67,
        "code": "LUNCH",
        "name": "Lunch"
      },
      {
        "id": 68,
        "code": "DINNER",
        "name": "Dinner"
      }
    ]
  },
  "reservationRoomStayDaily": [
    {
      "id": 1,
      "date": "2020-05-10",
      "room": {
        "id": 7,
        "code": "107",
        "name": "107",
        "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": 318.600000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro",
        "nameI18n": "Euro"
      },
      "offer": {
        "id": 2,
        "code": "NR",
        "name": "Non Refundable"
      },
      "offerAmountDiscount": 0.000000,
      "offerPercentDiscount": 10.000000,
      "promotion": null,
      "promotionAmountDiscount": null,
      "promotionPercentDiscount": null,
      "board": {
        "id": 8,
        "code": null,
        "name": "FullBoard",
        "serviceList": [
          {
            "id": 63,
            "code": "BRK",
            "name": "Breakfast"
          },
          {
            "id": 67,
            "code": "LUNCH",
            "name": "Lunch"
          },
          {
            "id": 68,
            "code": "DINNER",
            "name": "Dinner"
          }
        ]
      },
      "boardPriceAdult": 107.000000,
      "boardPriceJunior": 89.000000,
      "boardPriceChild": 0.000000,
      "boardPriceInfant": 0.000000,
      "paymentType": {
        "id": 2,
        "code": "GG",
        "name": "Pay Guest Guest",
        "nameI18n": "Pay Guest Guest"
      },
      "propertyPolicy": {
        "id": 7,
        "code": "NR",
        "name": "Non Refundable"
      },
      "propertySource": {
        "id": 9,
        "code": "COM",
        "name": "Company"
      },
      "propertySegment": {
        "id": 30,
        "code": "MEET",
        "name": "Meetings"
      },
      "propertyChannel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "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": 2,
      "date": "2020-05-11",
      "room": {
        "id": 7,
        "code": "107",
        "name": "107",
        "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": 318.600000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro",
        "nameI18n": "Euro"
      },
      "offer": {
        "id": 2,
        "code": "NR",
        "name": "Non Refundable"
      },
      "offerAmountDiscount": 0.000000,
      "offerPercentDiscount": 10.000000,
      "promotion": null,
      "promotionAmountDiscount": null,
      "promotionPercentDiscount": null,
      "board": {
        "id": 8,
        "code": null,
        "name": "FullBoard",
        "serviceList": [
          {
            "id": 63,
            "code": "BRK",
            "name": "Breakfast"
          },
          {
            "id": 67,
            "code": "LUNCH",
            "name": "Lunch"
          },
          {
            "id": 68,
            "idcode": 61"DINNER",
            "name": "Breakfast" "Dinner"
          }
    ]   }, ]
 "reservationRoomStayGuests": [     {},
      "idboardPriceAdult": 2107.000000,
      "documentTypeboardPriceJunior": {
89.000000,
       "idboardPriceChild": 20.000000,
 
      "codeboardPriceInfant": "2",
 0.000000,
      "namepaymentType": {
"Passport"        }"id": 2,
        "documentNumbercode": "swgcACUUGG",
        "givenNamename": "MariePay Guest Guest",
        "secondSurNamenameI18n": "Mélodie",
Pay Guest Guest"
     "surName": "Hunt" },
      "genderTypepropertyPolicy": {
        "id": 17,
        "code": "MNR",
        "name": "MaleNon Refundable"
      },
      "birthDatepropertySource": "2002-02-13", {
        "birthCountryCodeid": "VU"9,
        "birthPlacecode": "MemphisCOM",
        "effectiveDatename": "2019-02-13Company",
      "expireDate": "2019-02-13"},
      "streetpropertySegment": "2603 Cherokee Drive",
      "city": "Memphis",{
        "stateProvNameid": "Tennessee"30,
        "stateProvCodecode": null"MEET",
        "countryCodename": "VUMeetings",
      "postalCode": "38104"},
      "nationalityCountryCodepropertyChannel": "VU", {
        "ocrid": null8,
        "emailcode": "bhernandezo@instagram.comGDS",
        "phoneNumbername": "1-(901)206-4293"Global Distribution System"
      },
   ],   "reservationRoomStayDailybooker": [null,
    {       "idbillTo": 6,{
        "dateid": "2020-01-14"994,
        "roomname": {"Janyx",
        "idcode": 8"JANYX3",
        "codetaxId": "10884105983",
        "namecompanyEmailList": [
"108",         "roomSpaceStatusType": {
            "id": 2994,
            "codeprimary": "DI"true,
            "nameemailAddressType": "Dirty"{
        },         "reservationRoomStayid": 1,
null       },       "allotmentcode": null"1",
      "rate": {        "name": "Personal",
    "id": 1,         "codenameI18n": "BARPersonal",
        "name": "Best Available Rate" },
     },       "amountAfterTaxemail": 124"jrobinsonra@mit.200000edu",
            "currencyremark": {null
        "id": 1, }
       "code": "EUR" ],
        "namecompanyAddressList": "Euro"[
      },    {
  "offer": {         "id": 1994,
            "primary": true,
  "code": "NR",         "namecommunicationLocationType": "Non{
Refundable"       },       "offerAmountDiscountid": 0.0000001,
      "offerPercentDiscount": 10.000000,       "promotioncode": null"1",
      "promotionAmountDiscount": null,       "promotionPercentDiscountname": null,"Home"
      "board": {     },
   "id": 6,         "codestreet": null,"48 Northwestern Street",
      "name": "Bed And Breakfast",   "city": "Salt  Lake City",
 "serviceList": [           {"stateProvName": "Utah",
            "idstateProvCode": 61null,
            "namepostalCode": "Breakfast84105",
          }  "countryCode": "CY",
     ]       },
 "remark": "Address Remark"
    "boardPriceAdult": 22.000000,     }
 "boardPriceJunior": 49.000000,      ],
"boardPriceChild": 0.000000,       "boardPriceInfantcompanyPhoneList": 0.000000,[
      "paymentType": {   {
     "id": 5,           "codeid": "AG"994,
        "name": "Pay Agency Guest"
    "primary": true,
     },       "propertyPolicyphoneLocationType": {
              "id": 76,
 
      "code": "NR",         "namecode": "6"Non,
Refundable"       },       "propertySourcename": {
   "Home",
    "id": 8,         "codenameI18n": "AGEHome",
          "name": "Agency" },
     },       "propertySegmentphoneTechType": {
              "id": 311,
              "code": "CREWS1",
              "name": "CrewsVoice",
       },       "propertyChannelnameI18n": {"Voice"
           "id": 11},
            "codecountryAccessCode": "WEB+34",
            "nameareaCityCode": "Booking EngineB",
      },       "bookerphoneNumber": null,
 "1-(801)421-8231",
    "billTo": {         "idextension": 172,"1",
            "nameremark": "Tagfeed",
Phone Remark"
          }
       "code": null],
        "taxIdcompanyTaxAddress": "75310161", {
          "iataIdid": null984,
          "companyEmailListcommunicationLocationType": [null,
          {
  "street": "48 Northwestern Street",
          "idcity": 172,"Salt Lake City",
          "primarystateProvName": true"Utah",
 
          "emailAddressTypestateProvCode": {
   null,
          "idpostalCode": 1,
  "84105",
           "codecountryCode": "1SH",

             "nameremark": "Personal"
   Address Remark"
        },
   
        "emailremark": "rsnyder4g@quantcast.com",Company Remarks"
      },
      "remarkcentral": null,
      "company": null
    },
    {
   ],   "id": 3,
      "companyAddressListdate": [ "2020-05-12",
      "room": {
      {    "id": 7,
         "idcode": 172"107",
            "primaryname": true,
  "107",
         "communicationLocationTyperoomSpaceStatusType": {
  
           "id": 12,
              "code": "1DI",
              "name": "Home"
            },
 Dirty",
          "streetnameI18n": "09914Dirty"
   Lunder Point",    },
        "cityreservationRoomStay": "Dallas"null,
            "stateProvName": "Texas",
 "roomSituationType": {
          "stateProvCodeid": null1,
 
          "postalCodecode": "75310EM",
 
          "countryCodename": "HTEmpty",
            "remarknameI18n": "Address RemarkEmpty"
 
        }
        ]},
        "companyPhoneListallotment": [null,
      "rate": {
     {   "id": 2,
        "idcode": 172"BAR",
        "name": "Best Available  "primaryRate":
true,      },
      "phoneLocationTypeamountAfterTax": {318.600000,
      "currency": {
        "id": 61,
    
         "code": "6EUR",
              "name": "HomeEuro",
        "nameI18n": "Euro"
  },      },
      "phoneTechTypeoffer": {
              "id": 12,
    
         "code": "1NR",
     
        "name": "VoiceNon Refundable"
 
          },
     
      "countryAccessCodeofferAmountDiscount": "+34"0.000000,
            "areaCityCode"offerPercentDiscount": "B",10.000000,
      "promotion": null,
      "phoneNumberpromotionAmountDiscount": "1-(214)166-4006",null,
      "promotionPercentDiscount": null,
      "extensionboard": "1",{
            "remarkid": "Phone8,
Remark"        "code": null,
 }         ]"name": "FullBoard",
        "companyTaxAddressserviceList": [
{          {
"id": 162,           "communicationLocationTypeid": null63,
            "streetcode": "09914 Lunder PointBRK",
            "cityname": "DallasBreakfast",
          "stateProvName": "Texas",},
          {
"stateProvCode": null,           "postalCodeid": "75310"67,
            "countryCodecode": "NZLUNCH",
            "remarkname": "AddressLunch"
 Remark"         },
        "remark": "Company Remarks"{
      },       "centralid": null68,
      "company": null     }
  ],
  "reservationRoomStayServiceList": ["code": "DINNER",
     {       "idname": 1,"Dinner"
      "service": {   }
     "id": 70,  ]
      "name": "Hostess"},
       }"boardPriceAdult": 107.000000,
      "startDateboardPriceJunior": "2020-01-14"89.000000,
      "endDateboardPriceChild": "2020-01-15"0.000000,
      "quantityboardPriceInfant": 10.000000,
      "reservationRoomStayServiceDailyListpaymentType": [{
        {
 "id": 2,
        "idcode": 1"GG",
          "datename": "2020-01-14Pay Guest Guest",
 
        "ratenameI18n": null,"Pay Guest Guest"
        "amountAfterTax": 10.000000,
   },
      "currencypropertyPolicy": {
   
        "id": 17,
            "code": "EURNR",
            "name": "Euro"
   Non Refundable"
      },
  
       "offerpropertySource": null,{
          "offerAmountDiscountid": null9,
 
        "offerPercentDiscountcode": null"COM",
        "name":  "promotionCompany":
  null,    },
      "promotionAmountDiscountpropertySegment": null,
{
         "promotionPercentDiscountid": null30,

         "postingDatecode": "2020-02-13MEET",
        }
    "name": "Meetings"
 ]     },
    {       "idpropertyChannel": 2,{
        "serviceid": {7,
        "idcode": 72"CRS",
        "name": "TelevisionCentral ReservationSystem"
      },
      "startDatebooker": null,
      "2020-01-14",billTo": {
        "endDateid": "2020-01-15",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",
          },           "offer": null,"nameI18n": "Personal"
           "offerAmountDiscount": null},
            "offerPercentDiscountemail": null"jrobinsonra@mit.edu",
            "promotionremark": null,
          "promotionAmountDiscount": null,}
        ],
  "promotionPercentDiscount": null,     "companyAddressList": [
    "postingDate": "2020-02-13"       {
 }       ]    "id": }994,
    {        "idprimary": 3,true,
            "servicecommunicationLocationType": {
              "id": 741,
        "name      "code": "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-14Utah",
            "ratestateProvCode": null,
            "amountAfterTaxpostalCode": 10.000000"84105",
            "currencycountryCode": {"CY",
            "idremark": 1, "Address Remark"
          }
   "code": "EUR",    ],
        "namecompanyPhoneList": [
"Euro"          {
},            "offerid": null994,
            "offerAmountDiscountprimary": nulltrue,
            "offerPercentDiscountphoneLocationType": null, {
              "promotionid": null6,
              "promotionAmountDiscountcode": null,"6",
              "promotionPercentDiscountname": null"Home",
              "postingDatenameI18n": "2020-02-13"Home"
            },
        ]    "phoneTechType": {
 },      {       "id": 41,
 
    "service": {         "idcode": 72"1",
              "name": "TelevisionVoice",
       },       "startDatenameI18n": "2020-01-14",Voice"
           "endDate": "2020-01-15", },
            "quantitycountryAccessCode": 1"+34",
      "reservationRoomStayServiceDailyList": [        "areaCityCode": "B",
 {           "idphoneNumber": 4,"1-(801)421-8231",
            "dateextension": "2020-01-141",
            "rateremark": null, "Phone Remark"
          }
     "amountAfterTax": 10.000000,  ],
        "currencycompanyTaxAddress": {
            "id": 1984,
 
          "codecommunicationLocationType": "EUR"null,

           "namestreet": "Euro"48 Northwestern Street",
          "city": "Salt Lake }City",
          "offerstateProvName": null"Utah",
          "offerAmountDiscountstateProvCode": null,
          "offerPercentDiscountpostalCode": null"84105",
          "promotioncountryCode": null"SH",
          "promotionAmountDiscountremark": null,"Address Remark"
         "promotionPercentDiscount": null,
 },
        "postingDateremark": "2020-02-13"Company Remarks"
      },
      "central": null,
}      "company": ]null
    }
  ],
  "reservationRoomStayServiceList": null
}