Space
Familiarize yourself with the particulars of the space endpoint.
Description
A space represents an area or volume bounded actually or theoretically. Spaces are areas or volumes that provide for certain functions within a building. Space data can be pushed to the BuildingMinds Platform via this API.
Add spaces
POST Request: {{BASE_URL}}/space
Pre-Requisite: For a space to be added via BuildingMinds API, a floor must be on-boarded with a floorId.
- For the space to be on-boarded, a {{floorID}} from the related floor is required.
- If you create a space with a random floor ID, it will remain in a NEW state. A floor with the specified ID must be successfully created before the space can proceed to a COMPLETED state.
Field attributes
Field | Type | Description |
---|---|---|
climateCooled | boolean | Is the space climate cooled? (Y/N) |
climateHeated | boolean | Is the space climate heated? (Y/N) |
coUseArea | boolean | Is the space being used by multiple tenants? (Y/N) |
effectZonesCooling | number | Area that is cooled minimum: 1; maximum: 9999 |
effectZonesHeating | number | Area that is heated minimum: 1; maximum: 9999 |
effectZonesBentilation | number | Area that is ventilated minimum: 1; maximum: 9999 |
energyRatingIds | string, array | Array of energyRating IDs minLength: 1; maxLength: 50 |
eventType | string | Type of the event as specific domain event Options: SpaceAdded, SpaceUpdated, SpaceDeleted |
extensionData | json | Extension data for storing any custom data |
floorId | string | Reference to the floor which the space belongs to minLength: 1; maxLength: 50 (mandatory) |
maximumOccupancy | number | Define maximum occupancy of space minimum: 1; maximum: 9000 |
name | string | User-specific space name minLength: 1; maxLength: 200 (mandatory) |
primaryCeilingMaterial | string | Material of celiling minLength: 1; maxLength: 75 |
primaryFloorMaterial | string | Material of floor minLength: 1; maxLength: 75 |
primaryWallMaterial | string | Material of wall minLength: 1; maxLength: 75 |
rentability | boolean | Status of the space; is the space eligible for renting out? (Y/N) |
spaceCode | string | User specific space Code minLength: 1; maxLength: 70 |
spaceHeight | number | Actual space height e.g: 3.6 m minumum: 2; maximum: 999 |
spaceHeightUsable | number | Usable height of space minimum: 2; maximum: 999 |
spaceId | string | Unique identifier; must either originate from the previous system or be explicitly defined minLength: 1; maxLength: 50 (mandatory) |
spaceNumber | number | Number of space minimum: 1; maximum: 99999 |
spaceVolumeGross | number | Gross volume of space including surrounding walls minimum: 1; maximum: 999999 |
spaceVolumeNet | number | Net volume of space excluding surrounding walls minimum: 1; maximum: 999999 |
type | string | Type of space minLength: 1; maxLength: 70 (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 until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) minLength: 20 (mandatory) |
ventilationType | string | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery Options: Exhaust, Supply, Balanced, Heat-recovery |
workAreaIds | string, array | Array of Work area IDs minLength: 1; maxLength: 50 |
[
{
"climateCooled": true,
"climateHeated": true,
"coUseArea": true,
"effectZonesCooling": 9999,
"effectZonesHeating": 9999,
"effectZonesVentilation": 9999,
"energyRatingIds": [
"string"
],
"eventType": "SpaceAdded",
"extensionData": {
"additionalProp1": {}
},
"floorId": "string",
"maximumOccupancy": 99999,
"name": "string",
"primaryCeilingMaterial": "string",
"primaryFloorMaterial": "string",
"primaryWallMaterial": "string",
"rentability": true,
"spaceCode": "string",
"spaceHeight": 999,
"spaceHeightUsable": 999,
"spaceId": "string",
"spaceNumber": 99999,
"spaceVolumeGross": 999999,
"spaceVolumeNet": 999999,
"type": "string",
"validFrom": "stringstringstringst",
"validUntil": "stringstringstringst",
"ventilationType": "Exhaust",
"workAreaIds": [
"string"
]
}
]
Update space
For the space to be updated, {{floorID}} from the related floor is required.
- If you try to update a space with a random floor ID, it will remain in NEW state. A floor with the specified IDs must be successfully created before the space can proceed to a COMPLETED state.
- The only change will be in the eventType: SpaceUpdated.
POST Request:{{BASE_URL}}/space
[
{
"climateCooled": true,
"climateHeated": true,
"coUseArea": true,
"effectZonesCooling": 9999,
"effectZonesHeating": 9999,
"effectZonesVentilation": 9999,
"energyRatingIds": [
"string"
],
"eventType": "SpaceUpdated",
"extensionData": {
"additionalProp1": {}
},
"floorId": "string",
"maximumOccupancy": 99999,
"name": "string",
"primaryCeilingMaterial": "string",
"primaryFloorMaterial": "string",
"primaryWallMaterial": "string",
"rentability": true,
"spaceCode": "string",
"spaceHeight": 999,
"spaceHeightUsable": 999,
"spaceId": "string",
"spaceNumber": 99999,
"spaceVolumeGross": 999999,
"spaceVolumeNet": 999999,
"type": "string",
"validFrom": "stringstringstringst",
"validUntil": "stringstringstringst",
"ventilationType": "Exhaust",
"workAreaIds": [
"string"
]
}
]
Delete space
Most of the schema will be the same as the adding space and this will be a POST request too, but the only change will be in the eventType: SpaceDeleted.
- For the space to be deleted, {{floorID}} from the related floor is required.
- In case you delete a space, only the space will be deleted and not the on-boarded floor.
POST Request:{{BASE_URL}}/space
[
{
"climateCooled": true,
"climateHeated": true,
"coUseArea": true,
"effectZonesCooling": 9999,
"effectZonesHeating": 9999,
"effectZonesVentilation": 9999,
"energyRatingIds": [
"string"
],
"eventType": "SpaceDeleted",
"extensionData": {
"additionalProp1": {}
},
"floorId": "string",
"maximumOccupancy": 99999,
"name": "string",
"primaryCeilingMaterial": "string",
"primaryFloorMaterial": "string",
"primaryWallMaterial": "string",
"rentability": true,
"spaceCode": "string",
"spaceHeight": 999,
"spaceHeightUsable": 999,
"spaceId": "string",
"spaceNumber": 99999,
"spaceVolumeGross": 999999,
"spaceVolumeNet": 999999,
"type": "string",
"validFrom": "stringstringstringst",
"validUntil": "stringstringstringst",
"ventilationType": "Exhaust",
"workAreaIds": [
"string"
]
}
]
View status of space
Based on the batchID generated you can GET the batch of the on-boarded space 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.
Updated 3 months ago