Description
...
Description
This method is used to create a set of maintenance tasks. And it It returns the status of the maintenance tasks created.
Note :
Maintenance tasks cannot be created in plants associated with to buildings.
Request
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| plantId | long | Mandatory | Not relevant | Id of the plant to which the job should be associated |
| maintenanceTasks | List<TaskInput> | Mandatory | Not relevant | List of maintenance tasks |
| applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the applicationName should Should be less than or equal to 10 ) |
| characters | The name of the integration partner |
Request - sample input
<CreateMaintenanceTasks>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<plantId>6731</plantId>
<maintenanceTasks attr0="TaskInputArray" isNull="false">
<TaskInputArray0>
<MaintenanceTask>
<Description>Service AC</Description>
<Month>12</Month>
<IsRepeated>False</IsRepeated>
</MaintenanceTask>
<DeviceId>970</DeviceId>
<RoomIds attr0="Int64Array" isNull="false">
<Int64Array0>0</Int64Array0>
</RoomIds>
</TaskInputArray0>
</maintenanceTasks>
<applicationName>test</applicationName>
</MethodParameters>
</CreateMaintenanceTasks>
Response
| Type | Description |
|---|---|
| List<MaintenanceTaskCreateStatus> | Status of the maintenance tasks created |
Note :
If an error occurred while occurrs when creating a task, MaintenanceTaskCreateStatus for that task will have for that task displays the associated error code.
Response - sample output
<CreateMaintenanceTasks>
<MethodParameters>
<MaintenanceTaskCreateStatusArray>
<MaintenanceTaskCreateStatusArray0>
<TaskId>910</TaskId>
<Description>Service AC</Description>
<Month>12</Month>
<IsRepeated>False</IsRepeated>
<ErrorCode>0</ErrorCode>
</MaintenanceTaskCreateStatusArray0>
</MaintenanceTaskCreateStatusArray>
</MethodParameters>
</CreateMaintenanceTasks>
Exceptions
| Error Code | Description |
|---|---|
| 123 | An exception occured while processing your request |
| 138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
| 146 | The application name applicationName is not set set |
| 152 | No property is connected to the given plant id plantId |
| 167 | You are not authorized to use this web method |
| 193 | Maintenance task tasks must contain a description description |
| 194 | Invalid deviceId DeviceId does not exist or does not belong to the given plant |
| 195 | Needs to have at-least Atleast one maintenance task task is required |
| 202 | This operation can only be done on plants connected to properties properties |
| 204 | Entered month is not validinvalid. The range is from 1-12 |
| 205 | Given device's roomId RoomId conflicts with the roomIds RoomIds provided |
| 207 | RoomId doesn't does not exist or doesn't belong to the given plant plant |
| 216 | Maintenance description length is has exceeded the maximum allowed character limit allowed (70) |