Description
CreateBuildingPlant web method is used to create a plant for a building by providing building information and Matrikkel.
Request
Parameter | Type | Mandatory/Optional | Comments |
---|---|---|---|
building | BuildingInput | Mandatory | Building number and iteration (løpenr). Building number is mandatory. Iteration can be zero. |
matrikkel | Matrikkel | Optional | 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 | string | Mandatory | Name of customer for the plant. (Length of the CustomerName must be less than or equal to 100) |
applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service. (Length of the ApplicationName should be less than or equal to 10) |
Response
CreateBuildingPlant web method will create the Plant in the system, and return Following properties of created plant back to the client.
Property | Type | Description |
---|---|---|
Plant | BuildingPlant | Building and plant info associated with the newly created plant |
Exceptions
Error Code | Description |
---|---|
105 | Plant already exists in system |
138 | ApplicationName length is exceeded maximum allowed character limit (10) |
146 | The application name is not set |
172 | CustomerName length is exceeded maximum allowed character limit (100) |
187 | Building number is not provided |
188 | Given building is not registered in Boligmappa. Please provide the matrikkel to add building. |
189 | No buildings found connected to the given matrikkel and building number |
190 | Customer name is not set |
123 | An exception occured while processing your request |
Add Comment