Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This method is not in production yet. It will be available soon.

This web method is used to get Tenants for tenants from the logged in user’s company from the database. If the BuildingId is provided, it will output outputs all the tenants created by the logged in user's company in for the provided given building. Otherwise it will output If not, it outputs all the tenants created by the logged in user’s company.

...

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
inputGetTenantsInputMandatoryNot relevantGet 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

TypeDescription
GetTenantsOutputTenants 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 CodeDescription

123

An exception occurred while processing your request

138applicationName length has exceeded the maximum character limit allowed (10) 
146The applicationName is not set
398Either the building does not exist or a building plant has not been created for it

...