Versions Compared

Version Old Version 2 New Version 3
Changes made by

David Garcerán

David Garcerán

Saved on

Key

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

Operation

Get a list of active RoomMode of one Property

Rw ui textbox macro
typewarning

Only accessible with permission of pmsIntegrationRoom


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}/roomMode



Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
offsetIntegerfalse0Offset of the array of results.
limitIntegerfalse10Limit of results.


Example request

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





Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity

Property

Insert excerpt

Type

PropertyRoomMode

RequiredDescriptionIdStringtrueUnique identifier of the entity.

property

PropertytrueThe data of PropertychainRoomModeChainRoomModetrueThe data of ChainRoomModeactiveBooleanfalseactive/inactive objectRoomPropertyRoomModeSetRoomPropertyRoomModefalseset of RoomPropertyRoomMode's

PropertyRoomMode
nopaneltrue

Example response

Code Block
themeDJango
{
  "count": 13,
  "offset": 0,
  "limit": 10,
  "list": [
    {
      "id": 14,
      "createdDatename": "2020-03-18T11:59:16.098ZDon't disturb",
      "createdUsercode": 12"DND",
      "propertyactive": nulltrue,
      "chainRoomModeinactiveReason": {
 null,
      "idapplied": 1,null
    },
   "createdDate": "2020-03-18T11:25:08.148Z",
  {
      "modifiedDateid": "2020-03-18T11:53:44.078Z",
 5,
      "modifiedUsername": "Service 12requested",
 
      "code": "TEST1SER",
 
      "nameactive": "Test 1 updated 1",
 true,
      "nameI18nIdinactiveReason": 5491null,
 
      "nameI18napplied": "Testnull
1",    },
    "description": "Test Number 1",
 {
      "descriptionI18nIdid": 54926,
 
      "descriptionI18nname": "TestCleaning Number 1requested",
 
      "iconcode": "Icon 1CLE",
 
      "propertyRoomModeSetactive": null
      }true,
      "activeinactiveReason": truenull,
      "roomPropertyRoomModeSetapplied": null
    }
  ]
}