Description

A land object refers to a defined area of land, possibly covered with water, on which the project construction is to be completed or already completed. Customers can push their land data to BuildingMinds platform by using the BuildingMindsAPI:

Add lands

POST Request: {{BASE_URL}}/land

Pre-Requisite: For a land to be added via BuildingMinds API, a site must be on-boarded with a siteId.

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

Field attributes

Field	Type	Description
addressIds	string	Array of address Ids. minLength: 1; maxLength: 50
eventType	string,enum	Type of the event as specific domain event. Options: LandAdded, LandUpdated, LandDeleted
extensionData	json	Extension data for storing any custom data
landCode	string	User specific Land Code. minLength: 1; maxLength: 70
landCoverage	string	Development level of land minLength: 1; maxLength: 50
landId	string	Unique identifier; must either originate from the previous system or be explicitly defined minLength: 1; maxLength: 50 (mandatory)
landParcelNr	string	District/Zoning number registered for the Plot of land minLength: 1; maxLength: 50
name	string	Name of Land e.g: park, garden, parking. minLength: 1; maxLength: 200 (mandatory)
selfUse	boolean	Is the land self-used or not? (Y/N)
siteId	string	Refers to the site which the land belongs to. minLength: 1 ; maxLength: 50 (mandatory)
status	string	Status of building minLength: 1; maxLength: 50
tenantStructure	string,enum	Are there multiple tenants in the building or only one? Options: Single-tenant, Multi-tenant
typeOfOwnership	string	Is the building owned or leased? Options: Owner, Tenant (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)
valuationIds	string, array	Array of valuation Ids minLength: 1; maxLength: 50

[
  {
    "addressIds": [
      "string"
    ],
    "eventType": "LandAdded",
    "extensionData": {
      "additionalProp1": {}
    },
    "landCode": "string",
    "landCoverage": "string",
    "landId": "string",
    "landParcelNr": "string",
    "name": "string",
    "selfUse": true,
    "siteId": "string",
    "status": "string",
    "type": "string",
    "typeOfOwnership": "Owner",
    "validFrom": "stringstringstringst",
    "validUntil": "stringstringstringst",
    "valuationIds": [
      "string"
    ]
  }
]

Update land

For the land to be updated, {{siteID}} from the related site are required.

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

POST Request:{{BASE_URL}}/land

[
  {
    "addressIds": [
      "string"
    ],
    "eventType": "LandUpdated",
    "extensionData": {
      "additionalProp1": {}
    },
    "landCode": "string",
    "landCoverage": "string",
    "landId": "string",
    "landParcelNr": "string",
    "name": "string",
    "selfUse": true,
    "siteId": "string",
    "status": "string",
    "type": "string",
    "typeOfOwnership": "Owner",
    "validFrom": "stringstringstringst",
    "validUntil": "stringstringstringst",
    "valuationIds": [
      "string"
    ]
  }
]

Delete land

Most of the schema will be the same as the adding land and this will be a POST request too, but the only change will be in theeventType: LandDeleted.

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

POST Request:{{BASE_URL}}/land

[
  {
    "addressIds": [
      "string"
    ],
    "eventType": "LandDeleted",
    "extensionData": {
      "additionalProp1": {}
    },
    "landCode": "string",
    "landCoverage": "string",
    "landId": "string",
    "landParcelNr": "string",
    "name": "string",
    "selfUse": true,
    "siteId": "string",
    "status": "string",
    "type": "string",
    "typeOfOwnership": "Owner",
    "validFrom": "stringstringstringst",
    "validUntil": "stringstringstringst",
    "valuationIds": [
      "string"
    ]
  }
]

View status of land

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

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