Alpha Project
API calls concerning projects
Creates a new project
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects" \ -H "Content-Type: application/json" \ -d '{ "coordinate": { "latitude": -90, "longitude": -180 }, "name": "string", "phase": "PLAN" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Delete by list of ids in current tenant
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects" \ -H "Content-Type: application/json" \ -d '[ "string" ]'Empty
{
"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"
}Delete file
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
blobId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/assets/string/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Upload DXF
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/dxf/string" \ -F file="string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Delete DXF
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/dxf/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Find by list of ids in current tenant
AuthorizationBearer <token>
In: header
Query Parameters
ids*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/find?ids=string"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Find all for current tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/find-all"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Find by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/find/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Get page by page number and size with optional sorting based on field to sortBy and direction
AuthorizationBearer <token>
In: header
Query Parameters
pageNumber?integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"search?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/page"{
"content": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "string"
}
]
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"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"
}Get public house blobs
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
projectId*string
houseId*string
Query Parameters
scenarioId?string
configurationId?string
extension?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/public/string/house-blobs/string/string" \ -H "Content-Type: application/json" \ -d '[ { "code": "string", "option": "string" } ]'[
{
"blobId": "string",
"fileSize": 0,
"name": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"productName": "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"
}Get public house info
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
projectId*string
houseId*string
Query Parameters
scenarioId?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/public/string/house-info/string/string"{
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"bnr": "string",
"choices": [
{
"code": "string",
"option": "string"
}
],
"compensateNulpunt": true,
"models": [
{
"blobId": "string",
"fileSize": 0,
"name": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"productName": "string"
}
],
"options": [
{
"activeViews": [
"string"
],
"category": "string",
"codes": [
{
"code": "string",
"description": "string",
"option": "string",
"price": 0.1,
"visible": true
}
],
"id": "string",
"isNeighborOption": true,
"name": "string",
"neighborOption": true,
"phase": "PLAN",
"visible": true
}
],
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"status": "AVAILABLE",
"typeId": "string",
"views": [
{
"active": true,
"activeCategories": [
"string"
],
"description": "string",
"id": "string",
"maxHeight": 0.1,
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"target": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
}
}
]
}{
"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"
}Upload thumbnail
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/thumbnail/string" \ -F file="string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Delete by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/string"Empty
{
"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"
}Updates a project
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/projects/string" \ -H "Content-Type: application/json" \ -d '{ "coordinate": { "latitude": -90, "longitude": -180 }, "name": "string", "phase": "PLAN" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Registers a view for a house
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
blockId*string
houseId*string
Query Parameters
scenarioId?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/string/blocks/string/houses/string/register-view"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Creates a new block
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/string/blocks/string" \ -H "Content-Type: application/json" \ -d '{ "houses": [ { "baseConfiguration": [ { "code": "string", "option": "string" } ], "choices": [ { "code": "string", "option": "string" } ], "chosenVariables": [ { "id": "string", "value": 0.1 } ], "modelInstances": [ { "modelId": "string" } ], "ownershipType": "RENTED", "planOptions": [ { "code": "string", "option": "string" } ], "status": "AVAILABLE" } ], "position": { "x": 0.1, "y": 0.1, "z": 0.1 }, "rotation": 0.1 }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Update DXF layer settings
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/dxf-layer-settings" \ -H "Content-Type: application/json" \ -d '[ { "filled": true, "name": "string", "visible": true } ]'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Updates a house
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
houseId*string
Query Parameters
scenarioId?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/houses/string" \ -H "Content-Type: application/json" \ -d '{ "baseConfiguration": [ { "code": "string", "option": "string" } ], "choices": [ { "code": "string", "option": "string" } ], "chosenVariables": [ { "id": "string", "value": 0.1 } ], "modelInstances": [ { "modelId": "string" } ], "ownershipType": "RENTED", "planOptions": [ { "code": "string", "option": "string" } ], "status": "AVAILABLE" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Assign a configuration to a house
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
houseId*string
configurationId*string
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/houses/string/assign/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Demote a configuration from a house
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
houseId*string
configurationId*string
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/houses/string/demote/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Creates a new scenario
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/string/scenarios" \ -H "Content-Type: application/json" \ -d '{ "blockPlots": [ { "vertices": [ { "x": 0.1, "y": 0.1, "z": 0.1 } ] } ], "blocks": [ { "houses": [ { "baseConfiguration": [ { "code": "string", "option": "string" } ], "choices": [ { "code": "string", "option": "string" } ], "chosenVariables": [ { "id": "string", "value": 0.1 } ], "modelInstances": [ { "modelId": "string" } ], "ownershipType": "RENTED", "planOptions": [ { "code": "string", "option": "string" } ], "status": "AVAILABLE" } ], "position": { "x": 0.1, "y": 0.1, "z": 0.1 }, "rotation": 0.1 } ], "isFavorite": true, "name": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Updates a scenario
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/scenarios/string" \ -H "Content-Type: application/json" \ -d '{ "blockPlots": [ { "vertices": [ { "x": 0.1, "y": 0.1, "z": 0.1 } ] } ], "blocks": [ { "houses": [ { "baseConfiguration": [ { "code": "string", "option": "string" } ], "choices": [ { "code": "string", "option": "string" } ], "chosenVariables": [ { "id": "string", "value": 0.1 } ], "modelInstances": [ { "modelId": "string" } ], "ownershipType": "RENTED", "planOptions": [ { "code": "string", "option": "string" } ], "status": "AVAILABLE" } ], "position": { "x": 0.1, "y": 0.1, "z": 0.1 }, "rotation": 0.1 } ], "isFavorite": true, "name": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Get project stats
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Query Parameters
scenarioId?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/string/stats"{
"assignedHouseCount": 0,
"availableHouseCount": 0,
"avgConfigurationValue": 0.1,
"avgOptionsPerConfiguration": 0.1,
"avgPricePerHouse": 0.1,
"client": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"dailyRequestsPerType": [
{
"date": "string",
"requestsPerType": {
"property1": 0,
"property2": 0
}
}
],
"favoriteType": "string",
"houseCount": 0,
"projectValue": 0.1,
"requestsPerHouse": {
"property1": 0,
"property2": 0
},
"requestsPerMonth": {
"property1": 0,
"property2": 0
},
"requestsPerType": {
"property1": 0,
"property2": 0
},
"soldHouseCount": 0,
"startOfSales": "2019-08-24T14:15:22Z",
"totalArea": 0.1,
"totalConfigurationRequests": 0,
"typeCount": 0
}{
"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"
}Queue coverage calculation for a type in a project
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
typeId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/string/type-coverage/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"completed": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentAgentId": "string",
"description": "string",
"id": "string",
"message": "string",
"name": "string",
"priority": "LOW",
"progress": 0.1,
"retries": 0,
"runAfter": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"status": "PENDING",
"tenantId": "string",
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"workerName": "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"
}Read the relevant type product coverages for a specific project and type (paginated)
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
typeId*string
Query Parameters
page?integer
Default
0Format
int32size?integer
Default
20Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/string/type-coverage/string/paged"{
"content": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"complete": true,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"glbComplete": true,
"id": "string",
"linkedProductId": "string",
"modelType": "CONCEPT",
"parameters": [
{
"name": "string",
"type": "string",
"value": null
}
],
"productName": "string",
"projectIds": [
"string"
],
"rvtComplete": true,
"staticModelTreeId": "string",
"tenantId": "string",
"totalFileSize": 0,
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variantId": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"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"
}Gets project models for a type
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
typeId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/string/types/string/models"{
"conceptModels": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"complete": true,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"glbComplete": true,
"id": "string",
"linkedProductId": "string",
"modelType": "CONCEPT",
"parameters": [
{
"name": "string",
"type": "string",
"value": null
}
],
"productName": "string",
"projectIds": [
"string"
],
"rvtComplete": true,
"staticModelTreeId": "string",
"tenantId": "string",
"totalFileSize": 0,
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variantId": "string"
}
],
"typeId": "string",
"variantModels": {
"property1": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"complete": true,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"glbComplete": true,
"id": "string",
"linkedProductId": "string",
"modelType": "CONCEPT",
"parameters": [
{
"name": "string",
"type": "string",
"value": null
}
],
"productName": "string",
"projectIds": [
"string"
],
"rvtComplete": true,
"staticModelTreeId": "string",
"tenantId": "string",
"totalFileSize": 0,
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variantId": "string"
}
],
"property2": [
{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"complete": true,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"glbComplete": true,
"id": "string",
"linkedProductId": "string",
"modelType": "CONCEPT",
"parameters": [
{
"name": "string",
"type": "string",
"value": null
}
],
"productName": "string",
"projectIds": [
"string"
],
"rvtComplete": true,
"staticModelTreeId": "string",
"tenantId": "string",
"totalFileSize": 0,
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variantId": "string"
}
]
},
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Queue variant coverage calculation
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
variantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/string/variant-coverage/string"{
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"completed": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentAgentId": "string",
"description": "string",
"id": "string",
"message": "string",
"name": "string",
"priority": "LOW",
"progress": 0.1,
"retries": 0,
"runAfter": "2019-08-24T14:15:22Z",
"started": "2019-08-24T14:15:22Z",
"status": "PENDING",
"tenantId": "string",
"typeId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"workerName": "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"
}Creates a new variant
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/string/variants" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "typeId": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Deletes a variant
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
variantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/string/variants/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Updates a variant
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
variantId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/variants/string" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "typeId": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Creates a new block plot
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/string/string/block-plots" \ -H "Content-Type: application/json" \ -d '{ "vertices": [ { "x": 0.1, "y": 0.1, "z": 0.1 } ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Deletes a block plot
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
plotId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/string/string/block-plots/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Updates a block plot
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
plotId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/string/block-plots/string" \ -H "Content-Type: application/json" \ -d '{ "vertices": [ { "x": 0.1, "y": 0.1, "z": 0.1 } ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Deletes multiple houses
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/string/string/blocks/houses/bulk" \ -H "Content-Type: application/json" \ -d '[ "string" ]'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Deletes a block
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
blockId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/string/string/blocks/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Updates a block
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
blockId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/projects/string/string/blocks/string" \ -H "Content-Type: application/json" \ -d '{ "houses": [ { "baseConfiguration": [ { "code": "string", "option": "string" } ], "choices": [ { "code": "string", "option": "string" } ], "chosenVariables": [ { "id": "string", "value": 0.1 } ], "modelInstances": [ { "modelId": "string" } ], "ownershipType": "RENTED", "planOptions": [ { "code": "string", "option": "string" } ], "status": "AVAILABLE" } ], "position": { "x": 0.1, "y": 0.1, "z": 0.1 }, "rotation": 0.1 }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Creates a new house
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
blockId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/string/string/blocks/string/houses" \ -H "Content-Type: application/json" \ -d '{ "baseConfiguration": [ { "code": "string", "option": "string" } ], "choices": [ { "code": "string", "option": "string" } ], "chosenVariables": [ { "id": "string", "value": 0.1 } ], "modelInstances": [ { "modelId": "string" } ], "ownershipType": "RENTED", "planOptions": [ { "code": "string", "option": "string" } ], "status": "AVAILABLE" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Creates multiple houses
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
blockId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/projects/string/string/blocks/string/houses/bulk" \ -H "Content-Type: application/json" \ -d '[ { "baseConfiguration": [ { "code": "string", "option": "string" } ], "choices": [ { "code": "string", "option": "string" } ], "chosenVariables": [ { "id": "string", "value": 0.1 } ], "modelInstances": [ { "modelId": "string" } ], "ownershipType": "RENTED", "planOptions": [ { "code": "string", "option": "string" } ], "status": "AVAILABLE" } ]'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Deletes a house
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
blockId*string
houseId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/projects/string/string/blocks/string/houses/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"client": "string",
"color": "string",
"completion": "2019-08-24T14:15:22Z",
"contractor": "string",
"coordinate": {
"latitude": -90,
"longitude": -180
},
"costs": [
{
"amount": 0.1,
"name": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"dxfBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"dxfLayerSettings": [
{
"customColor": "string",
"filled": true,
"name": "string",
"visible": true
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"favoriteScenario": "string",
"id": "string",
"imageBlob": {
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
},
"name": "string",
"phase": "PLAN",
"pricing": {
"baseRentPriceUnit": 0.1,
"baseSalePriceUnit": 0.1,
"baseUnit": "M2"
},
"projectCosts": 0.1,
"scenarios": [
{
"blockPlots": [
{
"color": "string",
"id": "string",
"linkedBlockId": "string",
"name": "string",
"vertices": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1
}
]
}
],
"blocks": [
{
"description": "string",
"houses": [
{
"assignedConfigurationId": "string",
"baseConfiguration": [
{
"code": "string",
"option": "string"
}
],
"basePrice": 0.1,
"buyer": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"clientId": "string",
"email": "string",
"name": "string",
"phone": "string"
},
"choices": [
{
"code": "string",
"option": "string"
}
],
"chosenVariables": [
{
"id": "string",
"value": 0.1
}
],
"cost": 0.1,
"id": "string",
"modelInstances": [
{
"configuredFacadeId": "string",
"modelId": "string"
}
],
"optionPrice": 0.1,
"ownershipType": "RENTED",
"planOptions": [
{
"code": "string",
"option": "string"
}
],
"potentialConfigurations": [
"string"
],
"profit": 0.1,
"saleRevenue": 0.1,
"status": "AVAILABLE",
"typeId": "string",
"variantId": "string",
"views": [
{
"frequency": 0,
"ip": "string",
"time": "2019-08-24T14:15:22Z"
}
]
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"profit": 0.1,
"revenue": 0.1,
"rotation": 0.1
}
],
"id": "string",
"name": "string",
"numberOfHouses": 0,
"revenue": 0.1
}
],
"startOfSales": "2019-08-24T14:15:22Z",
"subsidiaryId": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variants": [
{
"description": "string",
"id": "string",
"name": "string",
"typeId": "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"
}Calculates the geometry of a project
AuthorizationBearer <token>
In: header
Path Parameters
projectId*string
scenarioId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/projects/string/string/calculate-geometry"{
"area": 0.1,
"blocks": [
{
"area": 0.1,
"facadeSurface": 0.1,
"houses": [
{
"area": 0.1,
"compensateNulpunt": true,
"dimensions": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"id": "string",
"massModels": {
"property1": [
{
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"level": 0,
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"type": "Box"
}
],
"property2": [
{
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"level": 0,
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"type": "Box"
}
]
},
"models": {
"property1": [
{
"configuredFacade": {
"baseElementId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"id": "string",
"openings": [
{
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": 0.1,
"type": "WINDOW"
}
],
"panels": [
{
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": 0,
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": 0.1
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"level": 0,
"material": "string",
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"type": "WALL"
}
],
"property2": [
{
"configuredFacade": {
"baseElementId": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"id": "string",
"openings": [
{
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": 0.1,
"type": "WINDOW"
}
],
"panels": [
{
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": 0,
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": 0.1
}
],
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"dimensions": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"id": "string",
"level": 0,
"material": "string",
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"type": "WALL"
}
]
},
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"staticModels": [
{
"exhaustiveOptions": [
"string"
],
"id": "string",
"isEmpty": true,
"isExhaustive": true,
"name": "string",
"parameters": [
{
"name": "string",
"type": "string",
"value": null
}
],
"position": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
},
"rotation": {
"x": {
"formula": "string",
"isConstant": true
},
"y": {
"formula": "string",
"isConstant": true
},
"z": {
"formula": "string",
"isConstant": true
}
}
}
],
"typeId": "string",
"variableValues": [
{
"id": "string",
"value": 0.1
}
],
"volume": 0.1
}
],
"id": "string",
"position": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"rotation": {
"x": 0.1,
"y": 0.1,
"z": 0.1
},
"volume": 0.1
}
],
"facadeSurface": 0.1,
"id": "string",
"volume": 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"
}