About Managing Properties, Room Types, and Rooms

Your Alexa Smart Properties for hospitality administrator users perform several important property management tasks, such as managing properties, room types, and rooms. Use the Role API and the Property, Room Type, and Room API to develop tools to enable your users to perform these tasks at scale.

Example: How different roles create and manage properties and rooms

The following example shows how the different types of Alexa Smart Properties for hospitality administrator roles described in About Managing Roles in Alexa Smart Properties for Hospitality work together to create and manage properties, room types, and rooms.

In this example, there are two hypothetical administrators, Ana Carolina Silva and John Doe, who work for a property management company.

Step 1: Register and assign roles

Ana registers her organization with Alexa Smart Properties for hospitality.

  • An Alexa Smart Properties for hospitality organizational unit is created. Ana is assigned as A4H.OrgAdmin and receives an Alexa Smart Properties for hospitality organization (amzn1.alexa.unit.did.{id}) identifier to use when calling Alexa Smart Properties for hospitality APIs.
  • Ana can now create properties, room types, and rooms under the Alexa Smart Properties for hospitality organizational unit.

Step 2: Create a property

Ana creates property A: amzn1.alexa.unit.did.AEGK5CKMNVWNDA7UFFZE4KZIJTKSGCGDTTMSRMYMQCAEZZG7A2SD5TBPYYM2QUHL7LDMLT7AE4YDALZM653CJBNSGTI5EUQU35T4BQT7.

  • As creator of the property, Ana automatically has the A4H.PropertyAdmin role for property A.
  • Ana can create, update, or delete property A, create room types and rooms in property A, and manage property A's resources.

Step 3: Create a room type

Ana creates room type A within property A: amzn1.alexa.unit.did.AEYCW45GYHMUG622G44G6ZAGBQUDDRVJZT2YKFHPN5UDMGYAXS6S436V5IEUULHS2722CYHOE5BGZMPAIT2VLJAZEUQC2ULVWNOA3VHL.

  • As creator of the room type, Ana automatically has the A4H.RoomTypeAdmin role for room type A.
  • Ana can manage room type A.

Step 4: Create a room

Ana creates room 100 under room type A: amzn1.alexa.unit.did.AF2B2LU7KDOZAMUJRTVCT66DWPFP3BOQ4RZ5GPHAVCIJTMQBJHEDHLANZOJFZSKLG6X2SVE3YCCUZVCP5R7RNZBKI6KHYHGFFLVFIVVJKNU24O45BRMHPBGQ35IPRBZTSI.

  • As the creator of the room, Ana automatically has the A4H.RoomAdmin role for room 100.
  • Ana can manage room 100 and its resources.

Step 5: Assign the property administrator role

Ana creates property B. Ana lists user roles for property B.

  • Ana assigns John to the A4H.PropertyAdmin role for property B.
  • John can manage property B and its resources.
  • John can't manage property A and its resources.

You successfully implemented the tasks that your administrator users must perform to manage properties, room types, and rooms. Next, see Alexa Smart Properties for Hospitality Device Purchase and Setup to learn how to set up devices and manage them as endpoints.

Last updated: Mar 21, 2022