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://prodpublicapi-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": 39,
  "offset": 1,
  "limit": 1,
  "list": [
    {
      "id": 2,
      "reservationStatusType": {
        "id": 5,
        "code": "CO",
        "name": "CheckedOut"
      },
      "arrival": "2020-01-14",
      "departure": "2020-01-15",
      "arrivalTime": null,
      "departureTime": null,
      "quantity": 1,
      "accommodation": {
			"id": 632,
			"name": "Single",
			"roomType": {
				"id": 2,
				"name": "Single"
			}
	  },
      "room": {
        "id": 8,
        "code": "108",
        "name": "108",
        "roomSpaceStatusType": {
          "id": 2,
          "code": "DI",
          "name": "Dirty"
        },
        "reservationRoomStay": null
      },
      "adult": 1,
      "junior": 0,
      "child": 0,
      "infant": 0,
      "productFee": {
        "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",
          "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"
            }
          ]
        }
      ]
    }
  ]
}