Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This method sets the task status to done. The task should be matched with the given plant IdplantId.

Note

Only the task instance for the current year is set to done by this method.

...

ParameterTypeMandatory/OptionalCommentsMaximum character length/limitDescription
plantIdlongMandatoryPlant id Not relevantplantId of the task
taskIdlongMandatoryNot relevantTask Id of the created task
applicationNameStringMandatoryUnique identifier (of your choice) to identify the client application which consumes the Boligmappa API. (length 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

TypeDescription
MaintenanceTaskMaintenance TaskAn Object Of the Maintenance Taskobject 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 plantId does not exist for your company
123An exception occurred while processing your request
132PlantId plantId does not existsexist
138ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10)
145The plant id is plantId is invalid
146The application name applicationName is not set
167You are not authorized to use this web method 
198Task is not available in the plant
199Task Id TaskId is not valid
279The task is already in done status

...