Description

A floor object usually refers to a storey of a building. A floor has an elevation and typically represents a (nearly) horizontal aggregation of spaces that are vertically bound. Floor data can be pushed to the BuildingMinds Platform via this API.

Add floors

POST Request: {{BASE_URL}}/floor

Pre-Requisite: For a floor to be added via BuildingMinds API, a building must be on-boarded with a buildingId.

For the floor to be on-boarded, a {{buildingID}} from the related floor is required.
If you create a floor with a random building ID, it will remain in a NEW state. A building with the specified ID must be successfully created before the floor can proceed to a COMPLETED state.

Field attributes

Field	Type	Description
buildingId	string	Reference to the Building which the Floor belongs to. minLength: 1; maxLength: 50 (mandatory)
energyRatingIds	string, array	Array of energyRating IDs. minLength: 1; maxLength: 50
eventType	string,enum	Type of the event as specific domain event. Options: FloorAdded, FloorUpdated, FloorDeleted
extensionData	json	Extension data for storing any custom data
floorCode	string	User specific floor Code. minLength: 1; maxLength: 70
floorId	string	Unique identifier; must either originate from the previous system or be explicitly defined minLength: 1; maxLength: 50 (mandatory)
floorNumber	string	Number of floor
name	string	Name of Land e.g: park, garden, parking. minLength: 1; maxLength: 200 (mandatory)
validFrom	string	The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) minLength: 20 (mandatory)
validUntil	string	The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) minLength: 20 (mandatory)
workAreaIds	string, array	Array of work area Ids minLength: 1; maxLength: 50

[
  {
    "buildingId": "string",
    "energyRatingIds": [
      "string"
    ],
    "eventType": "FloorAdded",
    "extensionData": {
      "additionalProp1": {}
    },
    "floorCode": "string",
    "floorId": "string",
    "floorNumber": 0,
    "name": "string",
    "validFrom": "stringstringstringst",
    "validUntil": "stringstringstringst",
    "workAreaIds": [
      "string"
    ]
  }
]

Update floor

For the floor to be updated, {{buildingID}} from the related building are required.

If you try to update a floor with a random building ID, it will remain in NEW state. A building with the specified IDs must be successfully created before the building can proceed to a COMPLETED state.
The only change will be in the eventType: FloorUpdated.

POST Request:{{BASE_URL}}/floor

[
  {
    "buildingId": "string",
    "energyRatingIds": [
      "string"
    ],
    "eventType": "FloorUpdated",
    "extensionData": {
      "additionalProp1": {}
    },
    "floorCode": "string",
    "floorId": "string",
    "floorNumber": 0,
    "name": "string",
    "validFrom": "stringstringstringst",
    "validUntil": "stringstringstringst",
    "workAreaIds": [
      "string"
    ]
  }
]

Delete floor

Most of the schema will be the same as the adding building and this will be a POST request too, but the only change will be in the eventType: FloorDeleted.

For the floor to be deleted, {{buildingID}} from the related building are required.
In case you delete a floor, only the floor will be deleted and not the on-boarded building.

POST Request:{{BASE_URL}}/floor

[
  {
    "buildingId": "string",
    "energyRatingIds": [
      "string"
    ],
    "eventType": "FloorUpdated",
    "extensionData": {
      "additionalProp1": {}
    },
    "floorCode": "string",
    "floorId": "string",
    "floorNumber": 0,
    "name": "string",
    "validFrom": "stringstringstringst",
    "validUntil": "stringstringstringst",
    "workAreaIds": [
      "string"
    ]
  }
]

View status of floor

Based on the batchID generated you can GET the batch of the on-boarded floor with the below mentioned request. This will be the same for both Update and Delete.

GET Request:{{BASE_URL}}/batch/{id}/inbound

Please refer to Batch page for more details.