Description
Please note that this web method is not in production yet and will be available soon.
...
Description
| Info | ||
|---|---|---|
| ||
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
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | GetTenantsInput | Mandatory | Not relevant | Get Tenants inputInput |
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><BuildingId>7032</BuildingPlantId>BuildingId>
</input>
<applicationName>test</applicationName>
</MethodParameters>
</GetTenants>
Response
| Type | Description |
|---|---|
| GetTenantsOutput | Tenants output |
Response - output sample
<GetTenants>
<MethodParameters>
<GetTenantsOutput>
<Tenats <Tenants attr0="TenantArrayTenantDetailsArray" isNull="false">
<TenantArray0>
<OrganizationNumber>964317828<TenantDetailsArray0>
<OrganizationNumber>957604374</OrganizationNumber>
<CompanyName>MALERFIRMA TVILLINGENE LARS LINDVIK AS</CompanyName>
<TenantId>182</TenantId>
<TenantAddress attr0="StringArray" isNull="false">
<StringArray0>Dalssvingen 19B, 1285 OSLOMåmyrstien 9, 4018 STAVANGER</StringArray0>
</TenantAddress>
<ConnectedBuildingPlantId><ConnectedBuildingId>7032</ConnectedBuildingPlantId>ConnectedBuildingId>
<ConnectedBuildingNumber>4289943</ConnectedBuildingNumber>
<TenantPlantId>23<TenantCompanyId>203</TenantPlantId>TenantCompanyId>
<CompanyOwners>BODIL HELLUMJARLE WILLY LINDVIK</CompanyOwners>
<ContactPersonName isNull="true" /><ContactPersonName>Jarle Willy Lindvik</ContactPersonName>
<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> <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 | |
| 377 | You are not authorized to perform this action | |
| 401 | Your company doesnot have a buildingplant for the Given BuildingId398 | Either the building does not exist or a building plant has not been created for it |