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://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": 1,
  "reservationStatusType": {
    "id": 5,
    "code": "CO",
    "name": "CheckedOut",
    "nameI18n": "CheckedOut",
    "colorCode": "#757575"
  },
  "arrival": "2020-05-10",
  "departure": "2020-05-13",
  "arrivalTime": null,
  "departureTime": null,
  "quantity": 1,
  "accommodation": {
    "id": 677,
    "name": "Double",
    "roomType": {
      "id": 17,
      "name": "Double",
      "nameI18n": "Double",
      "mainImage": "1/2/propertyroomtypeimages/1cb6be6d-5056-484d-9c95-c574f4603a35.jpg"
    }
  },
  "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"
    }
  },
  "adult": 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,
	  "reservationGroup": 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,
            "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": 8,
        "code": "GDS",
        "name": "Global Distribution System"
      },
      "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,
      "reservationGroup": null
    },
    {
      "id": 3,
      "date": "2020-05-12",
      "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": 7,
        "code": "CRS",
        "name": "Central ReservationSystem"
      },
      "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,
	  "reservationGroup": null
    }
  ],
  "reservationRoomStayServiceList": null
}