API

На данном этапе страница находится в разработке!

Общее описание API

- Система Атлант-Протокол (далее АП) - описать авторизацию

Выполняемые задачи

Создание точки

uri: /points.xml (method: POST)

Састема построена на обраобтке данных от "точек контроля" у каждой из которых есть уникальный адрес состоящий из 3х цифровых частей от 0 до 255 разделенных символом "-" (например: 3-4-214) При создании точки с уже существующим адремосо она будет автоматически заменена на новые данные - таким образом можно заменять (добавлять, обновлять) персональную информацию точки контроля.
Далее будут описаны основные атрибуты для точки контроля: 

          
          <point>
            <!-- первая часть адреса (или уникального номера) подключаемой точки -->
            <addr_A>(число, обязательный)</addr_A>
            <!-- вторя часть адреса (или уникального номера) подключаемой точки -->
            <addr_B>(число, обязательный)</addr_B>
            <!-- третья часть адреса (или уникального номера) подключаемой точки -->
            <addr_C>(число, обязательный)</addr_C>
            <!-- имя устройства в сисеме АП -->
            <name><![CDATA[(строка, обязательный)]]></name>
            <!-- название устройства подключенного в сисему (определяется производителем) -->
            <device_name><![CDATA[(строка, обязательный)]]></device_name> 
            <!-- уникальный номер устройства (определяется производителем) -->
            <device_code>(число)</device_code>
            <!-- версия ПО в устройстве -->
            <device_sw_version><![CDATA[(строка, обязательный)]]></device_sw_version> 
            <!-- дата зборки устройства -->
            <device_date_launch>(дата-время)</device_date_launch>
            <!-- дата поверки(или последней настройки) устройства -->
            <device_date_check>(дата-время)</device_date_check>
          </point>
Помимо основных атрибутов существуют дополнительные параметры (хорошим примером таких параметров есть коеффициенты для настройки устройства контроля), их может быть неограниченое количество по каждой из точек. Для добавления параметра следует добавить такие атрибуты в текущий запрос: 
          
          <point_params>
            <point_param>
              <!-- номер параметра попорядку (в используется для сортировки) -->
              <number>(число)</number>
              <!-- название параметра -->
              <name><![CDATA[(строка)]]></name>
              <!-- значение параметра -->
              <value>(дробное число)</value>
            </point_param>
            <point_param>
              ...
            </point_param>
            ...
          </point_params>

Создание точки с минимальным набором аттрибутов
Example:

echo '<point><addr_A>3</addr_A><addr_B>3</addr_B><addr_C>3</addr_C><name><![CDATA[TEST POINT]]></name><device_name><![CDATA[DEVIE-01D]]></device_name><device_sw_version><![CDATA[0.03.647.20110524]]></device_sw_version></point>' |
curl -X POST -H 'Content-type: text/xml' --include --user admin:admin -d @- http://atlant-protocol.com/points.xml

Обновить точку добавив дополнительные параметры
Example:

echo '<point><addr_A>3</addr_A><addr_B>3</addr_B><addr_C>3</addr_C><name><![CDATA[TEST POINT]]></name><device_name><![CDATA[DEVIE-01D]]></device_name><device_sw_version><![CDATA[0.03.647.20110524]]></device_sw_version></point><point_params><point_param><number>1</number><name><![CDATA[Params1]]></name><value>3.075e-7</value></point_param><point_param><number>2</number><name><![CDATA[Params2]]></name><value>0.05e-2</value></point_param></point_params>' |
curl -X POST -H 'Content-type: text/xml' --include --user admin:admin -d @- http://atlant-protocol.com/points.xml

Создание событий

uri: /points/0-0-0/point_events.xml (method: POST)

Данный запрос дает возможность добавлять события (измерения, статусные сообщения и т. д.) к точке контроля. 

          
          <point_events>
            <point_param>
              <!-- условное название события -->
              <name><![CDATA[( строка )]]></name>
              <!-- дополнительное сообщение к измереной информации -->
              <value_name><![CDATA[( строка )]]></value_name>
              <!-- адрес точки к которой относится даное событие -->
              <point_id><![CDATA[( строка, в формате addrA-addrB-addrC, обязательное )]]></point_id>
              <!-- единици измерения (например: Зв/ч) -->
              <measurements><![CDATA[( строка )]]></measurements>
              <!-- приоритет события, где 0 - норма, 1 - ошибка, 2 - тревога -->
              <priority>( число - 0, 1 или 2 )</priority>
              <!-- измененое значение -->
              <value>( дробное число )</value>
              <!-- текущая погрешность измереня -->
              <measure_mistake>( число )</measure_mistake>
            </point_param>
            <point_param>
              ...
            </point_param>
            ...
          </point_events>

Создание события
Example:

echo '<point_events><point_param><value_name><![CDATA[SomeStatus Message]]></value_name><point_id><![CDATA[3-3-3]]></point_id><measurements><![CDATA[Sv]]></measurements><priority>0</priority><value>0.313e-7</value><measure_mistake>13</measure_mistake></point_param></point_events>' |
curl -X POST -H 'Content-type: text/xml' --include --user admin:admin -d @- http://atlant-protocol.com/points/0-0-0/point_events.xml