TaskStatus.getSetList/ Get a list of processes

From PlanFix
Jump to: navigation, search

Function for getting a list of task processes. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="taskStatus.getSetList">
  <account></account>
  <sid></sid>
  <signature></signature>
</request>
Name Type Value Notes
signature string(32) signature


Response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskStatusSets totalCount="totalCount">
    <taskStatusSet>
      <id></id>
      <name></name>
    </taskStatusSet>
    <!-- ... -->
  </taskStatusSets>
</response>
Name Type Value Notes
taskStatusSets root element, contains a list of task processes
taskStatusSets totalCount int number of task processes
taskStatusSet root element that describes the process in the list
id int process identifier
name string process name


An empty response will not generate an error. If there are no processes in the resulting selection, the response will look as follows:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskStatusSets totalCount="0"></taskStatusSets>
</response>


Otherwise, an error response will be returned:

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


Go To