Planfix API action.getListByPeriod: Difference between revisions
From Planfix
(Created page with "{{#seo: |title= Planfix API action.getListByPeriod |titlemode=append |keywords=Planfix, API, action, getList, ByPeriod, action.getListByPeriod |description= Planfix API action.getListByPeriod }} Getting a list of all actions for a given date range: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="action.getListByPeriod"> <account></account> <sid></sid> <fromDate></fromDate> <toDate></toDate> <pageCurrent></pageCurrent> <pageSize></...") |
(→Go To) |
||
Line 79: | Line 79: | ||
== 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 all actions for a given date range:
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getListByPeriod">
<account></account>
<sid></sid>
<fromDate></fromDate>
<toDate></toDate>
<pageCurrent></pageCurrent>
<pageSize></pageSize>
<sort></sort>
<task>
<id></id>
</task>
<signature></signature>
</request>
Name | Type | Value | Notes |
---|---|---|---|
fromDate | DateTime | beginning of date range | |
toDate | DateTime | end of date range | |
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 |
task.id | int | task identifier | not required; by default actions are selected from all tasks |
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 actionsection 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>