Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,16 +1,5 @@
1	1	(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2	2	(((
3		-(% class="box warningmessage" %)
4		-(((
5		-(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно просим вас соблюдать несколько простых правил при использовании API-команд:##
6		-)))
7		-
8		-* Формировать не более 3 отчётов одновременно.
9		-* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
10		-
11		-В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд.
12		-
13		-
14	14	**Содержание страницы:**
15	15	)))
16	16
...	...	@@ -1568,78 +1568,6 @@
1568	1568	- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1569	1569	- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1570	1570
1571		-
1572		-== **Импортировать историю ТС (Асинхронный запрос)** ==
1573		-
1574		-(% class="box successmessage" %)
1575		-(((
1576		-**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1577		-)))
1578		-
1579		-Метод запроса: **POST**
1580		-
1581		-URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1582		-
1583		-Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1584		-
1585		-
1586		-Ответ:
1587		-
1588		-{
1589		-
1590		- "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1591		-
1592		- "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1593		-
1594		-~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1595		-
1596		- "Message": "string", ~/~/ Информация о выполнении запроса
1597		-
1598		- "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1599		-
1600		- "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1601		-
1602		- "Data": "string" ~/~/ Данные
1603		-
1604		-}
1605		-
1606		-
1607		-== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1608		-
1609		-(% class="box infomessage" %)
1610		-(((
1611		-**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1612		-)))
1613		-
1614		-Метод запроса: **GET**
1615		-
1616		-URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1617		-
1618		-Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1619		-
1620		-
1621		-Ответ:
1622		-
1623		-{
1624		-
1625		- "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1626		-
1627		- "Status": 0, ~/~/ Перечисление состояний выполения запроса
1628		-~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1629		-
1630		- "Message": "string", ~/~/ Информация о выполнении запроса
1631		-
1632		- "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1633		-
1634		-~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1635		-
1636		- "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1637		-
1638		- "Data": "string" ~/~/ Данные
1639		-
1640		-}
1641		-
1642		-
1643	1643	== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1644	1644
1645	1645	(% class="box infomessage" %)
...	...	@@ -1681,12 +1681,9 @@
1681	1681	"imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1682	1682	"sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1683	1683	"deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1684		- "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1685		- "unitName": "string",  ~/~/ Название подразделения (опционально)
1686		- "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1687		- "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1688		- "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1689		- "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
	1601	+ "parentId": null, ~/~/ ID клиента (Guid, опционально)
	1602	+ "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
	1603	+ "customFields": null ~/~/ значение любого из произвольных полей ТС
1690	1690	}
1691	1691
1692	1692	(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
...	...	@@ -1693,15 +1693,8 @@
1693	1693
1694	1694	(% style="color:#000000" %)Ответ:
1695	1695
1696		-(% style="color:#000000" %)[
1697		-{
1698		-
1699		-(((
1700		- "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1701		-)))
1702		-
1703		-(((
1704		-(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
	1610	+(% style="color:#000000" %){
	1611	+ "vehicleId": "" ~/~/ идентификатор объекта
1705	1705	"name": "" ~/~/ наименование объекта
1706	1706	"imei": "" ~/~/ IMEI объекта
1707	1707	"deviceTypeId": "" ~/~/ идентификатор типа устройства
...	...	@@ -1726,21 +1726,9 @@
1726	1726	"forClient": true, ~/~/ право на отображение у клиента
1727	1727	"forTooltip": false, ~/~/ право на отображение в подсказке
1728	1728	"forReport": false ~/~/ право на отображение в отчетах
1729		-)))
	1636	+ }(%%)
	1637	+(% style="color:#000000" %)}
1730	1730
1731		-(((
1732		- }
1733		- ],
1734		- "vehicleGroups": [  ~/~/ Группы ТС
1735		- {
1736		- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1737		- "name": "string" ~/~/ Наименование группы ТС
1738		- }
1739		- ]
1740		- }
1741		-]
1742		-)))
1743		-
1744	1744	(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1745	1745
1746	1746	== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==