Planfix API analitic.getList

From Planfix
Revision as of 12:34, 4 March 2024 by Dmitri (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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>


Go To