SetTaskToDone
Description
This method sets the task status to done. The task should be matched with the given plantId.
Note
Only the task instance for the current year is set to done by this method.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
plantId | long | Mandatory | Not relevant | plantId of the task |
taskId | long | Mandatory | Not relevant | Id of the created task |
applicationName | String | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner. |
Request - sample input
<SetTaskToDone>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<plantId>7408</plantId>
<taskId>1014</taskId>
<applicationName>test</applicationName>
</MethodParameters>
</SetTaskToDone>
Response
Type | Description |
---|---|
Maintenance Task | An object of the MaintenanceTask |
Response - sample output
<SetTaskToDone>
<MethodParameters>
<MaintenanceTask>
<Id>1014</Id>
<Description>test</Description>
<Month>3</Month>
<Year>2018</Year>
<IsRepeated>False</IsRepeated>
<IsDone>True</IsDone>
</MaintenanceTask>
</MethodParameters>
</SetTaskToDone>
Exceptions
Error Code | Description |
---|---|
111 | plantId does not exist for your company or your license does not authorize you to access this plantId |
123 | An exception occurred while processing your request |
132 | plantId does not exist |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
145 | The plantId is invalid |
146 | The applicationName is not set |
167 | You are not authorized to use this method |
198 | Task is not available in the plant |
199 | TaskId is not valid |
279 | The task is already in done status |