Description
CreateBuildingPlant web This method is used to create a plant for a building by providing the building information and Matrikkel.
Request
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
---|---|---|---|---|
building | BuildingInput | Mandatory | Not Relevant | Building number BuildingNumber and iteration (løpenr). Building number BuildingNumber is mandatory. Iteration can be zero. |
matrikkelMatrikkel | Matrikkel | Mandatory | Not Relevant | Matrikkel of the building. |
applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service. (Length of the ApplicationName should Should be less than or equal to 10 ) |
Note:
Building Iteration is ignored from the code and there is no need to provide the building iteration. This will get obsolete in future
Response
...
characters | The name of the integration partner |
Request - input sample
NOTE: The building iteration (løpenr) will be obsolete in the future.
Response
The CreateBuildingPlant method creates the plant in the system, and return Following properties of returns the following properties for the created plant back to the client.
Type | Description |
---|---|
BuildingPlant | Building and plant info information associated with the newly created plant |
Response - output sample
Exceptions
Error Code | Description |
---|---|
105 | The Plant already exists in the system |
123 | An exception occurred while processing your request |
138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
146 | The application name applicationName is not set |
167 | You are not authorized to use this web method |
187 | Building number BuildingNumber is not provided |
188 | Matrikkel is not provided |
189 | No buildings found are connected to the given matrikkel and building number Matrikkel and BuildingNumber |
200 | The given building number BuildingNumber is not connected to the given matrikkelMatrikkel. Please check your inputs againinput. |
280 | No Buildings There are no buildings available for the given building numberBuildingNumber, mattrikel Matrikkel and iterationIteration |