Planfix API action.getList: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "{{#seo: |title=Planfix API action.getList |titlemode=append |keywords=пPlanfix, api, action.getList |description=Planfix API action.getList }} Getting a list of actions in a task: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="action.getList"> <account></account> <sid></sid> <task> <id></id> <general></general> </task> <contact> <general></general> </contact> <pageCurrent></pageCurrent> <pageSize></pageSize> <s...")
 
 
(One intermediate revision by one other user not shown)
Line 67: Line 67:
|'''actions ''' totalCount||int || number of actions satisfying the request ||
|'''actions ''' totalCount||int || number of actions satisfying the request ||
|-
|-
|action || ||action. see [[Planfix API: action.get | the action.get / Get action section]] for a description of this parameter ||
|action || ||action. see [[Planfix API action.get | the action.get / Get action section]] for a description of this parameter ||
|-
|-
|}
|}
Line 83: Line 83:
== 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 in a task:

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getList">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <general></general>
  </task>
  <contact>
    <general></general>
  </contact>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <sort></sort>
  <signature></signature>
</request>
Name Type Value Notes
task (contact) task/contact from which the action is being retrieved - only one node (either a task or a contact)
task.id 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


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