Planfix API action.getList

From Planfix
Jump to: navigation, search

Getting a list of actions in a task:

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getList">
Name Type Value Notes
task (contact) task/contact from which the action is being retrieved - only one node (either a task or a contact) int task identifier
task.general int task number (if given, used instead of ID)
contact.general int contact's phone number
pageCurrent int current page
pageSize int size of the requested page cannot exceed 100
sort enum: {asc,desc} list sorting not required; default is desc
signature string(32) signature


<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <actions count="count" totalCount="totalCount">
    <action><!-- ... --></action>
    <action><!-- ... --></action>
    <!-- ... -->
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">

Go To