Navikey Wiki Pages

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.

====== Air Lay API v3======
===== Navigation =====
  * [[ru:first|Главная]]
  * [[ru:dsp:first|Web]]
  * [[ru:dsp:airlay:api|API]]
  * [[ru:dsp:api:air-lay|API Air Lay]]
  * [[ru:airlay:examples|Примеры данных]]

----
=====Описание=====
Раздел в процессе разработки
==== Структура запроса ====
<code>
    /**
    * api/v2/{controller}/{action}?{parameter1=value&parameter1=value&...}
    * Где
    * controller - контролер в котором производится действие,
    * action - действие контроллера,
    * parameter1, parameter2 ...  - параметры запроса,
    * value1, value2 ... - значение параметров
    */
</code>
=====Контроллеры=====
==== DataSet ====
<code php>
    /**
     * POST
     * 
     * Action for edit dataSet objects.
     * 
     * @param ObjectId $dataSetId DataSet Id
     * @param string json $commit Commit in edit format
     * @return 200 Ok json/kml/dxf/gml file
     */
    /api/v3/dataSet/editor
</code>
<code php>
    /**
     * POST
     * 
     * Action for clean dataSet object
     * 
     * @param ObjectId $dataSetId DataSet Id
     * @return 200 OK
     */
    /api/v3/dataSet/cleaning
</code>
==== Tracker ====
<code php>
    /**
     * POST
     * Action connect device to tracker
     * 
     * @param ObjectId $trackerId tracker id
     * @return 200 OK
     */
    /api/v3/tracker/connection
</code>
<code php>
    /**
     * POST
     * Action for disconnect device to tracker
     * 
     * @param ObjectId $trackerId tracker id
     * @return 200 OK
     */
     /api/v3/tracker/connection
</code>
<code php>
    /**
     * POST
     * Action send data to tracker module
     * 
     * @param string $type string type object (location/object)
     * @param json $body json object
     * @param ObjectId $schemeId scheme id(if type object)
     * @return 200 Ok
     */
     /api/v3/tracker/send
</code>
<code php>
    /**
     * POST
     * Сonfirmation of a user's connection to the tracker
     *
     * @param ObjectId $trackerId Tracker id
     * @param ObjectId $userId User id
     * @param int $status Device status 0/1
     * @return 200 OK or 400 Error
     */
     /api/v3/tracker/confirmUser
</code>
==== DataLoader ====
<code php>
    /**
     * POST
     * 
     * Action for send data to DataLoader
     * 
     * @param raw data $body Upload data
     * @param ObjectId $dataSetId DataSet id
     * @return 200 OK|logId
     */
    /api/v3/dataLoader/send
</code>
==== Nodes ====
<code php>
    /**
     * GET
     * 
     * Get nodes by filter
     * Bbox [[lon, lat],[lon, lat]], first point is top left bound, second point bottom right bound
     * 
     * @param ObjectId $dataSetId DataSet id. Required.
     * @param string json $bbox Bbox coordinates in json array
     * @param ObjectId $nodeId Node id
     * @return 200 array Nodes collection
     */
    /api/v3/nodes/get
</code>
====Relations====
<code php>
    /**
     * GET
     * 
     * Get relation by filter: id, bbox, $uniqueValue.
     * Bbox [[lon, lat],[lon, lat]], first point is top left bound, second point bottom right bound
     * 
     * @param ObjectId $dataSetId DataSet id. Required.
     * @param string json $bbox Bbox coordinates in json array
     * @param ObjectId $relationId Relation id
     * @param string $uniqueValue
     * @return 200 array Nodes collection
     */
    /api/v3/relations/get
</code>
====Hierarchy====
<code php>
    /**
     * GET
     * 
     * Get relation by filter: id, bbox, $uniqueValue.
     * 
     * @param ObjectId $dataSetId DataSet id. Required.
     * @param ObjectId $hierarchyId Hierarchy id
     * @param ObjectId $parentId
     * @param ObjectId $childId
     * @return 200 array Nodes collection
     */
    /api/v3/hierarchies/get
</code>

Navikey Wiki Pages

Инструменты пользователя

Инструменты сайта

Инструменты страницы