ПланФикс API analitic.getOptions — различия между версиями

Материал из ПланФикс
Перейти к: навигация, поиск
(Новая страница: «Получение описания аналитики - полное содержимое полей и их типов значений. Формат запроса:»)
 
 
Строка 1: Строка 1:
 
Получение описания аналитики - полное содержимое полей и их типов значений. Формат запроса:
 
Получение описания аналитики - полное содержимое полей и их типов значений. Формат запроса:
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<request method="analitic.getOptions">
 +
  <account></account>
 +
  <sid></sid>
 +
  <analitic>
 +
    <id></id>
 +
  </analitic>
 +
  <signature></signature>
 +
</request>
 +
</source>
 +
{| class="wikitable" style="margin-top: 1em; width:100% "
 +
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 +
|-
 +
|sid || string(32) ||ключ сесии || выдается в результате прохождения [[ПланФикс API:Аутентификация|аутентификации]]
 +
|-
 +
|analitic.id|| int || идентификатор аналитики ||
 +
|-
 +
|}
 +
 +
Ответ при успешном выполнении запроса:
 +
<source lang="xml">
 +
<?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>
 +
</source>
 +
{| class="wikitable" style="margin-top: 1em; width:100% "
 +
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 +
|-
 +
|id ||int ||идентификатор аналитики ||
 +
|-
 +
|name ||string ||название аналитики ||
 +
|-
 +
|group.id || int || идентификатор группы аналитики ||
 +
|-
 +
|fields || || узел, содержащий список полей аналитики ||
 +
|-
 +
|fields.field || || узел, описывающий поле аналитики ||
 +
|-
 +
|field.id || int || идентификатор поля || требуется в запросах при добавлении аналитики к действию
 +
|-
 +
|field.num || int || порядковый номер || для  интерфейса
 +
|-
 +
|field.name || string || описание поля ||
 +
|-
 +
|field.type || enum || тип данных в поле ||перечень допустимых значений для данного поля смотри в разделе [[ПланФикс API:Типы данных полей аналитики|типы данных полей аналитики]]
 +
|-
 +
|field.list || || список допустимых значений для поля, если '''type'''=''LIST''  ||
 +
|-
 +
|field.list.value || string || значение поля ||
 +
|-
 +
|field.handbook.id ||int || идентификатор справочника, если '''type'''=''HANDBOOK'' ||
 +
|-
 +
|}
 +
 +
В противном случае будет возвращен ответ с ошибкой:
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<response status="error">
 +
  <code></code>
 +
</response>
 +
</source>
 +
 +
 +
== Перейти ==
 +
*[[ПланФикс API:Аналитика]]
 +
*[[Коды ошибок]]
 +
*[[Список функций]]

Текущая версия на 08:46, 21 декабря 2010

Получение описания аналитики - полное содержимое полей и их типов значений. Формат запроса: 

<?xml version="1.0" encoding="UTF-8"?>
<request method="analitic.getOptions">
  <account></account>
  <sid></sid>
  <analitic>
    <id></id>
  </analitic>
  <signature></signature>
</request>
Название Тип Значение Примечание
sid string(32) ключ сесии выдается в результате прохождения аутентификации
analitic.id int идентификатор аналитики

Ответ при успешном выполнении запроса: 

<?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>
Название Тип Значение Примечание
id int идентификатор аналитики
name string название аналитики
group.id int идентификатор группы аналитики
fields узел, содержащий список полей аналитики
fields.field узел, описывающий поле аналитики
field.id int идентификатор поля требуется в запросах при добавлении аналитики к действию
field.num int порядковый номер для интерфейса
field.name string описание поля
field.type enum тип данных в поле перечень допустимых значений для данного поля смотри в разделе типы данных полей аналитики
field.list список допустимых значений для поля, если type=LIST
field.list.value string значение поля
field.handbook.id int идентификатор справочника, если type=HANDBOOK

В противном случае будет возвращен ответ с ошибкой: 

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


Перейти

Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API_analitic.getOptions&oldid=1055»