Planfix API task.getFilterList

This function gets you a list of task filters available to the given employee for the task.getList function. Function call format:

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

Name	Type	Value	Notes
signature	string(32)	MD5 calculated from the function name and values of all fields excluding signature	for a detailed description of how to create signatures, see Planfix API:Creating a digital signature

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskFilterList totalCount="x">
    <taskFilter>
      <ID></ID>
      <Name></Name>
    </taskFilter>
    <taskFilter>
      <ID></ID>
      <Name></Name>
    </taskFilter>
    <!-- -->
  </taskFilterList>
</response>

Name	Type	Value
taskFilterList		list of task filters
taskFilterList totalCount	int	number of elements in the list
taskFilter		root element describing the task filter
taskFilter.ID	int\|string	filter identifier (numeric identifiers of custom filters; and text identifiers of system filters "All," "Incoming," etc., starting with ":")
taskFilter.Name	string	filter name

Otherwise, an error response will be returned:

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

Go To