GetDevicesForTenant
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 all the tenant devices for a specific TenantId. User should have a valid work-space for the given tenant in order to get devices of that particular tenant/office space.
Request
Parameter | Type | Mandatory/Optional | Comments |
---|---|---|---|
input | GetDevicesForTenantInput | Mandatory | Get devices for tenant input model |
Note: Use GetTenants method to find the TenantId.
Sample Input
<GetDevicesForTenant>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<input>
<TenantId>193</TenantId>
</input>
<applicationName>test</applicationName>
</MethodParameters>
</GetDevicesForTenant>
Response
Type | Description |
---|---|
GetDevicesForTenantOutput | Get devices for tenant output model |
Sample Output
<GetDevicesForTenant>
<MethodParameters>
<GetDevicesForTenantOutput>
<TenantId>193</TenantId>
<TenantDevices attr0="TenantDeviceArray" isNull="false">
<TenantDeviceArray0>
<Id>11</Id>
<ProductName>test</ProductName>
<DeviceDescription isNull="true" />
<ManufactureName>test</ManufactureName>
<ProductCodeType>3</ProductCodeType>
<ProductCode isNull="true" />
<ProductCodeTypeName>3</ProductCodeTypeName>
<GtinNumber>3</GtinNumber>
<ProductYear>2017</ProductYear>
<LifeExpectancy>5</LifeExpectancy>
<WarrantyDuration>2</WarrantyDuration>
<BuildingElementId>0</BuildingElementId>
<BuildingElementDescription isNull="true" />
<DeviceTypeId>6</DeviceTypeId>
<DeviceType>Baderomsinnredning</DeviceType>
<InstallationYear>0</InstallationYear>
<RoomId>4</RoomId>
<RoomName>room1</RoomName>
<UserManual>http://localhost:8080/Device/DownloadDeviceManualWebService?sessionKey=6b71zExMCHVEmfUCjbr8ypotefZx9Y3IXQ7ULjJ65%2fSfO%2bl1gK0fz%2fy9gqcO4q9TUlH5FxVV6RD42y8bjSl76g%3d%3d</UserManual>
<CreatedDate>3/7/2018 2:46:11 PM</CreatedDate>
<UpdatedDate isNull="true" />
<CreatedBy>Company Name/Property Owner name</CreatedBy>
</TenantDeviceArray0>
</TenantDevices>
</GetDevicesForTenantOutput>
</MethodParameters>
</GetDevicesForTenant>
Exceptions
Error Code | Description |
---|---|
110 | Input parameters contain null or invalid data |
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 |
167 | You are not authorized to use this method |
401 | Tenant does not exist |
402 | You are not authorized for this tenant |