Planfix API analitic.getList: Difference between revisions
From Planfix
(Created page with "The request to get the list of data tags has the following form: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="analitic.getList"> <account></account> <sid></sid> <signature></signature> </request> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note |- |account|| string || the account on which the request is executed || || |- |sid || string(32) ||s...") |
(→Go To) |
||
(One intermediate revision by the same user not shown) | |||
Line 11: | Line 11: | ||
!width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note | !width="150"|Name !!width="200"| Type !!width="50%"| Value !! Note | ||
|- | |- | ||
|account|| string || the account on which the request is executed | |account|| string || the account on which the request is executed || | ||
|- | |- | ||
|sid || string(32) ||session key || issued as a result of [[Planfix API: Authentication|authentication]] | |sid || string(32) ||session key || issued as a result of [[Planfix API: Authentication|authentication]] | ||
Line 78: | Line 78: | ||
== Go To == | == Go To == | ||
*[[Planfix API:Data tags]] | *[[Planfix API:Data tags]] | ||
*[[Error codes]] | *[[Error codes XML API v1|Error codes]] | ||
*[[List of functions]] | *[[List of functions]] |
Latest revision as of 09:26, 6 March 2024
The request to get the list of data tags has the following form:
<?xml version="1.0" encoding="UTF-8"?>
<request method="analitic.getList">
<account></account>
<sid></sid>
<signature></signature>
</request>
Name | Type | Value | Note |
---|---|---|---|
account | string | the account on which the request is executed | |
sid | string(32) | session key | issued as a result of authentication |
signature | string(32) | package signature |
Response, when the request is successfully executed:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<analitics count="count" totalCount="totalCount">
<analitic>
<id></id>
<name></name>
<group>
<id></id>
<name></name>
</group>
</analitic>
<analitic>
<id></id>
<name></name>
<group>
<id></id>
<name></name>
</group>
</analitic>
<!-- ... -->
</analitics>
</response>
Name | Type | Value | Note |
---|---|---|---|
analitics | int | list of data tags | |
analitics count | int | number of data tags in the list | |
analitics totalCount | int | total number of data tags in the list | |
analitic | data tag | ||
analitic.id | int | data tag identifier | |
analitic.name | string | data tag name | |
analitic.group | group | ||
analitic.group.id | int | group identifier | |
analitic.group.name | string | group name |
Otherwise, a response with an error will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>