Planfix API action.getListWithAnalitic: Difference between revisions

From Planfix
Jump to: navigation, search
No edit summary
 
Line 75: Line 75:
== Go To ==
== Go To ==
*[[Planfix API:Actions]]
*[[Planfix API:Actions]]
*[[Error codes]]
*[[Error codes XML API v1|Error codes]]
*[[List of functions]]
*[[List of functions]]

Latest revision as of 14:58, 15 March 2024

Getting a list of actions with the specified data tag:

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getListWithAnalitic">
  <account></account>
  <sid></sid>
  <analitic>
    <id></id>
  </analitic>
  <task>
    <id></id>
  </task>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <signature></signature>
</request>
Name Type Value Notes
analitic.id int data tag identifier you can get a list of data tags using analitic.getList / Get a list of analitics available in Planfix
task.id int if a value is passed, actions will only be selected from this task not required
pageCurrent int current page
pageSize int size of the requested page cannot exceed 100
signature string(32) signature


Response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <actions count="count" totalCount="totalCount">
    <action><!-- ... --></action>
    <action><!-- ... --></action>
    <!-- ... -->
  </actions>
</response>
Name Type Value Notes
actions root node containing a list of actions
actions count int number of actions in the response
actions totalCount int number of actions satisfying the request
action action. see the action.get / Get action section for a description of this parameter


Otherwise, an error response will be returned:

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


Go To