Spaces collection


Create a new space, by either

  • Creating a blank one

  • Using an existing space as a template or

  • Copying an existing space

If template is provided in the request body, the new space will be linked to another space to be used as it's template. In most hotels, there are usually a few primary room types, with little variance across them. The template feature allows for rapid creation and easy maintenance of identical rooms: changes to the template room will be reflected in other rooms too.

The template will replicate the specific contents of the space (rooms, scenes and assigned logical devices with it's configuration) of the template space to the linked target space and ensure that when changes to the template are made, the changes are reflected in the linked spaces as well. Directly editing (e.g. adding new room, space, logical devices and removing logical devices) a space with a linked template is not possible, without unlinking the space first.

The URI parameter - sourceSpaceId allows making copies of an existing space. Combination of templating and copying has the following three behaviors:

  • If the space referenced by sourceSpaceId owns a template, then the new space will inherit all the room(s), space(s) and logical device(s) (not physical device) with the configuration of the sourceSpaceId space. In this case, no room, space and logical device can be added to or delete from the new space. Only phsical device can be assigned to or unassigned from the logical device. As new space inherits all the room(s), space(s) and logical device(s) (not physical device) with the configuration of sourceSpaceId space by template, so any change of room, space and logical device in sourceSpaceId space will be available in new space too.

  • If the space referenced by sourceSpaceId is using another space as a template, then the new space will inherit all the room(s), space(s) and logical device(s) (not physical device) with the configuration of that root space from where sourceSpaceId space inherited. In this case, no room, space and logical device can be added to or delete from the new space. Only phsical device can be assigned to or unassigned from the logical device. As new space inherits all the room(s), space(s) and logical device(s) (not physical device) with the configuration of that root space from where sourceSpaceId space inherited, so any change of room, space and logical device in sourceSpaceId space will be available in new space too.

  • If the space referenced by sourceSpaceId does not have it's own or inherited template, then the new space will only copy the content and device configuration from sourceSpaceId space (if it has any content) once. As sourceSpaceId does not have any template, any content change in sourceSpaceId space will not be available in new space. In this case, the new space can be edited, means new rooms, scenes, logical devices can be added to or remove from the new space.