Planfix API contact.getFilterList

The function allows you to get a list of available contact filters for the current employee for the function contact.getList. Request format:

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

Name	type	Value	Note
signature	string(32)	md5 from the function name, values of all fields, excluding signature	detailed description of the signature creation algorithm see in Creating a digital signature section

Response:

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

Name	Type	Value
contactFilterList		list of contact filters
contactFilterList totalCount	int	number of items in the list
contactFilter		root element describing the contact filter
contactFilter.ID	int\|string	filter identifier (numeric identifiers for user filters and text identifiers, starting with ":" - for system filters Contacts and Companies)
contactFilter.Name	string	filter name

Otherwise, a response with an error will be returned:

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

Go To