Summary

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

Details

Page properties

Content

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