Description
CreateBuildingPlant web This method is used to create a plant for a building by providing the building information and Matrikkel.
Notes:
Request
| Parameter | Type | Mandatory/Optional |
|---|
Comments| Maximum character length/limit | Description |
|---|
| building | BuildingInput | Mandatory |
Building number | Not Relevant | BuildingNumber and iteration (løpenr). |
Building number | BuildingNumber is mandatory |
. Iteration can be zeromatrikkelOptional| Not Relevant | Matrikkel of the building. |
Must be provided when trying to create a plant for a building which is not yet registered in Boligmappa system| plantName | string | Optional | Preferred name for the plant. If not provided default plant name (BuildingNumber / Iteration) will be set |
customerName | |
| applicationName | string | Mandatory |
Name of customer for the plant. (Length of the CustomerName must | Should be less than or equal to |
100)| applicationName | string | Mandatory | Name of customer for the plant. (Length of the CustomerName must be less than or equal to 100) |
Response
| Property | Type | Description |
|---|
Plant| 10 characters | The name of the integration partner |
Request - input sample
Image Added
NOTE: The building iteration (løpenr) will be obsolete in the future.
Response
The CreateBuildingPlant method creates the plant in the system, and returns the following properties for the created plant.
info | information associated with the newly created plant |
Response - output sample
Image Added
Exceptions
| Error Code | Description |
|---|
| 105 | The Plant already exists in the system |
| 123 | An exception occurred while processing your request |
| 138 | applicationName length has exceeded the maximum character limit allowed (10) |
| 146 | The applicationName is not set |
| 167 | You are not authorized to use this web method |
| 187 | BuildingNumber is not provided |
| 188 | Matrikkel is not provided |
| 189 | No buildings are connected to the given Matrikkel and BuildingNumber |
| 200 | The given BuildingNumber is not connected to the given Matrikkel. Please check your input. |
| 280 | There are no buildings available for the given BuildingNumber, Matrikkel and Iteration |