GetDocumentsForHousingCoopShare2 - New

Note:

This is an upgraded version of the GetDocumentsForHousingCoopShare method with more metadata. Use this method as the previous is now obsolete.
GetDocumentsForHousingCoopShareInput 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 associated to a property by OrganizationId and ShareNo. The documents retrieved are those which have been uploaded by professionals (retrieved only if IsVisibleInBoligmappa is set to TRUE when documents are uploaded).

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
input	GetDocumentsForHousingCoopShareInput	Mandatory	Not relevant	GetDocumentsForHousingCoopShare Input model
applicationName	string	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner

GetDocumentsForHousingCoopShareInput

Parameter	Type	Mandatory/Optional	Description
OrganizationNumber	int	Mandatory	OrganizationNumber of the housing cooperative
ShareNumber	int	Mandatory	The number uniquely identifying a particular share of a housing cooperative. This is not part of the matrikkel.

Request - input sample

<GetDocumentsForHousingCoopShare2>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <OrganizationNumber>950143215</OrganizationNumber>
      <ShareNumber>23</ShareNumber>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetDocumentsForHousingCoopShare2>

Response

Type	Description
GetDocumentsForHousingCoopShareOutput	GetDocumentsForHousingCoopShare output model

GetDocumentsForHousingCoopShareOutput

Parameter	Type	Description
Documents	List<AuditorDocument>	List of documents for the given OrganizationNumber and ShareNumber

Response - sample output

