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

PropertyTypeRequiredType parameterDefault valueDescription
chainIdStringtruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
reservationRoomStayIdIntegertruepath parameter
Unique identificator of the reservationRoomStay.


Example request

Code Block
languagepowershell
themeDJango
GET https://prodpublicapi-providers.ulysescloud.com/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": 211766,
  	"reservationStatusType": {
    		"id": 51,
    		"code": "CORES",
    		"name": "CheckedOutReserved"
  },
  		"arrivalnameI18n": "2020-01-14Reserved",
		"colorCode": "#43a047"
	},
	"departurearrival": "20202021-08-01-15",
	"departure": "2021-08-02",
	"arrivalTime": null,
  	"departureTime": null,
  	"quantity": 1,
  	"accommodation": {
		"id": 632707,
		"name": "SingleDouble",
		"roomType": {
			"id": 217,
			"name": "SingleDouble",
			}
  },
  "room"nameI18n": {
    "id": 8,
    "code": "108",
    "name": "108",
    "roomSpaceStatusType": {
      "id": 2,
      "code": "DI",
      "Double",
			"mainImage": "1/2/propertyroomtypeimages/6e8184e4-ecc6-4d86-a56d-24d3776688df.jpg"
		}
	},
	"room": null,
	"adult": 2,
	"junior": 0,
	"child": 0,
	"infant": 0,
	"accommodationAmount": null,
	"boardAmount": null,
	"serviceAmount": null,
	"totalAmount": null,
	"productFee": {
		"id": 812,
		"name": "Dirty"City Tax Barcelona"
  	},
    "reservationRoomStay	"pmsLocator": null
  }"ALI00006915/11766",
  	"adultcrsLocator": 1null,
  	"juniorotaLocator": 0null,
  	"childcmLocator": 0null,
  	"infantremark": 0null,
  	"productFeereservationRoomStayGuests": [{
    		"id": 76722045,
		"documentType": null,
		"documentNumber": null,
		"namegivenName": "City Tax Barcelona"
  },
  "adultFee": 0,
  "juniorFee": 0,
  "childFee": 0,
  "infantFee": 0,
  "pmsLocator": "ALI00000002/2",
  "crsLocatortest",
		"surName": "test",
		"secondSurName": null,
		"genderType": null,
		"birthDate": null,
		"birthCountryCode": null,
  		"otaLocatorbirthPlace": null,
  		"cmLocatoreffectiveDate": null,
		"expireDate": null,
		"remarkstreet": null,
  		"mainBoardcity": {
    "idnull,
		"stateProvName": 6null,
    "code		"stateProvCode": null,
    "name		"countryCode": "Bed And BreakfastES",
		"postalCode": null,
		"nationalityCountryCode": null,
		"serviceListcountryOfIssuanceCode": [
      {
        null,
		"ocr": null,
		"email": null,
		"phoneNumber": null,
		"allowMarketing": null,
		"allowThirdParty": null,
		"language": {
			"id": 611,
        "name			"code": "BreakfastES",
			"name": "Spanish",
			"nameI18n": "Spanish"
		}
 	}
    ]
  },
  	"reservationRoomStayGuestsmainBoard": [
    {
      		"id": 25,
      "documentType		"code": {
        "RO",
		"name": "Room Only",
		"serviceList": null
	},
	"reservationRoomStayDaily": [{
		"id": 256374,
        "code		"date": "22021-08-01",
        "name		"room": null,
		"Passportallotment"
      },
      "documentNumber": "swgcACUU",
      "givenName": "Marie",
      "secondSurName": "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"
      },
      "amountAfterTax": 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"
      },
      "propertySegment": {
        "id": 31,
        "code": "CREWS",
        "name": "Crews"
      },
      "propertyChannel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "booker": null,
      "billTo": {
        "id": 172,
        "name": "Tagfeed",
        "code": null,
        "taxId": "75310161",
        "iataId": null,
        "companyEmailList": [
          {
            "id": 172,
            "primary": true,
            "emailAddressType": {
              "id": 1,
              "code": "1",
              "name": "Personal"
            },
            "email": "rsnyder4g@quantcast.com",
            "remark": null
          }
        ],
        "companyAddressList": [
          {
            "id": 172,
            "primary": true,
            "communicationLocationType": {
              "id": 1,
              "code": "1",
              "name": "Home"
            },
            "street": "09914 Lunder Point",
            "city": "Dallas",
            "stateProvName": "Texas",
            "stateProvCode": null,
            "postalCode": "75310",
            "countryCode": "HT",
            "remark": "Address Remark"
          }
        ],
        "companyPhoneList": [
          {
            "id": 172,
            "primary": true,
            "phoneLocationType": {
              "id": 6,
              "code": "6",
              "name": "Home"
            },
            "phoneTechType": {
              "id": 1,
              "code": "1",
              "name": "Voice"
            },
            "countryAccessCode": "+34",
            "areaCityCode": "B",
            "phoneNumber": "1-(214)166-4006",
            "extension": "1",
            "remark": "Phone Remark"
          }
        ],
        "companyTaxAddress": {
          "id": 162,
          "communicationLocationType": null,
          "street": "09914 Lunder Point",
          "city": "Dallas",
          "stateProvName": "Texas",
          "stateProvCode": null,
          "postalCode": "75310",
          "countryCode": "NZ",
          "remark": "Address Remark"
        },
        "remark": "Company Remarks"
      },
      "central": null,
      "company": null
    }
  ],
  "reservationRoomStayServiceList": [
    {
      "id": 1,
      "service": {
        "id": 70,
        "name": "Hostess"
      },
      "startDate": "2020-01-14",
      "endDate": "2020-01-15",
      "quantity": 1,
      "reservationRoomStayServiceDailyList": [
        {
          "id": 1,
          "date": "2020-01-14",
          "rate": null,
          "amountAfterTax": 10.000000,
          "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro"
          },
          "offer": null,
          "offerAmountDiscount": null,
          "offerPercentDiscount": null,
          "promotion": null,
          "promotionAmountDiscount": null,
          "promotionPercentDiscount": null,
          "postingDate": "2020-02-13"
        }
      ]
    },
    {
      "id": 2,
      "service": {
        "id": 72,
        "name": "Television"
      },
      "startDate": "2020-01-14",
      "endDate": "2020-01-15",
      "quantity": 1,
      "reservationRoomStayServiceDailyList": [
        {
          "id": 2,
          "date": "2020-01-14",
          "rate": null,
          "amountAfterTax": 10.000000,
          "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro"
          },
          "offer": null,
          "offerAmountDiscount": null,
          "offerPercentDiscount": null,
          "promotion": null,
          "promotionAmountDiscount": null,
          "promotionPercentDiscount": null,
          "postingDate": "2020-02-13"
        }
      ]
    },
    {
      "id": 3,
      "service": {
        "id": 74,
        "name": "Parking"
      },
      "startDate": "2020-01-14",
      "endDate": "2020-01-15",
      "quantity": 1,
      "reservationRoomStayServiceDailyList": [
        {
          "id": 3,
          "date": "2020-01-14",
          "rate": null,
          "amountAfterTax": 10.000000,
          "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro"
          },
          "offer": null,
          "offerAmountDiscount": null,
          "offerPercentDiscount": null,
          "promotion": null,
          "promotionAmountDiscount": null,
          "promotionPercentDiscount": null,
          "postingDate": "2020-02-13"
        }
      ]
    },
    {
      "id": 4,
      "service": {
        "id": 72,
        "name": "Television"
      },
      "startDate": "2020-01-14",
      "endDate": "2020-01-15",
      "quantity": 1,
      "reservationRoomStayServiceDailyList": [
        {
          "id": 4,
          "date": "2020-01-14",
          "rate": null,
          "amountAfterTax": 10.000000,
          "currency": {
            "id": 1,
            "code": "EUR",
            "name": "Euro"
          },
          "offer": null,
          "offerAmountDiscount": null,
          "offerPercentDiscount": null,
          "promotion": null,
          "promotionAmountDiscount": null,
          "promotionPercentDiscount": null,
          "postingDate": "2020-02-13"
        }
      ]
    }
  ]: null,
		"rate": null,
		"amountBeforeTax": 0.000000,
		"amountAfterTax": 0.000000,
		"amountNetAfterTax": 0.000000,
		"amountNetBeforeTax": 0.000000,
		"amountInvoiceAfterTax": 0.000000,
		"amountInvoiceBeforeTax": 0.000000,
		"accommodationAmount": 0.000000,
		"accommodationAmountAfterDiscount": 0.000000,
		"accommodationAmountAfterTax": 0.000000,
		"accommodationAmountBeforeTax": 0.000000,
		"accommodationAmountNetAfterTax": 0.000000,
		"accommodationAmountNetBeforeTax": 0.000000,
		"accommodationAmountInvoiceAfterTax": 0.000000,
		"accommodationAmountInvoiceBeforeTax": 0.000000,
		"centralAccommodationPercentageCommission": null,
		"centralAccommodationAmountCommission": null,
		"centralBoardPercentageCommission": null,
		"centralBoardAmountCommission": null,
		"companyAccommodationPercentageCommission": null,
		"companyAccommodationAmountCommission": null,
		"companyBoardPercentageCommission": null,
		"companyBoardAmountCommission": null,
		"bookerAccommodationPercentageCommission": null,
		"bookerAccommodationAmountCommission": null,
		"bookerBoardPercentageCommission": null,
		"bookerBoardAmountCommission": null,
		"billToAccommodationPercentageCommission": null,
		"billToAccommodationAmountCommission": null,
		"billToBoardPercentageCommission": null,
		"billToBoardAmountCommission": null,
		"billToAccommodationPercentageDiscount": null,
		"billToAccommodationAmountDiscount": null,
		"billToBoardPercentageDiscount": null,
		"billToBoardAmountDiscount": null,
		"currency": {
			"id": 1,
			"code": "EUR",
			"name": "Euro",
			"nameI18n": "Euro",
			"symbol": "€",
			"decimalPlaces": 2
		},
		"offer": null,
		"offerAmountDiscount": null,
		"offerPercentDiscount": null,
		"promotion": null,
		"promotionAmountDiscount": null,
		"promotionPercentDiscount": null,
		"board": {
			"id": 5,
			"code": "RO",
			"name": "Room Only",
			"serviceList": null
		},
		"boardAmountAfterDiscountAdult": 0.000000,
		"boardAmountAdult": 0.000000,
		"boardAmountAfterTaxAdult": 0.000000,
		"boardAmountBeforeTaxAdult": 0.000000,
		"boardAmountNetAfterTaxAdult": 0.000000,
		"boardAmountNetBeforeTaxAdult": 0.000000,
		"boardAmountInvoiceAfterTaxAdult": 0.000000,
		"boardAmountInvoiceBeforeTaxAdult": 0.000000,
		"boardAmountAfterDiscountJunior": 0.000000,
		"boardAmountJunior": 0.000000,
		"boardAmountAfterTaxJunior": 0.000000,
		"boardAmountBeforeTaxJunior": 0.000000,
		"boardAmountNetAfterTaxJunior": 0.000000,
		"boardAmountNetBeforeTaxJunior": 0.000000,
		"boardAmountInvoiceAfterTaxJunior": 0.000000,
		"boardAmountInvoiceBeforeTaxJunior": 0.000000,
		"boardAmountAfterDiscountChild": 0.000000,
		"boardAmountChild": 0.000000,
		"boardAmountAfterTaxChild": 0.000000,
		"boardAmountBeforeTaxChild": 0.000000,
		"boardAmountNetAfterTaxChild": 0.000000,
		"boardAmountNetBeforeTaxChild": 0.000000,
		"boardAmountInvoiceAfterTaxChild": 0.000000,
		"boardAmountInvoiceBeforeTaxChild": 0.000000,
		"boardAmountAfterDiscountInfant": 0.000000,
		"boardAmountInfant": 0.000000,
		"boardAmountAfterTaxInfant": 0.000000,
		"boardAmountBeforeTaxInfant": 0.000000,
		"boardAmountNetAfterTaxInfant": 0.000000,
		"boardAmountNetBeforeTaxInfant": 0.000000,
		"boardAmountInvoiceAfterTaxInfant": 0.000000,
		"boardAmountInvoiceBeforeTaxInfant": 0.000000,
		"paymentType": {
			"id": 1,
			"code": "G",
			"name": "Pay Guest",
			"nameI18n": "Pay Guest"
		},
		"propertyPolicy": {
			"id": 12,
			"code": "24H",
			"name": "24 Hours 1 Night"
		},
		"propertySource": {
			"id": 13,
			"code": "PHO",
			"name": "Phone"
		},
		"propertySegment": {
			"id": 19,
			"code": "HACC",
			"name": "Home Account"
		},
		"propertyChannel": {
			"id": 11,
			"code": "WEB",
			"name": "Booking Engine"
		},
		"booker": null,
		"billTo": null,
		"central": null,
		"company": null,
		"reservationGroup": null
	}],
	"reservationRoomStayServiceList": [{
		"id": 17477,
		"service": {
			"id": 64,
			"code": "COT",
			"name": "Cot"
		},
		"startDate": "2021-08-01",
		"endDate": "2021-08-05",
		"quantity": 7,
		"totalAmountAfterTax": 128.000000,
		"totalAmountBeforeTax": 160.000000,
		"reservationRoomStayServiceDailyList": [{
				"id": 83330,
				"date": "2021-08-04",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			},
			{
				"id": 83334,
				"date": "2021-08-03",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			},
			{
				"id": 83335,
				"date": "2021-08-02",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			},
			{
				"id": 83336,
				"date": "2021-08-01",
				"rate": null,
				"amountBeforeTax": 29.090909,
				"amountAfterTax": 32.000000,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro",
					"nameI18n": "Euro",
					"symbol": "€",
					"decimalPlaces": 2
				},
				"offer": null,
				"offerAmountDiscount": null,
				"offerPercentDiscount": null,
				"promotion": null,
				"promotionAmountDiscount": null,
				"promotionPercentDiscount": null,
				"bookerPercentageCommission": null,
				"bookerAmountCommission": null,
				"billToPercentageCommission": null,
				"billToAmountCommission": null,
				"billToPercentageDiscount": null,
				"billToAmountDiscount": null,
				"centralPercentageCommission": null,
				"centralAmountCommission": null,
				"companyPercentageCommission": null,
				"companyAmountCommission": null,
				"postingDate": null
			}
		]
	}],
	"createdDate": "2021-06-24T15:54:16.890Z",
	"modifiedDate": "2021-06-24T16:32:29.219Z",
	"deposit": {
    	"productPayment" : {
	        "code" : "VI"
	    },
	    "amount" : 100,
	    "productDeposit" : {
	        "code" : "DEPRE"
	    },
	    "chargeId":"ch_3MA9wDGjGBQ6ROtO0Rm9mtudss"
	},
	"reservationType" : {
   		"id": 2,
        "chainId": 1,
        "propertyId": 2,
        "code": "PREVIEW",
        "name": "Pending Review",
        "colorCode": "#FDD835",
        "active": true
	}
}