Показаны различия между двумя версиями страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Следующая версия Следующая версия справа и слева | ||
ru:airlay:api:air-lay-v3 [2019/06/24 15:52] Рыков Павел [Relations] |
ru:airlay:api:air-lay-v3 [2019/07/11 11:58] Рыков Павел [Tracker] |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
====== Air Lay API v3====== | ====== Air Lay API v3====== | ||
- | ==== Navigation ==== | + | ===== Navigation |
* [[ru: | * [[ru: | ||
* [[ru: | * [[ru: | ||
Строка 8: | Строка 8: | ||
---- | ---- | ||
+ | =====Описание===== | ||
Раздел в процессе разработки | Раздел в процессе разработки | ||
==== Структура запроса ==== | ==== Структура запроса ==== | ||
Строка 26: | Строка 26: | ||
/** | /** | ||
* POST | * POST | ||
+ | | ||
* Action for edit dataSet objects. | * Action for edit dataSet objects. | ||
+ | | ||
* @param ObjectId $dataSetId DataSet Id | * @param ObjectId $dataSetId DataSet Id | ||
* @param string json $commit Commit in edit format | * @param string json $commit Commit in edit format | ||
Строка 32: | Строка 34: | ||
*/ | */ | ||
/ | / | ||
+ | </ | ||
+ | <code php> | ||
+ | /** | ||
+ | * POST | ||
+ | | ||
+ | * Action for clean dataSet object | ||
+ | | ||
+ | * @param ObjectId $dataSetId DataSet Id | ||
+ | * @return 200 OK | ||
+ | */ | ||
+ | / | ||
+ | </ | ||
+ | ==== Tracker ==== | ||
+ | <code php> | ||
+ | /** | ||
+ | * POST | ||
+ | * Action connect device to tracker | ||
+ | | ||
+ | * @param ObjectId $trackerId tracker id | ||
+ | * @return 200 OK | ||
+ | */ | ||
+ | / | ||
+ | </ | ||
+ | <code php> | ||
+ | /** | ||
+ | * POST | ||
+ | * Action for disconnect device to tracker | ||
+ | | ||
+ | * @param ObjectId $trackerId tracker id | ||
+ | * @return 200 OK | ||
+ | */ | ||
+ | / | ||
+ | </ | ||
+ | < | ||
+ | /** | ||
+ | * POST | ||
+ | * Action send data to tracker module | ||
+ | | ||
+ | * @param string $type string type object (location/ | ||
+ | * @param json $body json object | ||
+ | * @param ObjectId $schemeId scheme id(if type object) | ||
+ | * @return 200 Ok | ||
+ | */ | ||
+ | / | ||
+ | </ | ||
+ | < | ||
+ | /** | ||
+ | * POST | ||
+ | * Update tracker status for user | ||
+ | * | ||
+ | * @param ObjectId $trackerId Tracker id | ||
+ | * @param ObjectId $userId User id | ||
+ | * @param int $status Device status 0/1 | ||
+ | * @return 200 OK or 400 Error | ||
+ | */ | ||
+ | / | ||
+ | </ | ||
+ | ==== 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 | ||
+ | */ | ||
+ | / | ||
</ | </ | ||
==== Nodes ==== | ==== Nodes ==== | ||
Строка 37: | Строка 108: | ||
/** | /** | ||
* GET | * GET | ||
+ | | ||
* Get nodes by filter | * Get nodes by filter | ||
* Bbox [[lon, lat],[lon, lat]], first point is top left bound, second point bottom right bound | * Bbox [[lon, lat],[lon, lat]], first point is top left bound, second point bottom right bound | ||
+ | | ||
* @param ObjectId $dataSetId DataSet id. Required. | * @param ObjectId $dataSetId DataSet id. Required. | ||
* @param string json $bbox Bbox coordinates in json array | * @param string json $bbox Bbox coordinates in json array | ||
Строка 50: | Строка 123: | ||
/** | /** | ||
* GET | * GET | ||
+ | | ||
* Get relation by filter: id, bbox, $uniqueValue. | * 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 | ||
+ | */ | ||
+ | / | ||
+ | </ | ||
+ | ====Hierarchy==== | ||
+ | <code php> | ||
+ | /** | ||
+ | * GET | ||
+ | | ||
+ | * Get relation by filter: id, bbox, $uniqueValue. | ||
+ | | ||
* @param ObjectId $dataSetId DataSet id. Required. | * @param ObjectId $dataSetId DataSet id. Required. | ||
* @param ObjectId $hierarchyId Hierarchy id | * @param ObjectId $hierarchyId Hierarchy id | ||
Строка 56: | Строка 147: | ||
* @param ObjectId $childId | * @param ObjectId $childId | ||
* @return 200 array Nodes collection | * @return 200 array Nodes collection | ||
- | * @throws NavikeyException | ||
*/ | */ | ||
- | /api/v3/relations/get | + | /api/v3/hierarchies/get |
</ | </ | ||
- | ====Hierarchy==== |