Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

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

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
plantIdlongMandatoryNot relevantplantId of the task
taskIdlongMandatoryNot relevantId of the created task
applicationNameStringMandatoryShould be less than or equal to 10 charactersThe 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

TypeDescription
Maintenance TaskAn 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 CodeDescription
111plantId does not exist for your company
123An exception occurred while processing your request
132plantId does not exist
138applicationName length has exceeded the maximum character limit allowed (10)
145The plantId is invalid
146The applicationName is not set
167You are not authorized to use this method 
198Task is not available in the plant
199TaskId is not valid
279The task is already in done status
  • No labels