Planfix API task.changeWorkers: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "{{#seo: |title=Planfix API task.changeWorkers |titlemode=append |keywords=Planfix, API, task, change, Workers, worker |description=Planfix API task.changeWorkers }} This function is used to modify a list of task assignees. Function call format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="task.changeWorkers"> <account></account> <sid></sid> <task> <id></id> <workers> <addUsers> <id></id> <id></id>...")
 
 
Line 95: Line 95:
== 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:42, 6 March 2024

This function is used to modify a list of task assignees. Function call format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.changeWorkers">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <workers>
      <addUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </addUsers>
      <addGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </addGroups>
      <delUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </delUsers>
      <delGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </delGroups>
    </workers>
  </task>
  <signature></signature>
</request>
Name Type Value Notes
task.id int task ID
workers root element of the list of task assignees
workers.addUsers root element of the list of users who are connected to the task
workers.addUsers.id int identifier of the user who is being connected to the task
workers.addGroups root element of the list of groups that are connected to the task
workers.addGroups.id int group identifier
workers.delUsers root element of the list of users who are being deleted from the list of assignees
workers.delUsers.id int identifier of the user who is being deleted from the assignee list
workers.delGroups root element of the list of groups that are being deleted from the list of assignees
workers.delGroups.id int group identifier
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 task ID


Otherwise, an error response will be returned:

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


Go To