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/api/{version}/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://prod.ulysescloud.com/api/v1/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": 32,
    "reservationStatusType": {
   
    "id": 5,
        "code": "CO",
   
    "name": "CheckedOut"

   },
    "arrival": "20192020-0601-2014",
    "departure": "20192020-0601-2115",
    "arrivalTime": null,
    "departureTime": null,
    "quantity": 1,
 
  "accommodation": {
 
      "id": 92632,
        "name": "FamilySingle"
    },
    "adultroom": 1,{
    "juniorid": 08,
    "childcode": 0"108",
    "infantname": 0"108",
    "productFeeroomSpaceStatusType": {
        "id": 12,
      "code": "DI",
      "name": "City Tax BarcelonaDirty"
    },
    "adultFeereservationRoomStay": 1,null
  },
  "juniorFeeadult": 01,
    "childFeejunior": 0,

   "infantFeechild": 0,
    "pmsLocatorinfant": "XS0000000003/3",
 0,
  "crsLocatorproductFee": null,{
    "id": 767,
    "name": "City Tax Barcelona"
  },
  "adultFee": 0,
  "juniorFee": 0,
  "childFee": 0,
  "infantFee": 0,
  "pmsLocator": "ALI00000002/2",
  "crsLocator": null,
  "otaLocator": null,
  "cmLocator": null,
  "remark": null,
  "mainBoard": {
    "id": 6,
    "code": null,
    "name": "Bed And Breakfast",
    "serviceList": [
      {
        "id": 61,
        "name": "Breakfast"
      }
    ]
  },
  "reservationRoomStayGuests": [
    {
      "id": 2,
      "documentType": {
        "id": 2,
        "code": "2",
        "name": "Passport"
      },
      "documentNumber": "swgcACUU",
      "givenName": "Marie",
      "middleName": "Mélodie",
      "surName": "Hunt",
      "genderType": {
        "id": 1,
        "code": "M",
        "name": "Male"
      },
      "birthDate": "2002-02-13",
      "birthCountryCode": "VU",
      "birthPlace": "Memphis",
      "effectiveDate": "2019-02-13",
      "expireDate": "2019-02-13",
      "street": "2603 Cherokee Drive",
      "city": "Memphis",
      "stateProvName": "Tennessee",
      "stateProvCode": null,
      "countryCode": "VU",
      "postalCode": "38104",
      "nationalityCountryCode": "VU",
      "ocr": null,
      "email": "bhernandezo@instagram.com",
      "phoneNumber": "1-(901)206-4293"
    }
  ],
  "reservationRoomStayDaily": [
    {
      "id": 6,
      "date": "2020-01-14",
      "room": {
        "id": 8,
        "code": "108",
        "name": "108",
        "roomSpaceStatusType": {
          "id": 2,
          "code": "DI",
          "name": "Dirty"
        },
        "reservationRoomStay": null
      },
      "allotment": null,
      "rate": {
        "id": 1,
        "code": "BAR",
        "name": "Best Available Rate"
      },
      "price": 124.200000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "offer": {
        "id": 1,
        "code": "NR",
        "name": "Non Refundable"
      },
      "offerAmountDiscount": 0.000000,
      "offerPercentDiscount": 10.000000,
      "promotion": null,
      "promotionAmountDiscount": null,
      "promotionPercentDiscount": null,
      "board": {
        "id": 6,
        "code": null,
        "name": "Bed And Breakfast",
        "serviceList": [
          {
            "id": 61,
            "name": "Breakfast"
          }
        ]
      },
      "boardPriceAdult": 22.000000,
      "boardPriceJunior": 49.000000,
      "boardPriceChild": 0.000000,
      "boardPriceInfant": 0.000000,
      "paymentType": {
        "id": 5,
        "code": "AG",
        "name": "Pay Agency Guest"
      },
      "propertyPolicy": {
        "id": 7,
        "code": "NR",
        "name": "Non Refundable"
      },
      "propertySource": {
        "id": 8,
        "code": "AGE",
        "name": "Agency"
      },
      "otaLocatorpropertySegment": null,
 {
  "cmLocator": null,     "remarkid": null31,
    "mainProductBoard": null,
    "reservationRoomStayGuestscode": [{"CREWS",
        "idname": 6,"Crews"
      },
      "documentTypepropertyChannel": {
            "id": 511,
            "code": "5WEB",
            "name": "National identityBooking documentEngine"
        },
        "documentNumberbooker": "cJlUaQaW"null,
        "givenNamebillTo": "Martha",{
        "middleNameid": "Mégane"172,
        "surNamename": "PetersonTagfeed",
        "genderTypecode": {null,
            "idtaxId": 2"75310161",

           "codeiataId": "F"null,
        "companyEmailList": [
    "name": "Female"     {
   },         "birthDateid": "2001-07-18"172,
            "birthCountryprimary": {true,
            "idemailAddressType": 199,{
              "codeid": "ESP"1,
              "namecode": "SPAIN1",
        },         "birthPlacename": "ChicagoPersonal",
           "effectiveDate": "2018-07-18", },
            "expireDateemail": "2018-07-18rsnyder4g@quantcast.com",
            "streetremark": "9036 Lien Place",null
         "city": "Chicago", }
        "stateProvName": null],
        "stateProvcompanyAddressList": {[
            "id": 24,
{
            "codeid": "ES-H"172,
            "nameprimary": "Huelva"true,
            "countrycommunicationLocationType": {
 {
              "id": 1991,
                "code": "ESP1",
 
              "name": "SPAINHome"
            },
        },    "street": "09914 Lunder   "country": {Point",
             "idcity": 199"Dallas",
            "codestateProvName": "ESPTexas",
            "namestateProvCode": "SPAIN"null,
        },         "postalCode": "6063675310",
        "nationalityCountry": {
            "idcountryCode": 199"HT",
            "coderemark": "ESPAddress Remark",
            "name": "SPAIN"}
         }],
        "ocrcompanyPhoneList": null,[
          {
            "emailid": "bbutler65@hao123.com"172,
        "phoneNumber": "1-(773)942-9428"
    "primary": true,
   }],         "reservationRoomStayDailyphoneLocationType": [{
              "id": 3,6,
              "datecode": "2019-06-206",
        "allotment      "name": null, "Home"
           "rate": { },
            "idphoneTechType": {
2,              "codeid": "BB"1,
              "namecode": "Bed And Breakfast1",
        },      "name": "Voice"
 "price": 248.800000,         "currency": { },
            "idcountryAccessCode": 1"+34",
            "codeareaCityCode": "EURB",
            "namephoneNumber": "Euro"1-(214)166-4006",
        },
        "offerextension": {"1",
            "idremark": 3, "Phone Remark"
          }
  "code": "MIN7N",      ],
        "namecompanyTaxAddress": {
"Minimum 7 nights"        "id": }162,
          "offerAmountDiscountcommunicationLocationType": 0.000000null,
          "offerPercentDiscountstreet": 20.000000,"09914 Lunder Point",
          "promotioncity": null, "Dallas",
          "promotionAmountDiscountstateProvName": null"Texas",
          "promotionPercentDiscountstateProvCode": null,
          "productBoardpostalCode": {"75310",
            "idcountryCode": 167"NZ",
            "nameremark": "FullBoardAddress Remark"
        },
        "boardPriceAdultremark": 20.000000,
        "boardPriceJunior": 15.000000,
 "Company Remarks"
       "boardPriceChild": null,  },
      "boardPriceInfantcentral": null,
        "paymentTypecompany": {null
    }
  ],
    "idreservationRoomStayServiceList": 3,[
    {
       "codeid": "A"1,
            "name"service": "Pay{
Agency"        "id": }70,
        "propertyPolicyname": {
            "id": 62,"Hostess"
      },
      "codestartDate": "48H2020-01-14",
 
          "nameendDate": "48 Hours Before Arrival""2020-01-15",
      "quantity": 1,
    },  "reservationRoomStayServiceDailyList": [
     "propertySource": {  {
          "id": 621,
            "codedate": "EMA2020-01-14",
 
          "namerate": "Email" null,
           },"price": 10.000000,
          "propertySegmentcurrency": {
            "id": 1071,
            "code": "DUSEEUR",
            "name": "Euro"Day
 Use"         },
          "propertyChanneloffer": {null,
            "idofferAmountDiscount": 17null,
            "codeofferPercentDiscount": "GDS"null,
 
          "namepromotion": "GDS"null,
        },         "booker"promotionAmountDiscount": null,
          "billTopromotionPercentDiscount": {
 null,
          "idpostingDate": 377,"2020-02-13"
        }
   "name": "World 2 Meet" ]
    },
  },  {
      "centralid": null2,

       "companyservice": {
            "id": 13272,
 
          "name": "BestDayTelevision"
        },
    }],     "reservationRoomStayServiceListstartDate": [{
"2020-01-14",
       "idendDate": 6"2020-01-15",
        "servicequantity": {1,
            "id"reservationRoomStayServiceDailyList": 347,[
        {
   "name": "Meeting Room"     "id": 2,
  },         "startDatedate": "20192020-0601-2014",
          "endDaterate": "2019-06-21", null,
          "quantityprice": 110.000000,
          "reservationRoomStayServiceDailyListcurrency": [{
                "id": 111,

               "datecode": "2019-06-20EUR",
            "name": "Euro"
  "rate": null,        },
          "priceoffer": 10.000000null,

               "currencyofferAmountDiscount": {
          null,
          "idofferPercentDiscount": 1null,
          "promotion": null,
          "codepromotionAmountDiscount": "EUR"null,
          "promotionPercentDiscount": null,
          "namepostingDate": "Euro2020-02-13"
        }
      ]
},    },
     {
      "offerid": null3,
      "service": {
        "offerAmountDiscountid": null74,
        "name": "Parking"
      },
      "offerPercentDiscountstartDate": null"2020-01-14",
         "endDate": "2020-01-15",
      "promotionquantity": null1,
      "reservationRoomStayServiceDailyList": [
        "promotionAmountDiscount": null,{
          "id": 3,
     "promotionPercentDiscount": null,      "date": "2020-01-14",
          "postingDaterate": null
,
           }"price": 10.000000,
          "currency":  {
                "id": 121,
                "datecode": "2019-06-21EUR",
            "name": "Euro"
  "rate": null,        },
          "priceoffer": 10.000000null,
          "offerAmountDiscount": null,
    "currency      "offerPercentDiscount": null,
 {         "promotion": null,
          "idpromotionAmountDiscount": 1null,
          "promotionPercentDiscount": null,
          "codepostingDate": "EUR2020-02-13",
        }
      ]
    "name": "Euro"},
    {
      "id": 4,
      "service": {
},        "id": 72,
        "offer": null,
 name": "Television"
       },
      "offerAmountDiscountstartDate": null"2020-01-14",
      "endDate": "2020-01-15",
        "offerPercentDiscountquantity": null1,
      "reservationRoomStayServiceDailyList": [
        "promotion": null,{
          "id": 4,
     "promotionAmountDiscount": null,      "date": "2020-01-14",
          "promotionPercentDiscountrate": null,
     
          "postingDateprice": "2019-07-18"10.000000,
          "currency": {
}         ]     }]"id": 1,
    "reservationRoomStayAssignDailyList": [{         "idcode": 3"EUR",
            "datename": "2019-06-20Euro",
        "room": {  },
          "idoffer": 6null,
            "codeofferAmountDiscount": "106"null,
            "nameofferPercentDiscount": "R106"null,
            "roomSpaceStatusTypepromotion": {null,
                "id"promotionAmountDiscount": 2null,
                "code"promotionPercentDiscount": "DI"null,
                "name"postingDate": "Dirty2020-02-13"
        }
   }    ]
    }
 
  }]
}