Alpha API ReferenceConfiguration
Get Neighbor Houses
Returns the neighboring houses in the same block as the given house, with positions relative to the target house.
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
projectId*string
houseId*string
Query Parameters
scenarioId?string
extension?string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/configurations/public/string/string/string/neighbors"{
"blockId": "string",
"blockPlotEdgeFencing": {
"property1": "HEDGE",
"property2": "HEDGE"
},
"blockPlotVertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
],
"blockPosition": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"blockRotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"housePlots": [
{
"houseId": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"houses": [
{
"compensateInsertion": true,
"dimensions": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"houseId": "string",
"mirrored": true,
"models": [
{
"blob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"materialBreakdown": [
{
"areaM2": 0.1,
"categories": "string",
"materialName": "string",
"volumeM3": 0.1
}
],
"name": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"productId": "string",
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"staticModelTreeId": "string"
}
],
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"typeId": "string"
}
],
"targetHouseDimensions": {
"x": 0.1,
"y": 0.1,
"z": 0.1
}
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}