CreatePropertyPlant
Description
This method is used to create property plants which includes Regular, Sectioned and Housing Cooperatives.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
input | CreatePropertyPlantInput | Mandatory | Not Relevant | CreatePropertyPlant input model |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
CreatePropertyPlantInput
Parameter | Type | Mandatory/Optional | Description |
---|---|---|---|
Matrikkel | Matrikkel | Mandatory | Matrikkel information |
Address | Address | Optional | Address information |
UnitNumber | string | Optional | Unit Number of the property |
BuildingNumber | long | Optional | Building Number |
ShareNumber | int | Optional | Share Number (If a housing cooperative share) |
OrganizationNumber | int | Optional | Organization Number |
NOTE
- Matrikkel information is mandatory. Provide as much information as possible to efficiently find a property.Â
- Building plants CANNOT be created with this method. Â Please use the CreateBuildingPlant method instead.
- Generally for regular and sectioned properties  a property plant can be created by using only the Matrikkel. However there are instances where the Matrikkel alone is insufficient to identify the property uniquely. The user  is required to provide more details like the Address, UnitNumber and BuildingNumber.
- Housing cooperative shares require either the ShareNumber and OrganizationNumber or the Address, UnitNumber and BuildingNumber along with the Matrikkel. It is more efficient to provide the ShareNumber and OrganizationNumber for housing cooperatives.
Request - input sample
Response
Type | Description |
---|---|
CreatePropertyPlantOutput | CreatePropertyPlantOutput model |
Response - output sample
CreatePropertyPlantOutput
Parameter | Type | Description |
---|---|---|
PropertyPlant | PropertyPlant | Created Property Information |
Exceptions
Error Code | Description |
---|---|
105 | Plant already exists in the system |
107 | Plant creation failed due to an internal error |
109 | Given Matrikkel does not exist in the system |
117 | Snr provided is invalid |
118 | Snr is not provided with the input Matrikkel for a sectioned property |
119 | Snr is provided with the input Matrikkel for a non-sectioned property |
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 |
188 | Matrikkel is not provided |
214 | The given property does not exist in the system |
339 | Given data is not enough to identify the property. Please provide either ShareNumber and OrganizationNumber or Address, UnitNumber and BuildingNumber as available |
340 | Please provide Address details (StreetName, HouseNumber and ZipCode) |
341 | The following building does not contain any properties, Please use CreateBuildingPlant web service to create a building plant |
346 | Given data is not enough to identify the property. Please provide the Address, UnitNumber and BuildingNumber |