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.

...


Info
titleImportant

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

Request

ParameterTypeMandatory/Optional
Comments
Maximum 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
377You are not authorized to perform this action401Your company doesnot have a buildingplant for the Given BuildingId
398Either the building does not exist or a building plant has not been created for it