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

inputCreatePropertyPlantInputMandatoryNot RelevantCreatePropertyPlant input model
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner

CreatePropertyPlantInput

Parameter

Type

Mandatory/Optional

Description

MatrikkelMatrikkelMandatoryMatrikkel information
AddressAddressOptionalAddress information
UnitNumberstringOptionalUnit Number of the property
BuildingNumberlongOptionalBuilding Number
ShareNumberintOptionalShare Number (If a housing cooperative share)
OrganizationNumberintOptionalOrganization 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

CreatePropertyPlantOutputCreatePropertyPlantOutput model

Response - output sample

CreatePropertyPlantOutput

Parameter

Type

Description

PropertyPlantPropertyPlantCreated Property Information

Exceptions

Error Code

Description

105Plant already exists in the system
107Plant creation failed due to an internal error
109Given Matrikkel does not exist in the system
117Snr provided is invalid
118Snr is not provided with the input Matrikkel for a sectioned property
119Snr is provided with the input Matrikkel for a non-sectioned property
123An exception occurred while processing your request
138applicationName length has exceeded the maximum character limit allowed (10)
146The applicationName is not set
188Matrikkel is not provided
214The given property does not exist in the system
339Given data is not enough to identify the property. Please provide either ShareNumber and OrganizationNumber or Address, UnitNumber and BuildingNumber as available
340Please provide Address details (StreetName, HouseNumber and ZipCode)
341The following building does not contain any properties, Please use CreateBuildingPlant web service to create a building plant
346Given data is not enough to identify the property. Please provide the Address, UnitNumber and BuildingNumber