GetDocumentsByBoligmappaNumber2 - New

Note

  • This is an upgraded version of the GetDocumentsByBoligmappaNumber method with more metadata. Use this method as the previous is now obsolete.

  • GetDocumentsByBoligmappaNumberInput is a single input parameter introduced in this method to enclose all the existing input parameters of the previous method in a single place with the exception of the applicationName. 

Authorization 

A special level of permission is required to access this method as it is only available for the real-estate agent role. Please request permission from Boligmappa. 

Description

This method is used to retrieve documents related to a property or a building using the BoligmappaNumber. The documents retrieved are those which have been uploaded by professionals (retrieved only if IsVisibleInBoligmappa is set to TRUE when documents are uploaded).

Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
inputGetDocumentsByBoligmappaNumberInputMandatoryNot relevantGetDocumentsByBoligmappaNumber input model
applicationNamestringMandatoryShould be less than or equal to 10 characters

The name of the integration partner

 

GetDocumentsByBoligmappaNumberInput


ParameterTypeMandatory/OptionalDescription
BoligmappaNumberstringMandatoryBoligmappaNumber

Request - sample input

<GetDocumentsByBoligmappaNumber2>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <BoligmappaNumber>AAF8476</BoligmappaNumber>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetDocumentsByBoligmappaNumber2>

Response

TypeDescription
GetDocumentsByBoligmappaNumberOutputGetDocumentsByBoligmappaNumber output

 

GetDocumentsByBoligmappaNumberOutput


ParameterTypeDescription
DocumentsList<AuditorDocument>List of documents for the given BoligmappaNumber

 

Response - sample output

<GetDocumentsByBoligmappaNumber2>
  <MethodParameters>
    <GetDocumentsByBoligmappaNumberOutput>
      <Documents attr0="AuditorDocumentArray" isNull="false">
        <AuditorDocumentArray0>
          <DocumentId>57446</DocumentId>
          <FileName>Advanced-Test-Automation-Engineer-Syllabus-GA-2016.pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>2</DocumentTypeId>
          <Title>Advanced-Test-Automation-Engineer-Syllabus-GA-2016.pdf</Title>
          <Description isNull="true" />
          <UpdatedDate>11/13/2017 2:13:24 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX5jhG5zSwhj3d6I9jL5mJyFFJRae9nuAvjtP2DcqyM%2f1</Url>
          <CompanyName>VEGA 1 AS</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>2</Id>
              <TagName>Informasjon om produkter i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
            <ChapterTagOutputArray1>
              <Id>3</Id>
              <TagName>Informasjon om tekniske anlegg i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray1>
          </ChapterTags>
        </AuditorDocumentArray0>
        <AuditorDocumentArray1>
          <DocumentId>57457</DocumentId>
          <FileName>Advanced-Test-Automation-Engineer-Syllabus-GA-2016 (1) (1).pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>0</DocumentTypeId>
          <Title>Advanced-Test-Automation-Engineer-Syllabus-GA-2016 (1) (1).pdf</Title>
          <Description isNull="true" />
          <UpdatedDate>11/13/2017 3:41:43 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX67NRNBt4f094H9%2f%2fNR1UQVsXn76hUIAm9gPRjH04fvI</Url>
          <CompanyName>VEGA 1 AS</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>3</Id>
              <TagName>Informasjon om tekniske anlegg i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
            <ChapterTagOutputArray1>
              <Id>4</Id>
              <TagName>Samsvarserklæringer og garantibevis</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray1>
            <ChapterTagOutputArray2>
              <Id>8</Id>
              <TagName>Takster og prospekter</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray2>
          </ChapterTags>
        </AuditorDocumentArray1>
        <AuditorDocumentArray2>
          <DocumentId>57465</DocumentId>
          <FileName>Advanced-Test-Automation-Engineer-Syllabus-GA-2016 (1) (1).pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>0</DocumentTypeId>
          <Title>Advanced-Test-Automation-Engineer-Syllabus-GA-2016 (1) (1).pdf</Title>
          <Description isNull="true" />
          <UpdatedDate>11/14/2017 3:52:08 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX6Wb%2bUIKqSDt%2fRijVQCoj5Y7EwmcfeXm%2brLeRRD%2bEsUK</Url>
          <CompanyName>VEGA 1 AS</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>3</Id>
              <TagName>Informasjon om tekniske anlegg i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
            <ChapterTagOutputArray1>
              <Id>4</Id>
              <TagName>Samsvarserklæringer og garantibevis</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray1>
            <ChapterTagOutputArray2>
              <Id>8</Id>
              <TagName>Takster og prospekter</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray2>
          </ChapterTags>
        </AuditorDocumentArray2>
      </Documents>
    </GetDocumentsByBoligmappaNumberOutput>
  </MethodParameters>
</GetDocumentsByBoligmappaNumber2>


Exceptions

Error CodeDescription

110

Input parameters contain null or invalid data

123An exception occurred while processing your request
138applicationName length has exceeded the maximum character limit allowed (10) 
146

The applicationName is not set

167

You are not authorized to use this web method

176

boligmappaNumber is not provided

239Invalid boligmappaNumber