Planfix API task.getPossibleStatusToChange

A function that lets you get a list of possible statuses for the function task.changeStatus task.changeStatus. Function call format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.getPossibleStatusToChange">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
  </task>
  <signature></signature>
</request>

Name	Type	Value	Notes
task.id	int	task identifier
signature	string(32)	signature

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <statusList totalCount="x">
    <status>
      <title></title>
      <value></value>
    </status>
    <status>
      <title></title>
      <value></value>
    </status>
    <!-- -->
  </statusList>
</response>

Name	Type	Value	Notes
statusList		list of statuses
statusList totalCount	int	number of elements in the list
status		root element describing the status
status.value	enum	value	a list of possible values can be found in the task statuses section
status.title	string	textual representation of the status

Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To