Planfix API task.changeStatus: Difference between revisions
From Planfix
No edit summary |
(→Go To) |
||
(2 intermediate revisions by one other user not shown) | |||
Line 5: | Line 5: | ||
|description=Planfix API task.changeStatus | |description=Planfix API task.changeStatus | ||
}} | }} | ||
Changes a task's status. Function call format: | Changes a task's status. Function call format: | ||
<source lang="xml"> | <source lang="xml"> | ||
Line 29: | Line 28: | ||
|- | |- | ||
|status ||enum || new task status|| | |status ||enum || new task status|| | ||
Possible values come from the [[Planfix API: System task statuses|System task statuses]] section; or status IDs received as a result of calling the [[Planfix API taskStatus.getListOfSet|taskStatus.getListOfSet]] function Invalid parameter value: DECLINED (use a different function to decline tasks) | Possible values come from the [[Planfix API: System task statuses|System task statuses]] section; or status IDs received as a result of calling the [[Planfix API taskStatus.getListOfSet|taskStatus.getListOfSet]] function Invalid parameter value: '''DECLINED''' (use a different function to decline tasks) | ||
|- | |- | ||
|dateTime || DateTime || activation date when changing to status ''On hold''|| required field for status '''ON HOLD''' | |dateTime || DateTime || activation date when changing to status ''On hold''|| required field for status '''ON HOLD''' | ||
Line 66: | Line 65: | ||
== Go To == | == Go To == | ||
*[[Planfix API:Tasks]] | *[[Planfix API:Tasks]] | ||
*[[Error codes]] | *[[Error codes XML API v1|Error codes]] | ||
*[[List of functions]] | *[[List of functions]] |
Latest revision as of 09:41, 6 March 2024
Changes a task's status. Function call format:
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.changeStatus">
<account></account>
<sid></sid>
<task>
<id></id>
<general></general>
</task>
<status></status>
<dateTime></dateTime>
<signature></signature>
</request>
Name | Type | Value | Notes |
---|---|---|---|
task.id | int | task identifier | |
general | int | task number (if given, used instead of ID) | |
status | enum | new task status |
Possible values come from the System task statuses section; or status IDs received as a result of calling the taskStatus.getListOfSet function Invalid parameter value: DECLINED (use a different function to decline tasks) |
dateTime | DateTime | activation date when changing to status On hold | required field for status ON HOLD |
signature | string(32) | signature |
Response:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<task>
<id></id>
</task>
</response>
Name | Type | Value | Notes |
---|---|---|---|
task.id | int | ID of the task with the updated status |
Otherwise, an error response will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>