Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Comments

Maximum character length/limit

Description

inputCreatePropertyPlantInputMandatoryNot RelevantCreatePropertyPlant input model
applicationNamestringMandatory
Third party application identifier, identifying the client consuming the web service. (Length of the ApplicationName 
Should be less than or equal to 10 charactersThe name of the integration partner

CreatePropertyPlantInput

Parameter

Type

Mandatory/Optional

CommentsDescription

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

Image Added

Response

Type

Description

CreatePropertyPlantOutputCreatePropertyPlantOutput model

Response - output sample

Image Added

CreatePropertyPlantOutput

Parameter

Type

CommentsDescription

PropertyPlantPropertyPlantCreated Property InfoInformation

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
117Provided Snr provided is not validinvalid
118Snr is not provided with the input matrikkel. But given is Matrikkel for a sectioned property
119Snr is provided with the input matrikkel. But given is not a Matrikkel for a non-sectioned property
123An exception occurred while processing your request
138ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10)
146The application name applicationName is not set
188Matrikkel is not provided
214The given property does not exists exist in the system
339Given 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.
340Please provide address Address details (Street nameStreetName, House no HouseNumber and Postal codeZipCode)
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 provde either  provide the Address,  UnitNo and BuildingNo as available.UnitNumber and BuildingNumber