GeneratePropertySummaryDocument

Description

This method is used to generate a summary document of all the documents uploaded by professionals to a given property (displayed only if IsVisibleInBoligmappa is set to TRUE when documents are uploaded). It also displays documents uploaded by the property owner, if that property is a publicly shared Boligmappa property. This method is accessible only for Ambita users.

Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
inputGeneratePropertySummaryDocumentInputMandatoryNot relevantProperty Summary Document Input
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner

BoligmappaNumber or Matrikkel or ShareNumber together with the OrganizationNumber is mandatory for GeneratePropertySummaryDocumentInput. If the user provides several input values, along with the BoligmappaNumber, priority is given to the BoligmappaNumber. 

NOTE:

  • Verify that the given information corresponds to a single property
  • When all the property information is given the priorities are as follows:
    1. BoligmappaNumber
    2. ShareNumber together with OrganizationNumber
    3. Mattrikkel


GeneratePropertySummaryDocumentInput

PropertyTypeDescription
BoligmappaNumberstringBoligmappaNumber of the Property
MatrikkelMatrikkelMatrikkel of the property
AddressAddressAddress of the property
UnitNumberstringUnitNumber of the property
BuildingNumberlongBuildingNumber of the property
ShareNumberintShareNumber of the property
OrganizationNumberintOrganizationNumber of the property

Request - sample input

<GeneratePropertySummaryDocument>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <BoligmappaNumber>AAA5296</BoligmappaNumber>
      <Matrikkel>
        <Knr>704</Knr>
        <Gnr>139</Gnr>
        <Bnr>53</Bnr>
        <Fnr>0</Fnr>
        <Snr>1</Snr>
      </Matrikkel>
      <Address>
        <StreetName>Rosenlundveien</StreetName>
        <HouseNumber>20</HouseNumber>
        <HouseLetter>B</HouseLetter>
        <ZipCode>3150</ZipCode>
        <City isNull="false" />
      </Address>
      <UnitNumber>H0101</UnitNumber>
      <BuildingNumber>0</BuildingNumber>
      <ShareNumber>0</ShareNumber>
      <OrganizationNumber>914350804</OrganizationNumber>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</GeneratePropertySummaryDocument>

Response

TypeDescription
GeneratePropertySummaryDocumentOutputGeneratePropertySummaryDocumentOutput model


GeneratePropertySummaryDocumentOutput

Parameter

Type

Description

PropertySummaryDocumentstringDownload Url of the generated summary document

Response - sample input

<GeneratePropertySummaryDocument>
  <MethodParameters>
    <GeneratePropertySummaryDocumentOutput>
      <PropertySummaryDocument>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX0UMfQyxS9qSAg2n3mDOcDksbJ9RLvIFsOivSNe6aTHb</PropertySummaryDocument>
    </GeneratePropertySummaryDocumentOutput>
  </MethodParameters>
</GeneratePropertySummaryDocument>

Exceptions

Error CodeDescription

110

Input parameters contain null or invalid data

113

One or more mandatory fields have not been provided 

123

An exception occurred while processing your request

167

You are not authorized to use this method

339Given data is not enough to identify the property. Provide either ShareNo and OrganizatioNo or Address, UnitNo and BuildingNo as available