GetDocumentsForTenant

Description

Important

Professionals are required to have purchased a valid license consisting of the 'Tenant' feature in order to use this web method. Please contact per.christian@boligmappa.no or yohanw@99x.lk to get a license set up for your company.

This method is used to get documents of a specific TenantId.

Request

Parameters	Type	Mandatory/Optional	Maximum character length/Length	Description
input	GetDocumentsForTenantInput	Mandatory	N/A	Get documents for tenant input
applicationName	string	Mandatory	10	application name

Request - Sample Input

<GetDocumentsForTenant>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <TenantId>193</TenantId>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</SendDocumentsToTenant>

Response

Type	Description
GetDocumentsForTenantOutput	Tenant documents output

Response - output sample

<GetDocumentsForTenant>
  <MethodParameters>
    <GetDocumentsForTenantOutput>
      <TenantDocuments attr0="TenantDocumentArray" isNull="false">
        <TenantDocumentArray0>
          <DocumentId>63704</DocumentId>
          <FileName>sample.pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>3</DocumentTypeId>
          <Title>test</Title>
          <Description>test</Description>
          <OrderNumber>12345678</OrderNumber>
          <UpdatedDate>3/12/2018 4:52:04 PM</UpdatedDate>
          <Url>http://localhost:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=EdpqsL8iNirloLc1CZR%2bD2vGlfdrA%2bqQ%2fvlXnORBvjaAMEznveUjLPovl4xKGVWm</Url>
          <PdfDocId isNull="true" />
          <ApplicationTag>test</ApplicationTag>
          <TenantCompanyId>214</TenantCompanyId>
          <ProfessionId>38</ProfessionId>
          <ProfessionName>BankTextKey</ProfessionName>
          <RoomIds attr0="Int64Array" isNull="false">
            <Int64Array0>1</Int64Array0>
            <Int64Array1>4</Int64Array1>
          </RoomIds>
          <DeviceIds isNull="true" />
          <UpdatedBy>sarasir</UpdatedBy>
          <ChapterTags attr0="ChapterTagArray" isNull="false">
            <ChapterTagArray0>
              <Id>4</Id>
              <TagName>Samsvarserklæringer og garantibevis</TagName>
              <TagDescription isNull="true" />
            </ChapterTagArray0>
          </ChapterTags>
          <IsVisibleInBoligmappa>True</IsVisibleInBoligmappa>
          <IsVisibleToBuildingDirector isNull="true" />
        </TenantDocumentArray0>
        <TenantDocumentArray1>
          <DocumentId>63705</DocumentId>
          <FileName>sample2.pdf</FileName>
          <FileTypeId>4</FileTypeId>
          <DocumentTypeId>3</DocumentTypeId>
          <Title>test1</Title>
          <Description>test</Description>
          <OrderNumber>12345678</OrderNumber>
          <UpdatedDate>3/12/2018 5:20:32 PM</UpdatedDate>
          <Url>http://localhost:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=EdpqsL8iNirloLc1CZR%2bD03ywSh9rwkwM1Ife7rykgfcIxX74s589M8%2bnzDlCJxc</Url>
          <PdfDocId isNull="true" />
          <ApplicationTag>test</ApplicationTag>
          <TenantCompanyId>214</TenantCompanyId>
          <ProfessionId>38</ProfessionId>
          <ProfessionName>BankTextKey</ProfessionName>
          <RoomIds attr0="Int64Array" isNull="false">
            <Int64Array0>1</Int64Array0>
            <Int64Array1>4</Int64Array1>
          </RoomIds>
          <DeviceIds attr0="Int64Array" isNull="false">
            <Int64Array0>20</Int64Array0>
          </DeviceIds>
          <UpdatedBy>sarasir</UpdatedBy>
          <ChapterTags attr0="ChapterTagArray" isNull="false">
            <ChapterTagArray0>
              <Id>3</Id>
              <TagName>Informasjon om tekniske anlegg i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagArray0>
          </ChapterTags>
          <IsVisibleInBoligmappa>True</IsVisibleInBoligmappa>
          <IsVisibleToBuildingDirector>True</IsVisibleToBuildingDirector>
        </TenantDocumentArray1>
      </TenantDocuments>
    </GetDocumentsForTenantOutput>
  </MethodParameters>
</GetDocumentsForTenant>

Exceptions

Error Code	Description
110	Input parameters contain null or invalid data
123	An exception occurred while processing your request
138	applicationName length has exceeded the maximum character limit allowed (10)
146	The applicationName is not set
401	Tenant does not exist
402	You are not authorized for this tenant