Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Get a single element of Reservation by its Id.

Only accessible with permission of pms.integration.room

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}/room/{roomId}



Request

PropertyTypeRequiredDefault valueDescription
chainIdStringtrue

Unique identificator of the Chain.

propertyIdStringtrue
Unique identificator of the Hotel.
roomIdStringtrue
Unique identificator of the Room.


Example request

Code Block
languagepowershell
themeDJango
GET https://prod.ulysescloud.com/api/v1/chain/1/property/1/room/1



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success opertarion.

Entity

PropertyTypeRequiredDescription
idStringtrueUnique identifier of the Room.
codeStringtrueThe code of the Room.
nameStringtrueThe name of the Room.
roomSpaceStatusType
RoomSpaceStatusType
trueRoomSpaceStatusType were the Room is linked to.
reservationRoomStay
ReservationRoomStay 
falseReservationRoomStay were the Room is linked to.


Example response

Code Block
themeDJango
{
  "id": 1,
  "code": "101",
  "name": "101",
  "roomSpaceStatusType": {
    "id": 1,
    "code": "CL",
    "name": "Clean"
  },
  "reservationRoomStay": null
}