List of Room with ReservationRoomStaySummary[GET]

Operation

A list of Room from the Property with the current assigned ReservationRoomStayS summary

GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/room/reservationRoomStaySummary


Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/2/room/reservationRoomStaySummary


Response

PropertyTypeRequiredDescription
List of RoomListtrue

Entity Room


FieldTypeRequiredDescription
idIntegertrueUnique identificator of the Room.
codestringtrueCode of the Room
namestringtrueName of the Room
startDateLocalDatefalseStart date of Room
endDateLocalDatefalseEnd date of Room
descriptionstringfalseDescription of Room.
descriptionI18nstringfalseDescription of Room in I18n.
roomSituationTypeRoomSituationTypetrueSituation of the Room (see ref. table).

roomSpaceStatusType

RoomSpaceStatusTypefalseStatus of the inner Space.
reservationRoomStayReservationRoomStayfalseRelated stay that has this Room assigned.
reservationRoomStaySummaryReservationRoomStaySummaryfalseRelated stay summary that has this room assigned. Only show if have data.
spaceLockSpaceLockfalseSpace lock. Only show if have data.
roomTypeRoomTypefalseRoom Type. Only show if have data.


Example response

[{
  "id" : 154,
  "code" : "3216",
  "name" : "C216",
  "startDate": "2023-09-23",
  "endDate": "2024-09-23",
  "description": "Room 101, at first floor.",
  "descriptionI18n": "Room 101, at first floor.",
  "roomSpaceStatusType" : {
    "id" : 1,
    "code" : null,
    "name" : "Clean",
    "nameI18n" : null
  },
  "reservationRoomStay" : null,
  "reservationRoomStaySummary" : {
    "id" : 54446,
    "reservationRoomStay" : null,
    "reservationRoomStayId" : 54615,
    "reservation" : null,
    "reservationId" : 40466,
    "reservationGroup" : null,
    "pmsLocator" : "LG00040466/54615",
    "crsLocator" : null,
    "otaLocator" : null,
    "cmLocator" : "BDC-2880566871TRI30000",
    "holder" : "DI POLITO , JORGE",
    "arrival" : "2022-01-02",
    "departure" : "2022-01-04",
    "nights" : 2,
    "productAccommodation" : null,
    "productAccommodationUpgrade" : null,
    "roomType" : null,
    "adult" : 3,
    "junior" : 0,
    "child" : 0,
    "infant" : 0,
    "extraBed" : 0,
    "extraCot" : 0,
    "board" : null,
    "guest" : "DI POLITO HANSEN , JORGE OCTAVIO",
    "allotment" : null,
    "rate" : null,
    "offer" : null,
    "promotion" : null,
    "accommodationAmount" : null,
    "boardAmount" : null,
    "serviceAmount" : null,
    "totalAmount" : null,
    "totalPaid" : null,
    "balance" : null,
    "currency" : null,
    "booker" : null,
    "billTo" : null,
    "central" : null,
    "company" : null,
    "room" : null,
    "paymentType" : null,
    "propertyPolicy" : null,
    "propertySource" : null,
    "propertyChannel" : null,
    "propertySegment" : null,
    "reservationStatusType" : {
      "id" : 4,
      "code" : "IH",
      "name" : "InHouse",
      "nameI18n" : "InHouse",
      "colorCode" : "#64b5f6"
    },
    "expiredDate" : null,
    "hasCredit" : null,
    "creditAvailable" : null
  },
  "roomSituationType" : {
    "id" : 2,
    "code" : "OC",
    "name" : "Occupied",
    "nameI18n" : "Occupied"
  }
}, {
  "id" : 155,
  "code" : "3217",
  "name" : "C217",
  "startDate": "2023-09-23",
  "endDate": "2024-09-23",
  "roomSpaceStatusType" : {
    "id" : 2,
    "code" : null,
    "name" : "Dirty",
    "nameI18n" : null
  },
  "reservationRoomStay" : null,
  "roomSituationType" : {
    "id" : 3,
    "code" : "BL",
    "name" : "Blocked",
    "nameI18n" : "Blocked"
  },
  "spaceLock" : {
    "createDate" : "2022-01-01T18:41:55.9404915",
    "userId" : 13,
    "id" : 121,
    "startDate" : "2022-01-02",
    "endDate" : "2022-01-04",
    "remark" : "GOTERA SPA",
    "spaceLockType" : {
      "id" : 3,
      "code" : "BL",
      "name" : "Bloqueo (no descuenta)",
      "description" : null,
      "nameI18n" : "Bloqueo (no descuenta)"
    },
    "spaceLockStatusType" : {
      "id" : 1,
      "code" : "LOC",
      "name" : "Locked",
      "colorCode" : "#ff9800",
      "nameI18n" : "Locked"
    }
  }
}]