GetTenants

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 tenants from the logged in user’s company database. If the BuildingId is provided, it outputs all the tenants created by the logged in user's company for the given building. If not, it outputs all the tenants created by the logged in user’s company.

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
input	GetTenantsInput	Mandatory	Not relevant	Get Tenants Input

Request - input sample

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

Response

Type	Description
GetTenantsOutput	Tenants output

Response - output sample

<GetTenants>
  <MethodParameters>
    <GetTenantsOutput>
      <Tenants attr0="TenantDetailsArray" isNull="false">
        <TenantDetailsArray0>
<OrganizationNumber>957604374</OrganizationNumber>
          <CompanyName>LARS LINDVIK AS</CompanyName>
          <TenantId>182</TenantId>
          <TenantAddress attr0="StringArray" isNull="false">
            <StringArray0>Måmyrstien 9, 4018 STAVANGER</StringArray0>
          </TenantAddress>
          <ConnectedBuildingId>7032</ConnectedBuildingId>
          <ConnectedBuildingNumber>4289943</ConnectedBuildingNumber>
          <TenantCompanyId>203</TenantCompanyId>
          <CompanyOwners>JARLE WILLY LINDVIK</CompanyOwners>
          <ContactPersonName>Jarle Willy Lindvik</ContactPersonName>
          <ContactPersonPhone isNull="true" />
          <ContactPersonEmail isNull="true" />
          <ConnectedDate>2/28/2018 12:14:11 PM</ConnectedDate>
          <UpdatedDate>2/28/2018 12:14:11 PM</UpdatedDate>
          <Status>True</Status>
          <IsValidated>False</IsValidated>
          <DocumentCount>0</DocumentCount>

        </TenantDetailsArray0>
      </Tenants>
    </GetTenantsOutput>
  </MethodParameters>
</GetTenants>

Exceptions

Error Code	Description
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
398	Either the building does not exist or a building plant has not been created for it