<GetDocumentsForHousingCoopShare2>
  <MethodParameters>
    <GetDocumentsForHousingCoopShareOutput>
      <Documents attr0="AuditorDocumentArray" isNull="false">
        <AuditorDocumentArray0>
          <DocumentId>26302</DocumentId>
          <FileName>Test321.txt</FileName>
          <FileTypeId>1</FileTypeId>
          <DocumentTypeId>0</DocumentTypeId>
          <Title>Test321.txt</Title>
          <Description isNull="true" />
          <UpdatedDate>1/2/2015 4:09:42 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=NlqpdhLvY7lwQsOrThRIpO5K1ye8zG4gOaIzgsFgb3et5BgHKK8LIdspIYK5cqz%2b</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Nelfo</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false" />
        </AuditorDocumentArray0>
        <AuditorDocumentArray1>
          <DocumentId>26304</DocumentId>
          <FileName>Job Note test notification.pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>0</DocumentTypeId>
          <Title>Job Note test notification.pdf</Title>
          <Description isNull="true" />
          <UpdatedDate>3/8/2017 10:15:58 AM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=NlqpdhLvY7lwQsOrThRIpJ7HvBQNXuaVp4Dfjqo5KvtiAoUM2jv2vij2dJfHH4so</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>7</Id>
              <TagName>Ferdigattest og andre offentlige dokumenter</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
          </ChapterTags>
        </AuditorDocumentArray1>
        <AuditorDocumentArray2>
          <DocumentId>41710</DocumentId>
          <FileName>Melding om utført arbeid 100.pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>0</DocumentTypeId>
          <Title>Melding om utført arbeid 100.pdf</Title>
          <Description isNull="true" />
          <UpdatedDate>7/28/2016 2:51:02 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=kVZdKfSj9wHFxIJ02IT0%2bLYce6SUlezDIc5Q8rO%2fgvtBXqnQ0BjqcSpe9az6HA4V</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>2</Id>
              <TagName>Informasjon om produkter i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
          </ChapterTags>
        </AuditorDocumentArray2>
        <AuditorDocumentArray3>
          <DocumentId>42148</DocumentId>
          <FileName>download.pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>47</DocumentTypeId>
          <Title>download test.pdf</Title>
          <Description isNull="true" />
          <UpdatedDate>8/1/2016 2:47:16 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=der4ZeZ6wMr4qN1OuwEcvlxZftIxPWLwNx1rw2Wdlrv1HOOjTRAZIjXYsMgmKGBL</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Nelfo</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false" />
        </AuditorDocumentArray3>
        <AuditorDocumentArray4>
          <DocumentId>42266</DocumentId>
          <FileName>test doc 3.jpg</FileName>
          <FileTypeId>9</FileTypeId>
          <DocumentTypeId>8</DocumentTypeId>
          <Title>test doc 1.jpg</Title>
          <Description>test desc</Description>
          <UpdatedDate>8/1/2016 7:11:39 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=der4ZeZ6wMr4qN1OuwEcvsOveSdFIQSNgjY223FiNxqPxoNjvCh8%2fkYejxiyZfIz</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Nelfo</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>9</Id>
              <TagName>Fargekoder, avtaler og kvitteringer</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
            <ChapterTagOutputArray1>
              <Id>10</Id>
              <TagName>Annet nyttig</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray1>
          </ChapterTags>
        </AuditorDocumentArray4>
        <AuditorDocumentArray5>
          <DocumentId>42268</DocumentId>
          <FileName>test doc 3.jpg</FileName>
          <FileTypeId>9</FileTypeId>
          <DocumentTypeId>8</DocumentTypeId>
          <Title>test doc 1.jpg</Title>
          <Description>test desc</Description>
          <UpdatedDate>8/1/2016 7:11:39 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=der4ZeZ6wMr4qN1OuwEcvhobaTbbAhXZ5vGbRXNRkYVjveX4iPRq5XAZ7UAeNjY%2f</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Nelfo</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>9</Id>
              <TagName>Fargekoder, avtaler og kvitteringer</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
            <ChapterTagOutputArray1>
              <Id>10</Id>
              <TagName>Annet nyttig</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray1>
          </ChapterTags>
        </AuditorDocumentArray5>
        <AuditorDocumentArray6>
          <DocumentId>42270</DocumentId>
          <FileName>demo.docx</FileName>
          <FileTypeId>2</FileTypeId>
          <DocumentTypeId>0</DocumentTypeId>
          <Title>demo.docx</Title>
          <Description isNull="true" />
          <UpdatedDate>8/5/2016 4:07:58 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=der4ZeZ6wMr4qN1OuwEcvkXO%2bWkJLGEwgfG0rkdzszsKBM04GL%2bIuUG3fr7y1sqO</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Nelfo</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false" />
        </AuditorDocumentArray6>
        <AuditorDocumentArray7>
          <DocumentId>53497</DocumentId>
          <FileName>4.jpg</FileName>
          <FileTypeId>9</FileTypeId>
          <DocumentTypeId>0</DocumentTypeId>
          <Title>4.jpg</Title>
          <Description isNull="true" />
          <UpdatedDate>4/28/2017 2:32:12 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=MPowDHcwh61GY7qc%2fIT6bjmLwlq9rrxtGInUKew647UJwH2qjamJkdnCJx6bEcMt</Url>
          <CompanyName>Test123]</CompanyName>
          <Industry>Nelfo</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>7</Id>
              <TagName>Ferdigattest og andre offentlige dokumenter</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
          </ChapterTags>
        </AuditorDocumentArray7>
        <AuditorDocumentArray8>
          <DocumentId>56991</DocumentId>
          <FileName>sample.doc</FileName>
          <FileTypeId>3</FileTypeId>
          <DocumentTypeId>37</DocumentTypeId>
          <Title>sample.doc</Title>
          <Description isNull="true" />
          <UpdatedDate>10/23/2017 3:15:12 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=8%2fZ%2feCimpHDSv5maalXonlQLBrpvhQWG2IyOTNRSFLhNkpLQbdXob%2bQplrg6dqGR</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>
        </AuditorDocumentArray8>
        <AuditorDocumentArray9>
          <DocumentId>56995</DocumentId>
          <FileName>1.jpg</FileName>
          <FileTypeId>9</FileTypeId>
          <DocumentTypeId>49</DocumentTypeId>
          <Title>1.jpg</Title>
          <Description isNull="true" />
          <UpdatedDate>10/23/2017 3:16:09 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=8%2fZ%2feCimpHDSv5maalXonk2GCyAJWv%2bwHou3xTq2ILOOrsaCZU%2fF7DHNm3Kqo0B2</Url>
          <CompanyName>VEGA 1 AS</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>7</Id>
              <TagName>Ferdigattest og andre offentlige dokumenter</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
          </ChapterTags>
        </AuditorDocumentArray9>
        <AuditorDocumentArray10>
          <DocumentId>56999</DocumentId>
          <FileName>1.jpg</FileName>
          <FileTypeId>9</FileTypeId>
          <DocumentTypeId>49</DocumentTypeId>
          <Title>1.jpg</Title>
          <Description isNull="true" />
          <UpdatedDate>10/23/2017 3:16:37 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVXwGIJwQpL9Sck6oZAOCHLAuTRDkggPE4gzsGaCjuC8bO</Url>
          <CompanyName>VEGA 1 AS</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>7</Id>
              <TagName>Ferdigattest og andre offentlige dokumenter</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
          </ChapterTags>
        </AuditorDocumentArray10>
        <AuditorDocumentArray11>
          <DocumentId>57005</DocumentId>
          <FileName>1.jpg</FileName>
          <FileTypeId>9</FileTypeId>
          <DocumentTypeId>45</DocumentTypeId>
          <Title>1.jpg</Title>
          <Description isNull="true" />
          <UpdatedDate>10/23/2017 3:19:48 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVXwueDZRkwIfWV6lKsGRjz3zh7Ji5KpOIAGn5wMzI7gRh</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>
          </ChapterTags>
        </AuditorDocumentArray11>
        <AuditorDocumentArray12>
          <DocumentId>57212</DocumentId>
          <FileName>10mb-test-file.pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>36</DocumentTypeId>
          <Title>10fileniew</Title>
          <Description isNull="true" />
          <UpdatedDate>11/7/2017 2:48:21 PM</UpdatedDate>
          <Url>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVX8lrqXHMhfE%2btGz8cs0h4TrRXdWgbXI6OSkd%2bnj7YInX</Url>
          <CompanyName>VEGA 1 AS</CompanyName>
          <Industry>Uspesifisert</Industry>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>10</Id>
              <TagName>Annet nyttig</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
          </ChapterTags>
        </AuditorDocumentArray12>
      </Documents>
    </GetDocumentsForHousingCoopShareOutput>
  </MethodParameters>
</GetDocumentsForHousingCoopShare2>

Exceptions

Error Code	Description
110	Input parameters contain null or invalid data
123	An exception occured while processing your request
138	applicationName length has exceeded the maximum character limit allowed (10)
146	The applicationName is not set
167	You are not authorized to use this method
171	Invalid OrganizationNumber or ShareNumber
222	No documents found for the given housing cooperative share