Description
CreatePropertyPlant is a general web service method which can be This method is used to create any type of properties including property plants which includes Regular, Sectioned and Housing CopprativesCooperatives.
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 | CommentsDescription |
---|---|---|---|
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 cooparative cooperative share) |
OrganizationNumber | int | Optional | Organization Number |
Note :NOTE
- It Matrikkel information is mandatory to provide the matrikkel information. However it is adviced to provide as many information as posible to find the property more efficiently.
- It is NOT posible to create building plants from this web method. CreateBuildingPlant web method should be used to create building plants
- For regular and sectioned properties most of the time it is posible to create the property plant by using only the matrikkel. However there can be scenarios the matrikkel alone is not engouh to identify the property uniquely, Therefore, the user will be asked to provide more details such as Address, UnitNo and Building No.
- For housing cooprative shares it is needed to provide either share number and organization number or address, unit number and building number along with the matrikkel. However, it is efficient to provide share number and organization number for housing cooperatives
Response
...
Type
...
Description
...
- . 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 | CommentsDescription |
---|---|---|
PropertyPlant | PropertyPlant | Created Property InfoInformation |
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 | Provided Snr provided is not validinvalid |
118 | Snr is not provided with the input matrikkel. But given is Matrikkel for a sectioned property |
119 | Snr is provided with the input matrikkel. But given is not a Matrikkel for a non-sectioned property |
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 |
188 | Matrikkel is not provided |
214 | The given property does not exists exist in the system |
339 | Given data is not enough to identify the property. Please provde either ShareNo and OrganizatioNo or provide either ShareNumber and OrganizationNumber or Address, UnitNo UnitNumber and BuildingNo as BuildingNumber as available. |
340 | Please provide address Address details (Street nameStreetName, House no HouseNumber and Postal codeZipCode) |
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 provde either provide the Address, UnitNo and BuildingNo as available.UnitNumber and BuildingNumber |