Planfix API analitic.getOptions

Get a description of data tag - full content of fields and their value types. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="analitic.getOptions">
  <account></account>
  <sid></sid>
  <analitic>
    <id></id>
  </analitic>
  <signature></signature>
</request>

Name	Type	Value	Note
sid	string(32)	session key	issued as a result of authentication
analitic.id	int	data tag identifier

Response when the request is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <analitic>
    <id></id>
    <name></name>
    <group>
      <id></id>
    </group>
    <fields>
      <field>
        <id></id>
        <num></num>
        <name></name>
        <type></type>
        <list>
          <value></value>
          <value></value>
          <!-- ... -->
        </list>
        <handbook>
          <id></id>
        </handbook>
      </field>
      <field>
        <id></id>
        <num></num>
        <name></name>
        <type></type>
        <list>
          <value></value>
          <value></value>
          <!-- ... -->
        </list>
        <handbook>
          <id></id>
        </handbook>
      </field>
      <!-- ... -->
    </fields>
  </analitic>
</response>

Name	Type	Value	Note
id	int	data tag identifier
name	string	data tag name
group.id	int	data tag group identifier
fields		node containing the list of data tag fields
fields.field		node describing the data tag field
field.id	int	field identifier	required in requests when adding data tag to an action
field.num	int	serial number	for the interface
field.name	string	field description
field.type	enum	data type in the field	see the list of acceptable values in the field data types of data tags section
field.list		the list of acceptable values for the field, if type=LIST
field.list.value	string	field value
field.handbook.id	int	directory identifier, if type=HANDBOOK

Otherwise, a response with an error will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To

• Planfix API:Data tags
• Error codes
• List of functions