ProjectFML

Structure overview

A complete floor plan is described in FML as a combination of <project>, <floor> and <design> tags. The structure of these tags is shown below. See the DesignFML page for more information on how to describe a design in FML.

<project>
  ...
  <floors type="array">
    <floor>
      ...
      <designs type="array">
        <design>
          ...
        </design>
      </designs>
    </floor>
  </floors>
</project>

Project

A project always starts with a <project> tag. Depending on if you are importing or exporting a design, the number of child tags can vary.

Import

<project>
  <name>string</name>
  <description>string</description> [optional]
  <public>boolean</public> [optional]
  <external-identifier>string</external-identifier> [optional] restriction: can't start with a number
</project>

Export

<project>
  <id>int</id>
  <name>string</name>
  <description>string</description>
  <public>boolean</public>
  <created-at>datetime</created-at>
  <updated-at>datetime</updated-at>
  <project-url>string</project-url>
  <user-id>int</user-id>
  <external-identifier>string</external-identifier> [optional]
</project>

Floor

A floor always starts with a <floor> tag. Depending on if you are importing or exporting a design, the number of child tags can vary.

Import

<floor>
  <name>string</name>
  <level>int</level>
  <height>float</height>
</floor>

Export

<floor>
  <id>int</id>
  <name>string</name>
  <level>int</level>
  <height>float</height>
  <created-at>datetime</created-at>
  <updated-at>datetime</updated-at>
</floor>

Design

See the DesignFML page for more information on how to describe a design in FML.