Versions Compared

Old Version 4

changes.mady.by.user Buddhika Wijesinghe (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Sandrina Abeywardene (Unlicensed)

Saved on

Key

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

Description

CreateBuildingPlant web This method is used to create a plant for a building by providing the building information and Matrikkel. 

Request

ParameterTypeMandatory/Optional
Comments
Maximum character length/limitDescription
buildingBuildingInputMandatory
Building number
Not RelevantBuildingNumber and iteration (løpenr).
Building number
BuildingNumber is mandatory
. Iteration can be zero
.
matrikkel
MatrikkelMatrikkel
Optional
MandatoryNot RelevantMatrikkel of the building.
Must be provided when trying to create a plant for a building which is not yet registered in Boligmappa systemplantNamestringOptionalPreferred name for the plant. If not provided default plant name (BuildingNumber / Iteration) will be setcustomerNamestringMandatoryName of customer for the plant. (Length of the CustomerName must
applicationNamestringMandatoryShould be less than or equal to
100)applicationNamestringMandatoryThird party application identifier, identifying the client consuming the web service. (Length of the ApplicationName should be less than or equal to 10)
10 charactersThe name of the integration partner

Request - input sample

Image Added


NOTE: The building iteration (løpenr) will be obsolete in the future. 

Response

The CreateBuildingPlant web method will create creates the Plant plant in the system, and return Following properties of returns the following properties for the created plant back to the client.

...

TypeDescription
Plant
BuildingPlantBuilding and plant
info
information associated with the newly created plant

 

Response - output sample

Image Added

Exceptions

Error CodeDescription
105The Plant already exists in the system
123An exception occurred while processing your request
138
ApplicationName
applicationName length
is
has exceeded the maximum
allowed
character limit allowed (10) 
146The
application name CustomerName length is exceeded maximum allowed character limit (100)
applicationName is not set
172
167You are not authorized to use this web method
187
Building number
BuildingNumber is not provided
188
Given building
Matrikkel is not
registered in Boligmappa. Please provide the matrikkel to add building.
provided
189No buildings
found 190Customer name is not set123An exception occured while processing your request
are connected to the given
matrikkel and building number
Matrikkel and BuildingNumber
200The given BuildingNumber is not connected to the given Matrikkel. Please check your input.
280There are no buildings available for the given BuildingNumber, Matrikkel and Iteration