Versions Compared

Key

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

Description

Please note that this web method is not in production yet and will be available soon.

This web method is used to get Tenants from Database. If BuildingId is given it will output all the tenants connected for that building from user's company. Otherwise it will output all the tenants available for the company.

Request

ParameterTypeMandatory/OptionalComments
inputGetTenantsInputMandatoryGet 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>
      <BuildingPlantId>7032</BuildingPlantId>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetTenants>

Response

TypeDescription
GetTenantsOutputTenants output


Response - output sample

<GetTenants>
  <MethodParameters>
    <GetTenantsOutput>
      <Tenats attr0="TenantArray" isNull="false">
        <TenantArray0>
          <OrganizationNumber>964317828</OrganizationNumber>
          <CompanyName>MALERFIRMA TVILLINGENE AS</CompanyName>
          <TenantAddress attr0="StringArray" isNull="false">
            <StringArray0>Dalssvingen 19B, 1285 OSLO</StringArray0>
          </TenantAddress>
          <ConnectedBuildingPlantId>7032</ConnectedBuildingPlantId>
          <TenantPlantId>23</TenantPlantId>
          <CompanyOwners>BODIL HELLUM</CompanyOwners>
          <ContactPersonName isNull="true" />
          <ContactPersonPhone isNull="true" />
          <ContactPersonEmail isNull="true" />
        </TenantArray0>
        <TenantArray1>
          <OrganizationNumber>982025435</OrganizationNumber>
          <CompanyName>EGIL KORSMO AS</CompanyName>
          <TenantAddress attr0="StringArray" isNull="false">
            <StringArray0>Dalssvingen 19B, 1285 OSLO</StringArray0>
          </TenantAddress>
          <ConnectedBuildingPlantId>7032</ConnectedBuildingPlantId>
          <TenantPlantId>33</TenantPlantId>
          <CompanyOwners>EGIL KORSMO</CompanyOwners>
          <ContactPersonName>Egil Korsmo</ContactPersonName>
          <ContactPersonPhone isNull="true" />
          <ContactPersonEmail isNull="true" />
        </TenantArray1>
      </Tenats>
    </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
377You are not authorized to perform this action
401Your company doesnot have a buildingplant for the Given BuildingId