Last modified by Андрей Калиновский on 2025/04/24 15:46
<
From version < 203.1 >
edited by Андрей Калиновский
on 2024/12/23 14:03
To version < 5.1 >
edited by Андрей Калиновский
on 2022/08/31 14:11
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Tags
... ... @@ -1,1 +1,0 @@
1 -Public API|API
Content
... ... @@ -1,5460 +1,440 @@
1 -(% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 -(((
3 -(% class="box warningmessage" %)
4 -(((
5 -(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 -просим вас соблюдать несколько простых правил при использовании API-команд:##
7 -)))
1 +== Описание ГЛОНАССSoft Public API ==
8 8  
9 -* Формировать не более 3 отчётов одновременно.
10 -* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
3 +== ==
11 11  
12 -В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
5 + **Действующие ограничения**
6 +
13 13  
8 +- Между запросами на формирование трека/отчета должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов)
14 14  
15 -**Содержание страницы:**
16 -)))
10 +- Для работы со всеми методами API необходимо в заголовок добавлять X-Auth (токен авторизации, получаемый методом auth/login).
17 17  
18 -{{toc/}}
19 -
20 -
21 -= (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
22 -
23 -(% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
24 -
25 -(% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
26 -
27 27  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
13 +\\
28 28  
29 -(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
15 + **Авторизация**
30 30  
17 +Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
31 31  
32 -(% style="color:#000000; font-size:16px" %)**Рекомендации**
19 +Метод запроса: GET
33 33  
34 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
21 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo>>url:https://hosting.glonasssoft.ru/api/v3/auth/login?username=demo&password=demo]]
35 35  
36 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
23 +В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
37 37  
38 -(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
39 -(((
40 -(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
41 -(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
42 -)))
25 +Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]
43 43  
44 -(% class="box successmessage" %)
45 -(((
46 -(% lang="en-US" %)**POST /api/v3/auth/login**
47 -)))
27 + **Получение списка объектов**
48 48  
49 -(% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29 +Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель): Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
50 50  
51 -(% style="color:#000000" %)Метод запроса: **POST**
31 +−возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
52 52  
53 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 +−возвращает информацию об объектах с учетом заданных настроек видимости объектов;
54 54  
55 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 +−информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»;
56 56  
57 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
37 +−информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»;
58 58  
59 -(% style="color:#000000" %){
60 - "login": "testuser",
61 - "password": "testuser"
62 -}
39 +−информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта».
63 63  
64 -(% style="color:#000000" %)**Ответ:**
41 +Метод запроса: POST
65 65  
66 -(% lang="en-US" %)
67 -(% style="color:#000000" %){
68 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
69 - "User": "testuser" , ~/~/ имя пользователя(%%)
70 -}
43 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
71 71  
72 -**Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
45 +В заголовках запроса:
73 73  
74 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
75 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
76 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
77 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
78 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
47 +−Content-Type: application/json
79 79  
80 -(% class="wikigeneratedid" %)
81 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
49 +−X-Auth: Токен авторизации
82 82  
83 -== (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
51 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
84 84  
85 -(% class="box infomessage" %)
86 -(((
87 -(% lang="en-US" %)**GET /api/v3/auth/check**
88 -)))
53 +{{{{"vehicleId": null,//84350, // ID ТС (int, опционально) "name": null, // Имя ТС (string, опционально) "imei": null,//"710179307", // IMEI (string, опционально) "sim": null,//"938112", // Номер телефона (string, опционально) "deviceTypeId": null,//5 // ID типа устройства (short, опционально) "parentId": null, // ID клиента (Guid, опционально) "unitId": null //"b33548c3-73c3-40e4-8b78-81470ae744ed" // ID подразделения (Guid, опционально)}}}}
89 89  
90 -(% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
55 +Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».
91 91  
92 -(% style="color:#000000" %)Метод запроса: **GET**
57 +Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта  //«//createdAt//»: «» дата создания объектов         //}, … ]
93 93  
94 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
59 +Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов». Параметр «status» содержится в ответе при наличии у авторизованного пользователя права «Просмотр статуса объекта». Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже.
95 95  
96 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
61 +0 - «Блокировка»
97 97  
98 -(% lang="en-US" %)
99 -(% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
63 +1 - «Активен»,
100 100  
101 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
65 +2 - «Отменен»
102 102  
103 -== (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
67 +3 - «Оборудован»
104 104  
105 -(% class="box infomessage" %)
106 -(((
107 -**GET api/v3/agents/{id}**
108 -)))
69 +4 - «Диагностика»
109 109  
110 -Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
71 +5 - «Сервис»
111 111  
112 -(% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
73 +6 - «Демонтаж»
113 113  
114 -(% style="color:#000000" %)Метод запроса: **GET**
75 +7 - «Монтаж»
115 115  
116 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
77 +8 - «Дозаказ»
117 117  
118 -Запрос должен содержать данные параметра "**agentId**"
79 +9 - «Обслужен»
119 119  
120 -(% style="color:#000000" %)Ответ:
121 -{
122 - "agentId": "",  (%%)
123 - "parentId": "",
124 - "parentName": "string",
125 - "name": "string",
126 - "fullName": "string",
127 - "agentInfoType": 0,
128 - "isForeign": true/false,
129 - "district": "string", 
130 - "region": "string",
131 - "city": "string",
132 - "inn": "string",
133 - "kpp": "string",
134 - "address": "string",
135 - "addressFact": "string",
136 - "email": "string",
137 - "director": "string",
138 - "bankName": "string",
139 - "bankBIK": "string",
140 - "bankRS": "string",
141 - "bankKS": "string"
142 - }
81 +10 - «Списан»
143 143  
144 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
145 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
146 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
147 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
148 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
149 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
150 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
151 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
152 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
153 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
154 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
155 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
156 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
157 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
158 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
159 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
160 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
161 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
162 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
163 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
164 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
83 +11 - «Неисправен»
165 165  
166 -== (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
85 +12 - «Проверен»
167 167  
168 -(% class="box infomessage" %)
169 -(((
170 -(% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
171 -)))
87 +13 - «Не эксплуатируется»
172 172  
173 -(% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
89 + **Получение списка клиентов.**
174 174  
175 -(% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
91 +Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
176 176  
177 -(% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
93 +−информация о клиентах предоставлется при наличии права «Просмотр клиентов»;
178 178  
179 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
95 +−возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
180 180  
181 -(% style="color:#000000" %)Метод запроса: **POST**
97 +−информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «Доступ к партнёрским клиентам».
182 182  
183 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
99 +Метод запроса: GET
184 184  
185 -(% style="color:#000000" %)Параметр запроса:
101 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]]<parentId>
186 186  
187 -(% style="color:#000000" %){
188 - "parentId": "string"
189 -}
103 +Параметр запроса: <parentId> - идентификатор клиента-родителя (опционально)
190 190  
191 -(% style="color:#000000" %)Ответ:
192 -
193 -{
194 - "agentId": "",(% style="color:#000000" %)   (%%)
195 - "parentId": "",
196 - "name": "string",
197 - "fullName": "string",
198 - "agentInfoType": 0,
199 -(% style="color:#000000" %) "status": "",
200 -}
201 -
202 -
203 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
204 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
205 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
206 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
207 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
208 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
209 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
210 -
211 -== (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
212 -
213 -(% class="box successmessage" %)
214 -(((
215 -**POST /api/v3/agents **
216 -)))
217 -
218 -Метод позволяет добавить клиента, указанного в запросе.
219 -
220 -Метод запроса: **POST**
221 -
222 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
223 -
224 224  В заголовках запроса: X-Auth: Токен авторизации
225 225  
226 -Параметры в теле запроса (JSON):
107 +Ответ: [ { «agentId»: «», //идентификатор клиента «parentId»: «», //идентификатор клиента-родителя «name»: «», //наименование клиента «fullName»: «», //полное наименование клиента «agentInfoType»: , //тип клиента1 «status»:  //статус клиента }, … ]
227 227  
228 -{
229 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
230 - "name": "string", ~/~/ имя
231 - "fullName": "string", ~/~/ полное наименование
232 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
233 - "isForeign": true, ~/~/ иностранный контрагент
234 - "district": "string", ~/~/ округ
235 - "region": "string", ~/~/ регион
236 - "city": "string", ~/~/ город
237 - "inn": "string", ~/~/ ИНН
238 - "kpp": "string", ~/~/ КПП
239 - "address": "string", ~/~/ юридический адрес
240 - "addressFact": "string", ~/~/ фактический адрес
241 - "email": "string", ~/~/ email
242 - "director": "string", ~/~/ ФИО руководителя
243 - "bankName": "string", ~/~/ банк
244 - "bankBIK": "string", ~/~/ БИК
245 - "bankRS": "string", ~/~/ номер счёта
246 - "bankKS": "string" ~/~/ корр. счёт
247 -}
109 +Примечание. Возможные значение параметра agentInfoType:
248 248  
249 -Ответ:
111 + **Получение списка пользователей.**
250 250  
251 -{
252 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
253 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
254 - "name": "string", ~/~/ имя
255 - "fullName": "string", ~/~/ полное наименование
256 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
257 - "isForeign": true, ~/~/ иностранный контрагент
258 - "district": "string", ~/~/ округ
259 - "region": "string", ~/~/ регион
260 - "city": "string", ~/~/ город
261 - "inn": "string", ~/~/ ИНН
262 - "kpp": "string", ~/~/ КПП
263 - "address": "string", ~/~/ юридический адрес
264 - "addressFact": "string", ~/~/ фактический адрес
265 - "email": "string", ~/~/ email
266 - "director": "string", ~/~/ ФИО руководителя
267 - "bankName": "string", ~/~/ банк
268 - "bankBIK": "string", ~/~/ БИК
269 - "bankRS": "string", ~/~/ номер счёта
270 - "bankKS": "string" ~/~/ корр. счёт
271 -}
113 +Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и пр.
272 272  
273 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
274 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
275 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
276 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
277 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
278 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
279 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
280 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
281 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
282 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
283 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
284 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
285 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
286 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
287 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
288 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
289 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
290 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
291 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
292 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
293 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
115 +Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставлется при наличии права «Просмотр пользователей».
294 294  
295 -== (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
117 +Метод запроса: POST
296 296  
297 -(% class="box warningmessage" %)
298 -(((
299 -**PUT /api/v3/agents**
300 -)))
119 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
301 301  
302 -Метод позволяет отредактировать клиента, указанного в запросе.
121 +Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
303 303  
304 -Метод запроса: **PUT**
123 +{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
124 + //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
125 + "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
126 + //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
305 305  
306 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
307 -
308 -В заголовках запроса: X-Auth: Токен авторизации
309 -
310 -Параметры в теле запроса (JSON):
311 -
312 -{
313 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
314 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
315 - "name": "string", ~/~/ имя
316 - "fullName": "string", ~/~/ полное наименование
317 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
318 - "isForeign": true, ~/~/ иностранный контрагент
319 - "district": "string", ~/~/ округ
320 - "region": "string", ~/~/ регион
321 - "city": "string", ~/~/ город
322 - "inn": "string", ~/~/ ИНН
323 - "kpp": "string", ~/~/ КПП
324 - "address": "string", ~/~/ юридический адрес
325 - "addressFact": "string", ~/~/ фактический адрес
326 - "email": "string", ~/~/ email
327 - "director": "string", ~/~/ ФИО руководителя
328 - "bankName": "string", ~/~/ банк
329 - "bankBIK": "string", ~/~/ БИК
330 - "bankRS": "string", ~/~/ номер счёта
331 - "bankKS": "string" ~/~/ корр. счёт
332 332  }
333 333  
334 -Ответ:
130 +Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
335 335  
336 -{
337 - "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
338 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
339 - "name": "string", ~/~/ имя
340 - "fullName": "string", ~/~/ полное наименование
341 - "isForeign": true, ~/~/ иностранный контрагент
342 - "district": "string", ~/~/ округ
343 - "region": "string", ~/~/ регион
344 - "city": "string", ~/~/ город
345 - "inn": "string", ~/~/ ИНН
346 - "kpp": "string", ~/~/ КПП
347 - "address": "string", ~/~/ юридический адрес
348 - "addressFact": "string", ~/~/ фактический адрес
349 - "email": "string", ~/~/ email
350 - "director": "string", ~/~/ ФИО руководителя
351 - "bankName": "string", ~/~/ банк
352 - "bankBIK": "string", ~/~/ БИК
353 - "bankRS": "string", ~/~/ номер счёта
354 - "bankKS": "string" ~/~/ корр. счёт
355 -}
132 +{{{ "sessionDuration": "", // длительность сессии в минутах}}}
356 356  
357 -== (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
134 + «status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]
358 358  
359 -(% class="box errormessage" %)
360 -(((
361 -**DELETE /api/v3/agents/{clientId}**
362 -)))
136 + **Получение списка типов устройств**
363 363  
364 -Метод позволяет удалить клиента, указанного в строке запроса.
138 +Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
365 365  
366 -Метод запроса: **DELETE**
140 +Метод запроса: GET
367 367  
368 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
142 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
369 369  
370 -Параметр запроса: **{clientId}** - Guid пользователя
144 +В заголовках запроса:X-Auth: Токен авторизации
371 371  
372 -В заголовках запроса: X-Auth: Токен авторизации
146 +Ответ: [
373 373  
374 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
148 +{{{ {
149 + "deviceTypeId" : "", // ID типа устройства
150 + "deviceTypeName" : "" // Название типа устройства
151 + },}}}
375 375  
376 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
153 +… ]
377 377  
378 -(% class="box warningmessage" %)
379 -(((
380 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
381 -)))
155 + **Получение списка типов датчиков**
382 382  
383 -Метод позволяет изменить статус клиента, указанного в запросе.
157 +Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
384 384  
385 -В пути указывается GUID клиента и статус клиента.
159 +Метод запроса: GET
386 386  
387 -**status **- значение 0 - заблокирован, 1 - активен.
161 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
388 388  
389 -Ответ: Code 204
163 +В заголовках запроса:X-Auth: Токен авторизации
390 390  
391 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
165 +Ответ: [
392 392  
393 -== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
167 +{{{ {}}}
394 394  
395 -(% class="box successmessage" %)
396 -(((
397 -(% lang="en-US" %)**POST /api/v3/users**
398 -)))
169 +«id»: «», //ID типа датчика «name»: «», //Название
399 399  
400 -(% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
171 +{{{ "description": "" // Описание
172 + },}}}
401 401  
402 -(% style="color:#000000" %)Метод запроса: **POST**
174 +… ]
403 403  
404 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
176 + **Получение информации об объекте**
405 405  
406 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
178 +Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
407 407  
408 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
180 +Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»):
409 409  
410 -(% style="color:#000000" %)
411 -{ 
412 - "lastName": "", ~/~/ фамилия
413 - "firstName": "", ~/~/ имя
414 - "position": "", ~/~/ должность
415 - "phone": "", ~/~/ телефон
416 - "organization": "", ~/~/ организация
417 - "login": "", ~/~/ логин (обязателен)
418 - "password": "", ~/~/ пароль (обязателен)
419 - "email": "", ~/~/ email (обязателен)
420 - "description": "string", ~/~/ Описание
421 - "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
422 - "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
423 - "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
424 - "parentId": "", ~/~/ Guid родительского агента
425 - "leaderId": "", ~/~/ Guid руководителя (null - не задан)
426 - "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
427 - "doubleAuth":
428 - {
429 - "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
430 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
431 - },
432 - "groups":
433 - [
434 - "string" ~/~/ группы пользователя, перечисление названия системных ролей
435 - ],
436 - "customGroups":
437 - [
438 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
439 - ],
440 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
441 -}
442 -{
443 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
444 - "lastName": "string",
445 - "firstName": "string",
446 - "position": "string",
447 - "phone": "string",
448 - "organization": "string",
449 - "login": "string",
450 - "password": "string",
451 - "email": "string",
182 +−возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов; информация о ТО предоставляется с учётом прав на «Просмотр заданий на техобслуживание».
452 452  
453 -(% style="text-align:left" %)
454 -(% style="color:#000000; font-weight:normal" %)Ответ:
455 -{     
456 - "id": "" , ~/~/ ID пользователя
457 - "lastName": "" , ~/~/ Фамилия ,
458 - "firstName": "" , ~/~/ Имя
459 - "position": "" , ~/~/ Должность
460 - "phone": "" , ~/~/ Телефон
461 - "organization": "" , ~/~/ Организация
462 - "login": "" , ~/~/ Логин
463 - "password": "" , ~/~/ Пароль
464 - "email": "" , ~/~/ Email
465 - "description": "" , ~/~/ Описание
466 - "isEnabled": "" , ~/~/ Признак включения
467 - "parentId": "" , ~/~/ Guid родительского агента
468 - "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
469 - "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
470 - "kind": "" , ~/~/ тип аутентификации
471 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
472 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
473 -}
184 +Метод запроса: GET
474 474  
186 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]<vehicleID>
475 475  
476 -== (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
188 +Параметр запроса: <vehicleid> - идентификатор объекта (опционально)
477 477  
478 -(% class="box infomessage" %)
479 -(((
480 -(% lang="en-US" %)**POST /api/v3/users/find**
481 -)))
190 +В заголовках запроса: X-Auth: Токен авторизации
482 482  
483 -(% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
484 -
485 -(% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
486 -
487 -(% style="color:#000000" %)Метод запроса: **POST**
488 -
489 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
490 -
491 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
492 -
493 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
494 -
495 -(% style="color:#000000" %){(%%)
496 - "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
497 - "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
498 - "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
499 - "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
500 -(% style="color:#000000" %)}
501 -
502 -(% style="color:#000000" %)Ответ:
503 -
504 -(% style="color:#000000" %){         (%%)
505 - "id": "" , ~/~/ идентификатор пользователя
506 - "lastName": "" , ~/~/ фамилия
507 - "firstName": "" , ~/~/ имя
508 - "position": "" , ~/~/ должность
509 - "phone": "" , ~/~/ телефон
510 - "parentId": "" , ~/~/ идентификатор клиента-родителя
511 - "parentName": "" , ~/~/ наименование клиента-родителя
512 - "organization": "" , ~/~/ организация
513 - "login": "" , ~/~/ логин
514 - "email": "" , ~/~/ E-mail
515 - "sessionDuration":"", ~/~/ длительность сессии в минутах
516 - "status": "1",  ~/~/ статус пользователя
517 - "lastLogged": "", ~/~/ дата/время последней авторизации
518 -(% style="color:#000000" %)}
519 -
520 -== (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
521 -
522 -(% class="box infomessage" %)
523 -(((
524 -(% lang="en-US" %)**GET /api/v3/users/{GUID}**
525 -)))
526 -
527 -(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
528 -
529 -(% style="color:#000000" %)Метод запроса: **GET**
530 -
531 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
532 -
533 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
534 -
535 -(% style="color:#000000" %)Ответ:
536 -
537 -(((
538 -(((
539 -{
540 - "id": "", ~/~/ GUID пользователя
541 - "lastName": "", ~/~/ Фамилия 
542 - "firstName": "", ~/~/ Имя
543 - "position": "", ~/~/ Должность
544 - "phone": "", ~/~/ Номер телефона
545 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
546 - "parentName": "", Наименование клиента, которому принадлежит пользователь
547 - "organization": "", ~/~/ Организация
548 - "login": "", ~/~/ Логин пользователя
549 - "email": "", ~/~/ Адрес электронной почты
550 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
551 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
552 - "description": "", ~/~/ Описание
553 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
554 - "doubleAuth":
555 - {
556 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
557 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
558 - },
559 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
560 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
561 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
562 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
563 - "groups": [], ~/~/ Список ролей пользователя
564 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
565 - "authDevices": [ ], ~/~/ Список авторизованных устройств
566 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
567 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
568 -}
569 -)))
570 -)))
571 -
572 -== (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
573 -
574 -(% class="box warningmessage" %)
575 -(((
576 -(% lang="en-US" %)**PUT /api/v3/users**
577 -)))
578 -
579 -(% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
580 -
581 -(% style="color:#000000" %)Метод запроса: **PUT**
582 -
583 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
584 -
585 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
586 -
587 -(% lang="en-US" style="text-align:left" %)
588 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
589 -
590 -(% lang="en-US" style="text-align:left" %)
591 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
592 - "id": "" , ~/~/ ID пользователя 
593 - "lastName": "" , ~/~/ фамилия
594 - "firstName": "" , ~/~/ имя
595 - "position": "" , ~/~/ должность
596 - "phone": "" , ~/~/ телефон
597 - "organization": "" , ~/~/ организация
598 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
599 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
600 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
601 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
602 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
603 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
604 - "isEnabled": "" , ~/~/ признак включения
605 - "parentId": "" , ~/~/ Guid родительского агента
606 - "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
607 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
608 - "doubleAuth":
609 - {
610 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
611 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
612 - },
613 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
614 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
615 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
616 -
617 -(% lang="en-US" style="text-align:left" %)
618 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
619 -
620 -(% lang="en-US" style="text-align:left" %)
621 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
622 - "id": "" , ~/~/ идентификатор пользователя
623 - "lastName": "" , ~/~/ фамилия
624 - "firstName": "" , ~/~/ имя
625 - "position": "" , ~/~/ должность
626 - "phone": "" , ~/~/ телефон
627 - "organization": "" , ~/~/ организация
628 - "login": "" , ~/~/ логин
629 - "password": "" , ~/~/ пароль 
630 - "email": "" , ~/~/ email
631 - "description": "" , ~/~/ описание
632 - "isEnabled": "" , ~/~/ признак включения
633 - "parentId": "" , ~/~/ Guid родительского агента
634 - "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
635 - "doubleAuth":
636 - {
637 - "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
638 - "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
639 - },
640 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
641 - "target": "" , ~/~/ в случае аутентификации по email - email-адрес
642 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
643 -}
644 -
645 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
646 -
647 -(% class="box warningmessage" %)
648 -(((
649 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
650 -)))
651 -
652 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
653 -
654 -(% style="color:#000000" %)Метод запроса: **PUT**
655 -
656 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
657 -
658 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
659 -
660 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
661 -
662 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
663 -
664 -(% style="color:#000000" %){(%%)
665 - "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
666 - "description": "" , ~/~/ описание
667 - "data": "" , ~/~/ данные, связанные со сменой статуса
668 -(% style="color:#000000" %)}
669 -
670 -(% style="text-align:left" %)
671 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
672 -
673 -== (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
674 -
675 -(% class="box warningmessage" %)
676 -(((
677 -**POST /api/v3/users/disable**
678 -)))
679 -
680 -Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
681 -
682 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
683 -
684 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
685 -
686 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
687 -
688 - [ 
689 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
690 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
691 - ]
692 -
693 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
694 -
695 -== (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
696 -
697 -(% class="box warningmessage" %)
698 -(((
699 -**POST /api/v3/users/enable**
700 -)))
701 -
702 -Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
703 -
704 -(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
705 -
706 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
707 -
708 -(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
709 -
710 - [ 
711 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
712 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
713 - ]
714 -
715 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
716 -\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
717 -
718 -(((
719 -В теле ответа:
720 -{
721 - "errorMessages": [
722 - "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
723 - ],
724 - "users": [
725 - "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
726 - ]
727 -}
728 -\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
729 -"users" - массив id пользователей, которых не удалось включить или отключить.
730 -)))
731 -
732 -== (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
733 -
734 -(% class="box errormessage" %)
735 -(((
736 -(% lang="en-US" %)**DELETE /api/v3/users/{id}**
737 -)))
738 -
739 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
740 -
741 -(% style="color:#000000" %)Метод запроса: **DELETE**
742 -
743 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
744 -
745 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
746 -
747 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
748 -
749 -(% style="text-align:left" %)
750 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
751 -
752 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
753 -
754 -== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
755 -
756 -(% class="box infomessage" %)
757 -(((
758 -(% lang="en-US" %)**GET /api/v3/models/{Id}**
759 -)))
760 -
761 -Метод возвращает полную информацию о модели объекта.
762 -
763 -(% style="color:#000000" %)Метод запроса: **GET**
764 -
765 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
766 -
767 -(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
768 -
769 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
770 -
771 -(% style="color:#000000" %)Ответ:
772 -
773 -(% style="color:#000000" %){
774 - "parentName": "string",
775 - "name": "string",
776 - "picture": "string",
777 - "minspeed": 0,
778 - "maxspeed": 0,
779 - "width": 0,
780 - "imbeddedtrailer": true,
781 - "hoppercapacity": 0,
782 - "hopperdischargespeed": 0,
783 - "modelType": 0,
784 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
786 - "deleted": true
787 -}
788 -
789 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
790 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
791 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
792 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
793 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
794 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
795 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
796 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
797 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
798 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
799 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
800 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
801 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
802 -|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
803 -
804 -== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
805 -
806 -(% class="box successmessage" %)
807 -(((
808 -(% lang="en-US" %)**POST /api/v3/models/find**
809 -)))
810 -
811 -(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
812 -
813 -(% style="color:#000000" %)Метод запроса: **POST**
814 -
815 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
816 -
817 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
818 -
819 -(% style="color:#000000" %)Параметры в теле запроса (JSON):{
820 -
821 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
822 -}
823 -
824 -(% style="color:#000000" %)Ответ:
825 -
826 -(% style="color:#000000" %)[
827 - {
828 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
830 - "parentName": "string",
831 - "name": "string",
832 - "modelType": 0
833 - }
834 -]
835 -
836 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
837 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
838 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
839 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
840 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
841 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
842 -
843 -== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
844 -
845 -(% class="box successmessage" %)
846 -(((
847 -(% lang="en-US" %)**POST /api/v3/models**
848 -)))
849 -
850 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
851 -
852 -(% style="color:#000000" %)Метод запроса: **POST**
853 -
854 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
855 -
856 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
857 -
858 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
859 -
860 -{
861 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 - "deleted": true,
864 - "extId": "string",
865 - "name": "string",
866 - "picture": "string",
867 - "minspeed": 0,
868 - "maxspeed": 0,
869 - "width": 0,
870 - "imbeddedtrailer": true,
871 - "fueloutlay": 0,
872 - "hoppercapacity": 0,
873 - "hopperdischargespeed": 0,
874 - "modelType": 0
875 -}
876 -
877 877  Ответ:
878 878  
879 879  {
880 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 - "deleted": true,
883 - "extId": "string",
884 - "name": "string",
885 - "picture": "string",
886 - "minspeed": 0,
887 - "maxspeed": 0,
888 - "width": 0,
889 - "imbeddedtrailer": true,
890 - "hoppercapacity": 0,
891 - "hopperdischargespeed": 0,
892 - "modelType": 0
893 -}
894 894  
895 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
896 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
897 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
898 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
899 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
900 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
901 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
902 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
903 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
904 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
905 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
906 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
907 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
908 -
909 -== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
910 -
911 -(% class="box warningmessage" %)
912 -(((
913 -(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 -)))
915 -
916 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
917 -
918 -(% style="color:#000000" %)Метод запроса: **PUT**
919 -
920 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
921 -
922 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
923 -
924 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
925 -
926 -{
927 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
929 - "deleted": true,
930 - "extId": "string",
931 - "name": "string",
932 - "picture": "string",
933 - "minspeed": 0,
934 - "maxspeed": 0,
935 - "width": 0,
936 - "imbeddedtrailer": true,
937 - "fueloutlay": 0,
938 - "hoppercapacity": 0,
939 - "hopperdischargespeed": 0,
940 - "modelType": 0
941 -}
942 -
943 -Ответ:
944 -
945 -{
946 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
948 - "deleted": true,
949 - "extId": "string",
950 - "name": "string",
951 - "picture": "string",
952 - "minspeed": 0,
953 - "maxspeed": 0,
954 - "width": 0,
955 - "imbeddedtrailer": true,
956 - "fueloutlay": 0,
957 - "hoppercapacity": 0,
958 - "hopperdischargespeed": 0,
959 - "modelType": 0
960 -}
961 -
962 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
963 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
964 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
965 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
966 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
967 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
968 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
969 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
970 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
971 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
972 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
973 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
974 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
975 -
976 -== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
977 -
978 -(% class="box errormessage" %)
979 -(((
980 -(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 -)))
982 -
983 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
984 -
985 -(% style="color:#000000" %)Метод запроса: **DELETE**
986 -
987 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
988 -
989 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
990 -
991 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
992 -
993 -Ответ: В случае успеха **Success 200**
994 -
995 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
996 -
997 -== (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
998 -
999 -(% class="box infomessage" %)
1000 -(((
1001 -(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1002 -)))
1003 -
1004 -(% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1005 -
1006 -(% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1007 -
1008 -(% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1009 -
1010 -(% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1011 -
1012 -(% style="color:#000000" %)Метод запроса: **GET**
1013 -
1014 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1015 -
1016 -(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1017 -
1018 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1019 -
1020 -(% style="color:#000000" %)Ответ:
1021 -
1022 -(((
1023 -{
1024 -
1025 -(((
1026 - "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1027 - "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1028 -)))
1029 -
1030 -(((
1031 - ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1032 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1033 -)))
1034 -
1035 - "vehicleId": "", ~/~/ ID объекта
1036 - "name": "", ~/~/ Имя объекта
1037 - "imei": "", ~/~/ IMEI объекта
1038 - "deviceTypeId": , ~/~/ ID типа устройства
1039 - "deviceTypeName": "", ~/~/ Название типа устройства
1040 - "sim1": "", ~/~/ Номер SIM1
1041 - "sim2": "", ~/~/ Номер SIM2
1042 - "parentId": "", ~/~/ ID клиента-родителя
1043 - "parentName": "", ~/~/ Наименование клиента-родителя
1044 - "modelId": "", ~/~/ ID модели объекта
1045 - "modelName": "", ~/~/ Имя модели объекта
1046 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1047 - "unitName": "string", ~/~/ Наименование подразделения
1048 - "status": 0, ~/~/ Статус объекта
1049 - "createdAt": "", ~/~/ Дата создания объекта
1050 - },
1051 -"customFields": [ ~/~/ Произвольные поля
1052 - {
1053 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1054 - "name": "string", ~/~/ Имя поля
1055 - "value": "string", ~/~/ Значение поля
1056 - "forClient": true, ~/~/ Не используемая функция
1057 - "forTooltip": true, ~/~/ Отображать в подсказке
1058 - "forReport": true ~/~/ Отображать в отчете
1059 - }
1060 -
1061 -], ~/~/ Данные с вкладки нормы
1062 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1063 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1064 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1065 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1066 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1067 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1068 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1069 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1070 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1071 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1072 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1073 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1074 - "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1075 - "mileageCoeff": 0, ~/~/ коэффициент пробега
1076 - "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1077 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1078 - "counters": { ~/~/ Счетчики
1079 - "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1080 - "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1081 - "mileage": 0, ~/~/ Текущий пробег
1082 - "motohours": 0, ~/~/ Текущие моточасы
1083 - "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1084 - "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
196 +{{{ "vehicleId": “”, // идентификатор объекта
197 + "name": "", // имя объекта
198 + "imei": "", // IMEI объекта
199 + "deviceTypeId": “”, // идентификатор устройства объекта
200 + "deviceTypeName": "" // наименование устройства объекта
201 + "parentId": "", // идентификатор клиента-родителя
202 + "parentName": "" // наименование клиента-родителя,
203 + "modelId": "", // идентификатор модели объекта
204 + "modelName": "" // наименование модели объекта,
205 + "unitId": "", // идентификатор подразделения
206 + "unitName": "", // наименование подразделения
207 + "status": “”, // статус объекта
208 + ...
1085 1085   },
210 + ...}}}
1086 1086  
1087 -"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1088 - "id": "string", ~/~/ ID объекта
1089 - "enabled": true, ~/~/ Включить, true - активна, false - не активна
1090 - "host": "string", ~/~/ CMSV6 Web Host
1091 - "login": "string", ~/~/ CMSV6 Account
1092 - "password": "string" ~/~/ CMSV6 Password
1093 - },
1094 -
1095 -"commandTemplates": [ ~/~/ Шаблоны команд
1096 - {
1097 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1098 - "name": "string", ~/~/ Наименование команды
1099 - "command": "string", ~/~/ Текст команды
1100 - "retries": 0 ~/~/ Количество попыток
1101 - }
1102 - ],
1103 - "sensors": [ ~/~/ Датчики
1104 - {
1105 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1106 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1107 - "type": 0, ~/~/ Тип датчика
1108 - "name": "string", ~/~/ Имя датчика
1109 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1110 - "inputNumber": 0, ~/~/ Номер входа
1111 - "pseudonym": "string", ~/~/ Псевдоним
1112 - "medianDegree": 0, ~/~/ Медианная фильтрация
1113 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1114 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1115 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1116 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1117 - {
1118 - "grades": [ ~/~/ Таблица тарировки 1
1119 - {
1120 - "input": 0, ~/~/ Входящее значение
1121 - "output": 0 ~/~/ Выходящее значение
1122 - }
1123 - ],
1124 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1125 - }
1126 - ],
1127 - "showInTooltip": true, ~/~/ Отображать в подсказке
1128 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1130 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1131 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1132 - "expr": "string", ~/~/ Формула
1133 - "children": [ ~/~/ массив дочерних датчиков
1134 - "string"
1135 - ],
1136 - "customParams": { ~/~/ прочие произвольные параметры
1137 - "additionalProp1": "string",
1138 - "additionalProp2": "string",
1139 - "additionalProp3": "string"
1140 - },
1141 -
1142 -~/~/ Характерные для произвольного:
1143 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1144 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1145 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1146 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1147 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1148 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1149 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1150 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1151 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1152 -~/~/ "ValueOn": "Вкл.",
1153 -~/~/ "ValueOff": "Выкл."
1154 - "summaryMaxValue": 0 ~/~/ Макс. значение
1155 - }
1156 - "drivers": [ ~/~/ Водители
1157 - {
1158 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1159 - "name": "string", ~/~/ Наименование
1160 - "description": "string",
1161 - "isDefault": true ~/~/ По умолчанию
1162 - }
1163 - ],
1164 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1165 - {
1166 - "id": "", ~/~/ ID  задания
1167 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1168 - "name": "", ~/~/ Наименование задания
1169 - "description": "", ~/~/ Описание задания
1170 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1171 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1172 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1173 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1174 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1175 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1176 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1177 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1178 - }
1179 - ],
1180 -"statusHistory": [ ~/~/ История статусов
1181 - {
1182 - "status": 0,
1183 - "date": "2023-05-22T09:57:39.562Z",
1184 - "description": "string",
1185 - "additionalInfo": "string"
1186 -
1187 -(((
1188 1188  }
1189 - ],
1190 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1191 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1192 -)))
1193 1193  
1194 -(((
1195 - ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1196 -}
1197 -
1198 -)))
1199 -)))
214 +Параметр «status»содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже. 0 - «Блокировка» 1 - «Активен», 2 - «Отменен» 3 - «Оборудован» 4 - «Диагностика» 5 - «Сервис» 6 - «Демонтаж» 7 - «Монтаж» 8 - «Дозаказ» 9 - «Обслужен» 10 - «Списан» 11 - «Неисправен» 12 - «Проверен» 13 - «Не эксплуатируется»
1200 1200  
1201 -(% style="text-align:left" %)
1202 -Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
216 + **Добавление пользователя**
1203 1203  
1204 -(% style="text-align:left" %)
1205 -0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
218 +Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1206 1206  
220 +Метод запроса: POST
1207 1207  
1208 -== **Отправить команду на терминал** ==
222 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1209 1209  
1210 -(% class="box successmessage" %)
1211 -(((
1212 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1213 -)))
224 +В заголовках запроса: X-Auth: Токен авторизации
1214 1214  
1215 -Команда для отправки на тс.
226 +Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
1216 1216  
1217 -{  
1218 -"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1219 -"command": "", ~/~/ Текст отправляемой команды
1220 -"retries": "", ~/~/ Количество попыток отправки на терминал
1221 -"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1222 -}
228 +Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
1223 1223  
1224 -В ответ получаем cmdid
230 + **Редактирование пользователя**
1225 1225  
232 +Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1226 1226  
1227 -== **Получить ответ на отправленную на ТС команду** ==
234 +Метод запроса: PUT
1228 1228  
1229 -(% class="box infomessage" %)
1230 -(((
1231 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1232 -)))
236 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
1233 1233  
1234 -Идентификатор команды: cmdId
238 +В заголовках запроса: X-Auth: Токен авторизации
1235 1235  
1236 -Запрос от терминала на ответ команды
240 +Параметры в теле запроса (JSON): { «id»: «», // ID пользователя «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] } Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] } **Изменить статус пользователя** Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth») Метод запроса: PUT URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]]{id} Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации Параметры в теле запроса (JSON): { «status»: «», //статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
1237 1237  
1238 -Пример ответ от терминала:
242 +{{{ "description": "", // описание
243 + "data": "" // данные, связанные со сменой статуса}}}
1239 1239  
1240 -ID= "" ~/~/ идентификатор объекта
1241 -Soft="" ~/~/ версия софта
1242 -GPS=4 ~/~/ тип трекера
1243 -Time=11:05:43 28.06.24 ~/~/ время запроса
1244 -Lat=45.056221 ~/~/ широта
1245 -Lon=39.035938 ~/~/ долгота
1246 -Speed=0.0 ~/~/ скорость
1247 -Course=181.4 ~/~/направление
1248 -
1249 -(((
1250 -== **Список отправленных объекту команд с ответами** ==
1251 -
1252 -(% class="box infomessage" %)
1253 -(((
1254 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1255 -)))
1256 -
1257 -Идентификатор ТС: vehicleId
1258 -
1259 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1260 -
1261 -Пример ответа терминала
1262 -
1263 -[ 
1264 -{    
1265 -"id": "", ~/~/ идентификатор пользователя
1266 -"commandText": "", ~/~/Текст команды.
1267 -"templateId": "", ~/~/Идентификатор шаблона
1268 -"updated": "", ~/~/ Время отправки  
1269 -"tryCount": 0, ~/~/ Количество попыток отправки команды
1270 -"answer": "", ~/~/ Ответ терминала.
1271 -"status": "" ~/~/ Статус отправки
1272 1272  }
1273 -]
1274 -)))
1275 1275  
1276 -== (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
247 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
1277 1277  
1278 -(% class="box successmessage" %)
1279 -(((
1280 -(% lang="en-US" %)**POST /api/v3/vehicles**
1281 -)))
249 + **Удаление пользователя**
1282 1282  
1283 -(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
251 +Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
1284 1284  
1285 -(% style="color:#000000" %)Метод запроса: **POST**
253 +Метод запроса: DELETE
1286 1286  
1287 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
255 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]]{id}
1288 1288  
1289 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
257 +Параметр запроса: {id} - Guid пользователя В заголовках запроса: X-Auth: Токен авторизации
1290 1290  
1291 -(% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
259 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
1292 1292  
1293 -(% style="color:#000000" %){
261 + **Добавление объекта**
1294 1294  
263 +Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth», Content-Type: application/json;charset=utf-8)
1295 1295  
1296 -(((
1297 - "vehicleId": 0, ~/~/ ID ТС
1298 -)))
265 +Метод запроса: POST
1299 1299  
1300 - "parentId": "" , ~/~/ ID клиента
1301 - "name": "" , ~/~/ имя ТС
1302 - "imei": "" , ~/~/ IMEI
1303 - "deviceTypeId": "" , ~/~/ ID типа устройства
1304 - "modelId": "" , ~/~/ ID модели
1305 - "unitId": "" , ~/~/ ID подразделения
1306 - "sim1": "" , ~/~/ Номер SIM 1
1307 - "sim2": "" , ~/~/ Номер SIM2
1308 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1309 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1310 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1311 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1312 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1313 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1314 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1315 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1316 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1317 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1318 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1319 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1320 - "mileageCalcMethod": 0,
1321 - "mileageCoeff": 0,
1322 - "locationByCellId": true,
1323 - "dottedLineTrackWhenNoCoords": true,
1324 - "counters": ~/~/ счетчики
1325 - {
1326 - "mileage": "" , ~/~/ пробег
1327 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1328 - "motohours": "" , ~/~/ моточасы
1329 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1330 - },
1331 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1332 - "enabled": true, ~/~/ флаг включения
1333 - "id": "" , ~/~/ идентификатор
1334 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1335 - "login": "" , ~/~/ имя учетной записи
1336 - "password": "" ~/~/ пароль учетной записи
1337 - },
1338 - "inspectionTasks": ~/~/ задания на ТО
1339 - {
1340 - "enabled": "" , ~/~/ Признак включения
1341 - "name": "" , ~/~/ Имя задания
1342 - "description": "" , ~/~/ Описание задания
1343 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1344 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1345 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1346 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1347 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1348 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1349 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1350 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1351 - }
1352 -"drivers": [ ~/~/ Водители
1353 - {
1354 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1355 - "isDefault": true
1356 - }
1357 - ],
1358 - "commandTemplates": [ ~/~/ Шаблон команды
1359 - {
1360 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1361 - "name": "string",
1362 - "command": "string",
1363 - "retries": 0
1364 - }
1365 - ],
1366 -"sensors": [ ~/~/ Датчики
1367 - {
1368 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1369 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1370 - "type": 0, ~/~/ Тип датчика
1371 - "name": "string", ~/~/ Имя датчика
1372 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1373 - "inputNumber": 0, ~/~/ Номер входа
1374 - "pseudonym": "string", ~/~/ Псевдоним
1375 - "medianDegree": 0, ~/~/ Медианная фильтрация
1376 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1377 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1378 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1379 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1380 - {
1381 - "grades": [ ~/~/ Таблица тарировки 1
1382 - {
1383 - "input": 0, ~/~/ Входящее значение
1384 - "output": 0 ~/~/ Выходящее значение
1385 - }
1386 - ],
1387 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1388 - }
1389 - ],
1390 - "showInTooltip": true, ~/~/ Отображать в подсказке
1391 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1392 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1393 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1394 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1395 - "expr": "string", ~/~/ Формула
1396 - "children": [ ~/~/ массив дочерних датчиков
1397 - "string"
1398 - ],
1399 - "customParams": { ~/~/ прочие произвольные параметры
1400 - "additionalProp1": "string",
1401 - "additionalProp2": "string",
1402 - "additionalProp3": "string"
1403 - },
1404 -~/~/ Характерные для произвольного:
1405 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1406 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1407 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1408 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1409 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1410 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1411 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1412 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1413 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1414 -~/~/ "ValueOn": "Вкл.",
1415 -~/~/ "ValueOff": "Выкл."
1416 - "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
267 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1417 1417  
1418 -(((
1419 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1420 - {
1421 - "from": 0, ~/~/ С какого значения
1422 - "color": "string", ~/~/ Каким цветом
1423 - "text": "string" ~/~/ Текст подписи к этому интервалу
1424 - }
1425 - ]
1426 - }
1427 - ],
1428 -)))
269 +В заголовках запроса: X-Auth: Токен авторизации
1429 1429  
1430 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
271 +Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON {
1431 1431  
1432 -
1433 - "customFields": [ ~/~/ Произвольные поля
1434 - {
1435 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1436 - "name": "string", ~/~/ Наименование произвольного поля
1437 - "value": "string", ~/~/ Значение произвольного поля
1438 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1439 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1440 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1441 -
1442 -(((
1443 - }
1444 - ],
1445 - "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1446 -)))
1447 -
1448 -(((
1449 - ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1450 -}
1451 -)))
1452 -
1453 -
1454 -(% style="color:#000000" %)Ответ:
1455 -
1456 -
1457 -(((
1458 -(((
1459 -(((
1460 -{
1461 - "vehicleId": 0,  ~/~/ ID ТС
1462 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1463 - "name": "string", ~/~/ Имя объекта
1464 - "imei": "string", ~/~/ IMEI
1465 - "deviceTypeId": 0, ~/~/ ID типа устройства
1466 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1467 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1468 - "sim1": "string", ~/~/ SIM1
1469 - "sim2": "string", ~/~/ SIM2
1470 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1471 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1472 - "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1473 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1474 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1475 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1476 - "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1477 - "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1478 - "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1479 - "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1480 - "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1481 - "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1482 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1483 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1484 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1485 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1486 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1487 - "counters": {  ~/~/ Dto для состояний счётчиков
1488 - "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1489 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1490 - "mileage": 0, ~/~/ Пробег
1491 - "motohours": 0 ~/~/ Моточасы
273 +{{{ "parentId": "", // ID клиента
274 + "name": "", // имя ТС
275 + "imei": "", // IMEI
276 + "deviceTypeId": "",// ID типа устройства
277 + "modelId": "",
278 + "unitId": "", // ID подразделения
279 + "sim1": "", // Номер SIM 1
280 + "sim2": "", // Номер SIM2
281 + "consumptionPer100Km" : "", // Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
282 + "consumptionPerHour": "", // Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
283 + "consumptionIdle": "",// Расход топлива на холостом ходу
284 + "counters": {
285 + "mileage": "", // пробег
286 + "mileageEnabled": true, // флаг активности счётчика "пробег"
287 + "motohours":"", // моточасы
288 + "motohoursEnabled": true // флаг активности счётчика "моточасы"
1492 1492   },
1493 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
1494 - "id": "string", ~/~/ CMSV6 Идентификатор
1495 - "enabled": true, ~/~/ Признак включения
1496 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1497 - "login": "string", ~/~/ CMSV6 имя учетной записи
1498 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
1499 - },
1500 - "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1501 - {
1502 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1503 - "enabled": true, ~/~/ Признак включения
1504 - "name": "string", ~/~/ Имя задания
1505 - "description": "string", ~/~/ Описание задания
1506 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1507 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1508 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1509 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1510 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
1511 - "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1512 - "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1513 - "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1514 - }
1515 - ],
1516 - "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1517 - {
1518 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1519 - "inputNumber": 0, ~/~/ № входа.
1520 - "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1521 - "comment": "string", ~/~/ Комментарий
1522 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1523 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1524 - "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1525 - "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1526 - }
1527 - ],
1528 - "commandTemplates": [  ~/~/ Список шаблонов команд
1529 - {
1530 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1531 - "name": "string", ~/~/ Название шаблона команд
1532 - "command": "string", ~/~/ Команда на выполнение
1533 - "retries": 0 ~/~/ Лимит попыток отправки
1534 - }
1535 - ],
1536 - "sensors": [ ~/~/ Список датчиков
1537 - {
1538 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1539 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1540 - "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1541 - "name": "string",  ~/~/ Имя датчика
1542 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1543 - "inputNumber": 0, ~/~/ Номер входа
1544 - "pseudonym": "string", ~/~/ Псевдоним
1545 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
1546 - "isInverted": true, ~/~/  Признак инверсии
1547 - "disabled": true, ~/~/ Датчик не участвует в обработке
1548 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1549 - "gradesTables": [ ~/~/ Тарировка
1550 - {
1551 - "grades": [ ~/~/ Таблицы тарировки
1552 - {
1553 - "input": 0, ~/~/ Вход
1554 - "output": 0 ~/~/ Выход
1555 - }
1556 - ],
1557 - "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1558 - }
1559 - ],
1560 - "showInTooltip": true, ~/~/ Отображение в подсказке
1561 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1562 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1563 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1564 - "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1565 - "expr": "string", ~/~/ Выражение
1566 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1567 - "string"
1568 - ],
1569 - "customParams": {
1570 - "additionalProp1": "string",
1571 - "additionalProp2": "string",
1572 - "additionalProp3": "string"
290 + "cmsv6Parameters": { // параметры CMSv6
291 + "enabled": true, // флаг включения
292 + //"id": "", // идентификатор
293 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
294 + "login": "", // имя учетной записи
295 + "password": "" // пароль учетной записи
1573 1573   },
1574 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1575 - "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1576 - {
1577 - "from": 0, ~/~/ С какого значения
1578 - "color": "string", ~/~/ Каким цветом
1579 -)))
1580 -
1581 -(((
1582 - "text": "string" ~/~/ Текст подписи к этому интервалу
1583 - }
1584 - ]
1585 - }
1586 - ],
1587 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1588 - "customFields": [ ~/~/ Список произвольных полей
1589 - {
1590 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1591 - "name": "string", ~/~/ Наименование произвольного поля
1592 - "value": "string", ~/~/ Значение произвольного поля
1593 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1594 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1595 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
1596 - }
1597 - ],
1598 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1599 -}
1600 -)))
1601 -)))
1602 -)))
1603 -
1604 -
1605 -**Валидация:**
1606 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
1607 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1608 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1609 -
1610 -
1611 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1612 -
1613 -(% class="box successmessage" %)
1614 -(((
1615 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1616 -)))
1617 -
1618 -Метод запроса: **POST**
1619 -
1620 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1621 -
1622 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1623 -
1624 -
1625 -Ответ:
1626 -
1627 -{
1628 -
1629 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1630 -
1631 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1632 -
1633 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1634 -
1635 - "Message": "string", ~/~/ Информация о выполнении запроса
1636 -
1637 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1638 -
1639 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1640 -
1641 - "Data": "string" ~/~/ Данные
1642 -
1643 -}
1644 -
1645 -
1646 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1647 -
1648 -(% class="box infomessage" %)
1649 -(((
1650 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1651 -)))
1652 -
1653 -Метод запроса: **GET**
1654 -
1655 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1656 -
1657 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1658 -
1659 -
1660 -Ответ:
1661 -
1662 -{
1663 -
1664 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1665 -
1666 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1667 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1668 -
1669 - "Message": "string", ~/~/ Информация о выполнении запроса
1670 -
1671 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1672 -
1673 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1674 -
1675 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1676 -
1677 - "Data": "string" ~/~/ Данные
1678 -
1679 -}
1680 -
1681 -
1682 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1683 -
1684 -(% class="box infomessage" %)
1685 -(((
1686 -(% lang="en-US" %)**POST /api/v3/vehicles/find**
1687 -)))
1688 -
1689 -(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1690 -
1691 -(% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1692 -
1693 -(% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1694 -
1695 -(% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1696 -
1697 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1698 -
1699 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1700 -
1701 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1702 -
1703 -(% style="color:#000000" %)Метод запроса: **POST**
1704 -
1705 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1706 -
1707 -(% style="color:#000000" %)В заголовках запроса:
1708 -
1709 -(% style="color:#000000" %)− Content-Type: __**application/json**__
1710 -
1711 -(% style="color:#000000" %)− X-Auth: Токен авторизации
1712 -
1713 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1714 -
1715 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1716 -
1717 -{
1718 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1719 - "name": null, ~/~/ Имя ТС (string, опционально)
1720 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1721 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1722 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1723 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1724 - "unitName": "string",  ~/~/ Название подразделения (опционально)
1725 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1726 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1727 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1728 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1729 -}
1730 -
1731 -(% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1732 -
1733 -(% style="color:#000000" %)Ответ:
1734 -
1735 -(% style="color:#000000" %)[
1736 -{
1737 -
1738 -(((
1739 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1740 -)))
1741 -
1742 -(((
1743 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1744 - "name": "" ~/~/ наименование объекта
1745 - "imei": "" ~/~/ IMEI объекта
1746 - "deviceTypeId": "" ~/~/ идентификатор типа устройства
1747 - "deviceTypeName": "" ~/~/ наименование типа устройства
1748 - "sim1": "" ~/~/ первый номер телефона
1749 - "sim2": "" ~/~/ второй номер телефона
1750 - "parentId": "" ~/~/ идентификатор клиента-родителя
1751 - "parentName": "" ~/~/ наименование клиента-родителя
1752 - "modelId": "" ~/~/ идентификатор модели объекта
1753 - "modelName": "" ~/~/ наименование модели объекта
1754 - "unitId": "" ~/~/ идентификатор подразделения
1755 - "unitName": "" ~/~/ наименование подразделения
1756 - "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1757 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1758 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1759 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1760 - "customFields": [ 
1761 - {
1762 - "id": "", ~/~/ идентификатор произвольного поля
1763 - "name": "", ~/~/ имя произвольного поля
1764 - "value": "", ~/~/ значение произвольного поля
1765 - "forClient": true, ~/~/ право на отображение у клиента
1766 - "forTooltip": false, ~/~/ право на отображение в подсказке
1767 - "forReport": false ~/~/ право на отображение в отчетах
1768 -)))
1769 -
1770 -(((
1771 - }
1772 - ],
1773 - "vehicleGroups": [  ~/~/ Группы ТС
297 + "inspectionTasks": [ // задания на ТО
1774 1774   {
1775 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1776 - "name": "string" ~/~/ Наименование группы ТС
1777 - }
1778 - ]
1779 - }
1780 -]
1781 -)))
1782 -
1783 -(% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1784 -
1785 -== (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1786 -
1787 -(% class="box successmessage" %)
1788 -(((
1789 -(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1790 -)))
1791 -
1792 -(% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1793 -
1794 -(% style="color:#000000" %)Метод запроса: **POST**
1795 -
1796 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
1797 -
1798 -(% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1799 -
1800 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1801 -
1802 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1803 -
1804 -(% style="color:#000000" %){
1805 -
1806 - "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1807 - ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1808 - ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1809 - "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1810 - "description": "", ~/~/ Описание
1811 - "data": "", ~/~/ Данные
1812 - "overwrite": false, ~/~/ Флаг перезаписи
1813 - "stage": "", ~/~/ Состояние, может быть null
1814 -(% style="color:#000000" %)}
1815 -
1816 -(% style="color:#000000" %)Ответ:
1817 -
1818 -(% style="color:#000000" %){(%%)
1819 - "status": "", ~/~/ значение статуса
1820 - "date": "", ~/~/ Дата смены статуса 
1821 - "description": "", ~/~/ Описание
1822 - "data": "", ~/~/ Данные
1823 - "overwrite": false, ~/~/ Флаг перезаписи
1824 - "stage": "", ~/~/ Состояние
1825 -(% style="color:#000000" %) }
1826 -
1827 -== ==
1828 -
1829 -== (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1830 -
1831 -(% class="box warningmessage" %)
1832 -(((
1833 -(% lang="en-US" %)**PUT /api/v3/vehicles**
1834 -)))
1835 -
1836 -(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1837 -
1838 -(% style="color:#000000" %)Метод запроса: **PUT**
1839 -
1840 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1841 -
1842 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1843 -
1844 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
1845 -
1846 -(% style="color:#000000" %){
1847 - "vehicleId": , ~/~/ ID объекта
1848 - "parentId": "" , ~/~/ ID клиента
1849 - "name": "" , ~/~/ имя ТС
1850 - "imei": "" , ~/~/ IMEI
1851 - "deviceTypeId": "" , ~/~/ ID типа устройства
1852 - "modelId": "" , ~/~/ ID модели
1853 - "unitId": "" , ~/~/ ID подразделения
1854 - "sim1": "" , ~/~/ Номер SIM 1
1855 - "sim2": "" , ~/~/ Номер SIM2
1856 - "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1857 - "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1858 - "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1859 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1860 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1861 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1862 - "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1863 - "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1864 - "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1865 - "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1866 - "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1867 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1868 -
1869 - "mileageCalcMethod": 0,
1870 - "mileageCoeff": 0,
1871 - "locationByCellId": true,
1872 - "dottedLineTrackWhenNoCoords": true,
1873 - "counters": ~/~/ счетчики
1874 - {
1875 - "mileage": "" , ~/~/ пробег
1876 - "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1877 - "motohours": "" , ~/~/ моточасы
1878 - "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
299 + "enabled": "", // Признак включения
300 + "name": "", // Имя задания
301 + "description": "", // Описание задания
302 + "mileageCondition": "", // Условие по пробегу (в метрах, null - условие не работает)
303 + "lastMileage": "", // Пробег (в метрах) на момент последнего ТО (null - неважно)
304 + "motohoursCondition": "", // Условие по моточасам (в секундах, null - условие не работает)
305 + "lastMotohours": "", // Моточасы (в секундах) на момент последнего ТО (null - неважно)
306 + "periodicCondition": "", // Условие периодичности по времени (null - условие не работает)
307 + "kind": "", // Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
308 + "lastInspectionDate": "", // Дата последнего ТО (null - не указано)
309 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
1879 1879   },
1880 - "cmsv6Parameters": { ~/~/ параметры CMSv6
1881 - "enabled": true, ~/~/ флаг включения
1882 - "id": "" , ~/~/ идентификатор
1883 - "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1884 - "login": "" , ~/~/ имя учетной записи
1885 - "password": "" ~/~/ пароль учетной записи
1886 - },
1887 - "inspectionTasks": ~/~/ задания на ТО
1888 - {
1889 - "enabled": "" , ~/~/ Признак включения
1890 - "name": "" , ~/~/ Имя задания
1891 - "description": "" , ~/~/ Описание задания
1892 - "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1893 - "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1894 - "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1895 - "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1896 - "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1897 - "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1898 - "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1899 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1900 - }
311 + ]}}}
1901 1901  
1902 -"drivers": [ ~/~/ Водители
1903 - {
313 +… }
1904 1904  
1905 -(((
1906 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1907 - "inputNumber": 0, ~/~/ № входа.
1908 - "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1909 - "comment": "string", ~/~/ Комментарий.
1910 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1911 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1912 - "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1913 - "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1914 -)))
1915 -
1916 - } 
1917 - ],
1918 - "commandTemplates": [ ~/~/ Шаблон команды
1919 - {
1920 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1921 - "name": "string",
1922 - "command": "string",
1923 - "retries": 0
1924 - }
1925 - ],
1926 -"sensors": [ ~/~/ Датчики
1927 - {
1928 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1929 - "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1930 - "type": 0, ~/~/ Тип датчика
1931 - "name": "string", ~/~/ Имя датчика
1932 - "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1933 - "inputNumber": 0, ~/~/ Номер входа
1934 - "pseudonym": "string", ~/~/ Псевдоним
1935 - "medianDegree": 0, ~/~/ Медианная фильтрация
1936 - "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1937 - "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1938 - "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1939 - "gradesTables": [ ~/~/ Массив таблиц тарировки
1940 - {
1941 - "grades": [ ~/~/ Таблица тарировки 1
1942 - {
1943 - "input": 0, ~/~/ Входящее значение
1944 - "output": 0 ~/~/ Выходящее значение
1945 - }
1946 - ],
1947 - "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1948 - }
1949 - ],
1950 - "showInTooltip": true, ~/~/ Отображать в подсказке
1951 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
1952 -
1953 -(((
1954 - "color": "string",** ~/~/ **Цвет датчика
1955 -)))
1956 -
1957 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1958 - "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1959 - "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1960 - "expr": "string", ~/~/ Формула
1961 - "children": [ ~/~/ массив дочерних датчиков
1962 - "string"
1963 - ],
1964 - "customParams": { ~/~/ прочие произвольные параметры
1965 - "additionalProp1": "string",
1966 - "additionalProp2": "string",
1967 - "additionalProp3": "string"
1968 - },
1969 -~/~/ Характерные для произвольного:
1970 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1971 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1972 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1973 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1974 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1975 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1976 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1977 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1978 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1979 -~/~/ "ValueOn": "Вкл.",
1980 -~/~/ "ValueOff": "Выкл."
1981 - "summaryMaxValue": 0 ~/~/ Макс. значение
1982 -
1983 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1984 - {
1985 - "from": 0, ~/~/ С какого значения
1986 - "color": "string", ~/~/ Каким цветом
1987 - "text": "string" ~/~/ Текст подписи к этому интервалу
1988 - }
1989 - ]
1990 - }
1991 - ],
1992 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1993 -
1994 - "customFields": [ ~/~/ Произвольные поля
1995 - {     
1996 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1997 - "name": "string", ~/~/ Наименование произвольного поля
1998 - "value": "string", ~/~/ Значение произвольного поля
1999 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2000 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2001 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
2002 - }
2003 -
2004 -(((
2005 - ],
2006 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2007 -)))
2008 -
2009 -}
2010 -
2011 -
2012 -(% style="color:#000000" %)Ответ:
2013 -
2014 -(((
2015 -{
2016 - "vehicleId": 0, ~/~/ ID ТС
2017 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2018 - "name": "string", ~/~/ Имя объекта
2019 - "imei": "string", ~/~/ IMEI
2020 - "deviceTypeId": 0, ~/~/ ID типа устройства
2021 - "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2022 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2023 - "sim1": "string", ~/~/ SIM1
2024 - "sim2": "string", ~/~/ SIM2
2025 - "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2026 - "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2027 - "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2028 - "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2029 - "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2030 - "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2031 - "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2032 - "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2033 - "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2034 - "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2035 - "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2036 - "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2037 - "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2038 - "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2039 - "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2040 - "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2041 - "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2042 - "counters": { ~/~/ состояний счётчиков
2043 - "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2044 - "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2045 - "mileage": 0, ~/~/ Пробег
2046 - "motohours": 0 ~/~/ Моточасы 
2047 - },
2048 - "cmsv6Parameters": { ~/~/ Dto для CMSv6
2049 - "id": "string", ~/~/ CMSV6 Идентификатор
2050 - "enabled": true, ~/~/ Признак включения
2051 - "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2052 -)))
2053 -
2054 -
2055 -(((
2056 -~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2057 - "login": "string", ~/~/ CMSV6 имя учетной записи
2058 - "password": "string" ~/~/ CMSV6 — пароль учетной записи
2059 - },
2060 - "inspectionTasks": [ ~/~/ Задания на ТО
2061 - {
2062 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2063 - "enabled": true, ~/~/ Признак включения
2064 - "name": "string", ~/~/ Имя задания
2065 - "description": "string", ~/~/ Описание задания
2066 - "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2067 - "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2068 - "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2069 - "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2070 - "periodicCondition": 0, ~/~/ Условие периодичности по времени
2071 - "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2072 - "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2073 - "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2074 - }
2075 - ],
2076 - "drivers": [  ~/~/ Список водителей
2077 - {
2078 - "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2079 - "inputNumber": 0, ~/~/ № входа.
2080 - "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2081 - "comment": "string", ~/~/ Комментарий.
2082 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2083 - "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2084 - "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2085 - "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2086 - }
2087 - ],
2088 - "commandTemplates": [ ~/~/ Список шаблонов команд
2089 - {
2090 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2091 - "name": "string", ~/~/ Название шаблона команд
2092 - "command": "string", ~/~/ Команда на выполнение
2093 - "retries": 0 ~/~/ Лимит попыток отправки
2094 - }
2095 - ],
2096 - "sensors": [  ~/~/ Список датчиков 
2097 - {
2098 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2099 - "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2100 - "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2101 -)))
2102 -
2103 -(((
2104 -~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2105 -)))
2106 -
2107 -(((
2108 -~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2109 -)))
2110 -
2111 -(((
2112 -~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2113 -)))
2114 -
2115 -(((
2116 -~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2117 -)))
2118 -
2119 -(((
2120 -~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2121 - "name": "string", ~/~/ Имя датчика
2122 - "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2123 -)))
2124 -
2125 -(((
2126 -~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2127 - "inputNumber": 0, ~/~/ Номер входа
2128 - "pseudonym": "string", ~/~/ Псевдоним
2129 - "medianDegree": 0, ~/~/ Степень медианной фильтрации
2130 - "isInverted": true, ~/~/ Признак инверсии
2131 - "disabled": true, ~/~/ Датчик не участвует в обработке
2132 - "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2133 - "gradesTables": [ ~/~/ Тарировка
2134 - {
2135 - "grades": [ ~/~/ Таблицы тарировки
2136 - {
2137 - "input": 0, ~/~/ Вход
2138 - "output": 0 ~/~/ Выход
2139 - }
2140 - ],
2141 - "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2142 - }
2143 - ],
2144 - "showInTooltip": true, ~/~/ Отображение в подсказке
2145 - "showLastValid": true, ~/~/ Отображать последнее валидное значение
2146 -
2147 -(((
2148 - "color": "string", ~/~/ цвет уведомлений
2149 -)))
2150 -
2151 - "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2152 - "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2153 - "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2154 - "expr": "string", ~/~/ Выражение
2155 - "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2156 - "string" 
2157 - ],
2158 - "customParams": { ~/~/ Дополнительные настройки
2159 - "additionalProp1": "string",
2160 - "additionalProp2": "string",
2161 - "additionalProp3": "string"
2162 - },
2163 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2164 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2165 - {
2166 - "from": 0, ~/~/ С какого значения
2167 - "color": "string", ~/~/ Каким цветом
2168 - "text": "string" ~/~/ Текст подписи к этому интервалу
2169 - }
2170 - ]
2171 - }
2172 - ],
2173 - "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2174 - "customFields": [ ~/~/ Список произвольных полей
2175 - {
2176 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2177 - "name": "string", ~/~/ Наименование произвольного поля
2178 - "value": "string", ~/~/ Значение произвольного поля
2179 - "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2180 - "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2181 - "forReport": true ~/~/ Отобразить произвольное поле в отчете
2182 - }
2183 - ],
2184 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2185 -}
2186 -)))
2187 -
2188 -**Валидация:**
2189 -- сезонный параметр может быть задан только если задана соответствующая обычная норма;
2190 -- сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2191 -- при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2192 -
2193 -== (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2194 -
2195 -(% class="box errormessage" %)
2196 -(((
2197 -(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2198 -)))
2199 -
2200 -(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2201 -
2202 -(% style="color:#000000" %)Метод запроса: **DELETE**
2203 -
2204 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2205 -
2206 -(% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2207 -
2208 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2209 -
2210 -(% style="text-align:left" %)
2211 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2212 -
2213 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2214 -
2215 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2216 -
2217 -(% class="box infomessage" %)
2218 -(((
2219 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2220 -)))
2221 -
2222 -(% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2223 -
2224 -(% style="color:#000000" %)Метод запроса: **GET**
2225 -
2226 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2227 -
2228 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2229 -
2230 -(% style="color:#000000" %)Ответ:
2231 -
2232 -(% style="color:#000000" %){(%%)
2233 - "deviceTypeId" : "", ~/~/ ID типа устройства
2234 - "deviceTypeName" : "" ~/~/ Название типа устройства
2235 -(% style="color:#000000" %)}
2236 -
2237 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2238 -
2239 -== (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2240 -
2241 -(% class="box infomessage" %)
2242 -(((
2243 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2244 -)))
2245 -
2246 -(% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2247 -
2248 -(% style="color:#000000" %)Метод запроса: **GET**
2249 -
2250 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2251 -
2252 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2253 -
2254 -(% style="color:#000000" %)Ответ:
2255 -
2256 -(% style="color:#000000" %){(%%)
2257 - "id": "", ~/~/ ID типа датчика 
2258 - "name": "", ~/~/ Название
2259 - "description": "", ~/~/ Описание
2260 -(% style="color:#000000" %)}
2261 -
2262 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2263 -
2264 -== (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2265 -
2266 -(% class="box infomessage" style="text-align: left;" %)
2267 -(((
2268 -**POST /api/v3/terminalMessages/count**
2269 -)))
2270 -
2271 -(% style="text-align: left;" %)
2272 -Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2273 -
2274 -(% style="text-align: left;" %)
2275 -Метод запроса **POST**
2276 -
2277 -(% style="text-align: left;" %)
2278 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2279 -
2280 -(% style="text-align: left;" %)
2281 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2282 -
2283 -(% style="text-align: left;" %)
2284 -{
2285 - "vehicleIds": [
2286 - id ~/~/ здесь передается список идентификаторов объектов
2287 - ],
2288 - "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2289 - "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2290 -}
2291 -
2292 -(% style="text-align: left;" %)
2293 2293  Ответ:
2294 2294  
2295 -(% style="text-align: left;" %)
2296 -[
2297 - {
2298 - "vehicleId": 0, ~/~/ идентификатор объекта
2299 - "count": 0 ~/~/ количество сообщений за период
2300 - }
2301 -]
2302 -
2303 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2304 -
2305 -(% class="box infomessage" style="text-align: left;" %)
2306 -(((
2307 -**POST /api/v3/terminalMessages/mapping**
2308 -)))
2309 -
2310 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2311 -
2312 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2313 -
2314 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2315 -
2316 2316  {
2317 - "protocolType": 0,
2318 - "params": ["string"]
2319 -}
2320 2320  
2321 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2322 -|protocolType|ID типа протокола
2323 -|params|(((
2324 -Массив наименований параметров в сообщении
2325 -)))
2326 -
2327 -Ответ:
2328 -
2329 -{
2330 - "protocolType": 0,
2331 - "mapping": {
2332 - "additionalProp1": {
2333 - "inputType": 0,
2334 - "inputNumber": 0
2335 - },
2336 - "additionalProp2": {
2337 - "inputType": 0,
2338 - "inputNumber": 0
2339 - }
2340 - }
2341 -}
2342 -
2343 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2344 -|protocolType|Тип протокола
2345 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2346 -|inputNumber|(((
2347 -Номер входа
2348 -)))
2349 -
2350 -(% class="wikigeneratedid" %)
2351 -Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2352 -
2353 -== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2354 -
2355 -(% class="box infomessage" %)
2356 -(((
2357 -**POST /api/v3/terminalMessages**
2358 -)))
2359 -
2360 -Метод возвращает список сообщений терминала объекта за выбранный период.
2361 -
2362 -(% style="text-align: left;" %)
2363 -Метод запроса **POST**
2364 -
2365 -(% style="text-align: left;" %)
2366 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2367 -
2368 -(% style="text-align: left;" %)
2369 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2370 -
2371 -{
2372 - "vehicleId": 0, ~/~/ id объекта
2373 - "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2374 - "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2375 -}
2376 -
2377 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2378 -|vehicleId|ID объекта
2379 -|from|Дата и время начала периода запроса
2380 -|to|Дата и время окончания периода запроса
2381 -
2382 -Ответ:
2383 -
2384 -[
2385 - {
2386 - "messages": [
319 +{{{ "vehicleId": "", //ID ТС
320 + "parentId": "", //Guid владельца ТС
321 + "name": "", //Имя объекта
322 + "imei": "", //IMEI
323 + "deviceTypeId": "", //ID типа устройства
324 + "modelId": "", //ID модели
325 + "unitId": "", //ID подразделения
326 + "sim1": "", //SIM1
327 + "sim2": "", //SIM2
328 + "consumptionPer100Km": "", //Расход топлива на 100 км
329 + "consumptionIdle": "", //Расход топлива на холостом ходу
330 + "counters": { //Счётчики
331 + "mileageEnabled": true,
332 + "motohoursEnabled": true,
333 + "mileage": "",
334 + "motohours": 345.0
335 + },
336 + "cmsv6Parameters": { //Параметры CmsV6
337 + "id": null,
338 + "enabled": true, //флаг включения
339 + "host": "", // IP-адрес или доменное имя из URL веб-сайта CMSV6
340 + "login": "", // имя учетной записи
341 + "password": "" // пароль учетной записи
342 + },
343 + "inspectionTasks": [ // задания на ТО
2387 2387   {
2388 - "deviceTime": "2023-11-29T07:40:44.052Z",
2389 - "serverTime": "2023-11-29T07:40:44.052Z",
2390 - "speed": 0,
2391 - "altitude": 0,
2392 - "latitude": 0,
2393 - "longitude": 0,
2394 - "satellites": 0,
2395 - "course": 0,
2396 - "voltage": 0,
2397 - "parameters": {
2398 - "additionalProp1": "string",
2399 - "additionalProp2": "string",
2400 - "additionalProp3": "string"
2401 - },
2402 - "photoCount": 0,
2403 - "lbsCorrectedCoords": true,
2404 - "protocolType": 0
2405 - }
2406 - ]
2407 - }
2408 -]
345 + "id": "", // ID задачи
346 + "enabled": false, // Признак включения
347 + "name": "", // Имя задания
348 + "description": "", // Описание задания
349 + "mileageCondition": "", // Условие по пробегу
350 + "lastMileage": "", // Пробег (в метрах)
351 + "motohoursCondition": "", // Условие по моточасам
352 + "lastMotohours": "", // Моточасы
353 + "periodicCondition": "", // Условие периодичности по времени}}}
2409 2409  
2410 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2411 -|deviceTime|Время сообщения терминала
2412 -|serverTime|Время когда сообщение поступило на сервер
2413 -|speed|Скорость
2414 -|altitude|Высота над уровнем моря
2415 -|latitude|Широта
2416 -|longitude|Долгота
2417 -|satellites|Кол-во спутников
2418 -|course|Курс
2419 -|voltage|Бортовое напряжение
2420 -|parameters|Список параметров и их значений
2421 -|photoCount|Количество фото
2422 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2423 -|protocolType|ID типа протокола
2424 -
2425 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2426 -
2427 -== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2428 -
2429 -(% class="box infomessage" %)
2430 -(((
2431 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2432 -)))
2433 -
2434 -(% style="color:#000000" %)Метод запроса: **POST**
2435 -
2436 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2437 -
2438 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2439 -
2440 -(% style="text-align:left" %)
2441 -Тело запроса:
2442 -
2443 -{
2444 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2445 - "vehicleIds": [0], ~/~/ Список ID объектов
2446 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2447 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2448 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2449 -}
2450 -
2451 -Ответ:
2452 -
2453 -[
2454 - {
2455 - "vehicleId": 0, ~/~/ ID объекта
2456 - "name": "string", ~/~/ Имя ТС
2457 - "periods": [ ~/~/ Периоды
2458 - {
2459 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2460 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2461 - "mileage": 0, ~/~/ Пробег за период, километры
2462 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2463 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2464 - "motohours": 0, ~/~/ Моточасы за период, секунды
2465 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2466 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
355 +{{{ "kind": "", // Вид периодичности по времени
356 + "maxQuantity": "" // Сколько раз выполнить задание (null - однократно)
2467 2467   }
2468 - ]
2469 - }
2470 -]
358 + ]}}}
2471 2471  
2472 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2473 -
2474 -(% class="box infomessage" %)
2475 -(((
2476 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2477 -)))
2478 -
2479 -(% style="color:#000000" %)Метод запроса: **POST**
2480 -
2481 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2482 -
2483 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2484 -
2485 -(% style="text-align:left" %)
2486 -Тело запроса:
2487 -
2488 -{
2489 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2490 - "vehicleIds": [0], ~/~/ Список ID объектов
2491 - "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2492 - "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2493 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2494 2494  }
2495 2495  
2496 -Ответ:
362 + **Удаление объекта**
2497 2497  
2498 -[
2499 - {
2500 - "vehicleId": 0, ~/~/ ID объекта
2501 - "name": "string", ~/~/ Имя ТС
2502 - "periods": [ ~/~/ Периоды
2503 - {
2504 - "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2505 - "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2506 - "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2507 - "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2508 - "fuelConsumption": 0, ~/~/ Расход топлива
2509 - "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2510 - }
2511 - ]
2512 - }
2513 -]
364 +Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2514 2514  
2515 -(% class="box warningmessage" %)
2516 -(((
2517 -Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2518 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2519 -)))
366 +Метод запроса: DELETE
2520 2520  
2521 -== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
368 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]]{vehicleId}
2522 2522  
2523 -(% class="box infomessage" %)
2524 -(((
2525 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2526 -)))
370 +Параметр запроса: {id} - Guid объекта
2527 2527  
2528 -(% style="color:#000000" %)Метод запроса: **POST**
2529 -
2530 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2531 -
2532 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2533 -
2534 -(% style="text-align:left" %)
2535 -Тело запроса:
2536 -
2537 -{
2538 - "vehicleIds": [0], ~/~/ Список ID объектов
2539 - "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2540 - "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2541 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2542 -}
2543 -
2544 -Ответ:
2545 -
2546 -[
2547 - {
2548 - "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2549 - "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2550 - "vehicleId": 0, ~/~/ ID объекта
2551 - "name": "string", ~/~/ Имя объекта
2552 - "model": "string", ~/~/ Модель объекта
2553 - "fuels": [ ~/~/ Массив данным по заправкам и сливам
2554 - {
2555 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2556 - "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2557 - "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2558 - "valueFuel": 0, ~/~/ Количество
2559 - "fuelStart": 0, ~/~/ Уровень топлива на начало события
2560 - "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2561 - }
2562 - ]
2563 - }
2564 -]
2565 -
2566 -
2567 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2568 -
2569 -(% class="box infomessage" %)
2570 -(((
2571 -**POST /api/v3/vehicles/moveStop**
2572 -)))
2573 -
2574 -Метод запроса: **POST**
2575 -
2576 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2577 -
2578 2578  В заголовках запроса: X-Auth: Токен авторизации
2579 2579  
374 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»
2580 2580  
2581 -Тело запроса:
376 + **Редактирование объекта**
2582 2582  
2583 -{
2584 - "vehicleIds": [ ], ~/~/ Список ID объектов
2585 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2586 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2587 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2588 -}
378 +Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2589 2589  
2590 -Ответ:
380 +Метод запроса: PUT
2591 2591  
2592 -[ 
2593 - {
2594 - "vehicleId": 0, ~/~/ ID объекта
2595 - "vehicleName": "string", ~/~/ Имя объекта
2596 - "moves": [ ~/~/ Событие движения
2597 - {
2598 - "mileage": 0, ~/~/ Пробег, км
2599 - "eventId": 0, ~/~/ Идентификатор события
2600 - "eventName": "string", ~/~/ Название события
2601 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2602 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2603 - "duration": 0 ~/~/ Продолжительность события, секунд
2604 - }
2605 - ],
2606 - "stops": [ ~/~/ События стоянок
2607 - {
2608 - "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2609 - "eventId": 0, ~/~/ Идентификатор события
2610 - "eventName": "string", ~/~/ Название события
2611 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2612 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2613 - "duration": 0 ~/~/ Продолжительность события, секунд
2614 - }
2615 - ]
2616 - }
2617 -]
382 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
2618 2618  
2619 -
2620 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2621 -
2622 -(% class="box infomessage" %)
2623 -(((
2624 -**POST /api/v3/vehicles/getlastdata**
2625 -)))
2626 -
2627 -Метод запроса: **POST**
2628 -
2629 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2630 -
2631 2631  В заголовках запроса: X-Auth: Токен авторизации
2632 2632  
386 +Параметры в теле запроса (JSON):
2633 2633  
2634 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
388 +//Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON { «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
2635 2635  
2636 2636  Ответ:
2637 - {
2638 - "vehicleId": 0, ~/~/Идентификатор объекта.
2639 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2640 - "vehicleNumber": "string",~/~/Номер объекта.
2641 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2642 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2643 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2644 - "speed": 0,~/~/Скорость объекта.
2645 - "course": 0,~/~/Курс движения [0;360]
2646 - "latitude": 0,~/~/Широта [-90°;90°].
2647 - "longitude": 0,~/~/Долгота [-180°;180°].
2648 - "address": "string",~/~/Адрес.
2649 - "geozones": [ ~/~/Сведения по геозонам.
2650 - {
2651 - "id": 0,
2652 - "name": "string"
2653 - }
2654 -
2655 2655  
2656 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
392 +{ «vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО «motohoursCondition»: «», //Условие по моточасам «lastMotohours»: «», //Моточасы «periodicCondition»: «», //Условие периодичности по времени «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }
2657 2657  
2658 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
394 + **Изменение статуса объекта**
2659 2659  
2660 -(% class="box infomessage" %)
2661 -(((
2662 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2663 -)))
396 +Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»)
2664 2664  
2665 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
398 +Метод запроса: POST
2666 2666  
2667 -(% style="color:#000000" %)Метод запроса: **POST**
400 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]]{vehicleId}
2668 2668  
2669 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
402 +Параметр запроса: {vehicleId} - ID ТС
2670 2670  
2671 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2672 -
2673 -(% style="text-align:left" %)
2674 -Тело запроса:
2675 -
2676 -(% style="text-align:left" %)
2677 -{
2678 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2679 -}
2680 -
2681 -(% style="text-align:left" %)
2682 -Ответ:
2683 -
2684 -[
2685 - {
2686 - "id": 0, ~/~/ Идентификатор объекта геозоны
2687 - "name": "string", ~/~/ Название объекта геозоны
2688 - "type": 0, ~/~/ Тип объекта геозоны
2689 - "fname": "string", ~/~/ Имя файла
2690 - "parentId": "string", ~/~/ Идентификатор клиента
2691 - "radius": 0, ~/~/ Радиус геообъекта
2692 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2693 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2694 - "description": "string", ~/~/ Описание
2695 - "area": 0, ~/~/ Площадь, м^^2^^
2696 - "perimetr": 0, ~/~/ Периметр, м
2697 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2698 - }
2699 -]
2700 -
2701 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2702 -
2703 -(% class="box infomessage" %)
2704 -(((
2705 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2706 -)))
2707 -
2708 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2709 -
2710 -(% style="color:#000000" %)Метод запроса: **POST**
2711 -
2712 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2713 -
2714 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2715 -
2716 -(% style="text-align:left" %)
2717 -Тело запроса:
2718 -
2719 -{
2720 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2721 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2722 - "ids": [ ], ~/~/ Массив id объектов
2723 - "byTime": 0, ~/~/ Объединение событий по времени 
2724 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2725 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2726 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2727 -}
2728 -
2729 -Ответ:
2730 -[
2731 - {
2732 - "geozoneId": 0, ~/~/ ID геообъекта
2733 - "geozoneName": "string", ~/~/ Название геообъекта
2734 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2735 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2736 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2737 - "vehicleId": 0, ~/~/ ID объекта
2738 - "vehicleName": "string" ~/~/ Имя объекта
2739 - }
2740 -]
2741 -
2742 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2743 -
2744 -(% class="box infomessage" %)
2745 -(((
2746 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2747 -)))
2748 -
2749 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2750 -
2751 -(% style="color:#000000" %)Метод запроса: **POST**
2752 -
2753 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2754 -
2755 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2756 -
2757 -(% style="text-align:left" %)
2758 -Тело запроса:
2759 -
2760 -{
2761 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2762 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2763 - "ids": [ ], ~/~/ Массив id геообъектов
2764 - "byTime": 0, ~/~/ Объединение событий по времени 
2765 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2766 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2767 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2768 -}
2769 -
2770 -Ответ:
2771 -
2772 -[
2773 - {
2774 - "geozoneId": 0, ~/~/ ID геообъекта
2775 - "geozoneName": "string", ~/~/ Название геообъекта
2776 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2777 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2778 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2779 - "vehicleId": 0, ~/~/ ID объекта
2780 - "vehicleName": "string" ~/~/ Имя объекта
2781 - }
2782 -]
2783 -
2784 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2785 -
2786 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2787 -
2788 -(% class="box infomessage" %)
2789 -(((
2790 -**POST /api/v3/notifications/find**
2791 -)))
2792 -
2793 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2794 -
2795 -(% style="text-align: left;" %)
2796 -Метод запроса **POST**
2797 -
2798 -(% style="text-align: left;" %)
2799 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2800 -
2801 -(% style="text-align: left;" %)
2802 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2803 -
2804 -{
2805 - "parentId": "" ~/~/ id клиента
2806 -}
2807 -
2808 -Ответ:
2809 -
2810 -[
2811 - {
2812 - "id": 0, ~/~/ ID уведомления
2813 - "name": "string", ~/~/ Название уведомления
2814 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2815 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2816 - "userId": "", ~/~/ Пользователь, создавший уведомление
2817 - "parentId": "", ~/~/ Идентификатор клиента
2818 - "parentName": "string" ~/~/ Имя клиента
2819 - }
2820 -]
2821 -
2822 -== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2823 -
2824 -(% class="box infomessage" %)
2825 -(((
2826 -**GET /api/v3/notifications/{id}**
2827 -)))
2828 -
2829 -Метод возвращает данные правил формирования выбранного уведомления.
2830 -
2831 -(% style="text-align: left;" %)
2832 -Метод запроса **GET**
2833 -
2834 -(% style="text-align: left;" %)
2835 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2836 -
2837 -(% style="text-align: left;" %)
2838 -(% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2839 -
2840 -(% style="text-align: left;" %)
2841 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2842 -
2843 -(% style="text-align: left;" %)
2844 -(% style="color:#000000" %)Ответ:
2845 -
2846 -(% style="text-align: left;" %)
2847 -(% style="color:#000000" %){
2848 - "id": 0, ~/~/ (%%)id уведомления
2849 -(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2850 -(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2851 -(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2852 -(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2853 -(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2854 -(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2855 -(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2856 -(% style="color:#000000" %) 0
2857 - ],
2858 - "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2859 -(% style="color:#000000" %) 0
2860 - ],
2861 - "fieldids": [ ~/~/ (%%)Список id полей для анализа
2862 -(% style="color:#000000" %) 0
2863 - ],
2864 - "settings": { ~/~/ Список параметров уведомления
2865 - "additionalProp1": "string",
2866 - "additionalProp2": "string",
2867 - "additionalProp3": "string"
2868 - },
2869 - "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2870 -(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2871 -(% style="color:#000000" %) ""
2872 - ],
2873 - "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2874 -(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2875 -(% style="color:#000000" %) "string"
2876 - ],
2877 - "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2878 -(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2879 -(% style="color:#000000" %) {
2880 - "id": 0, ~/~/ (%%)Идентификатор участника чата
2881 -(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2882 -(% style="color:#000000" %) }
2883 - ],
2884 - "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2885 -(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2886 -(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2887 -(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2888 -(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2889 -(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2890 -(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2891 -(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2892 -(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2893 -(% style="color:#000000" %)}
2894 -
2895 -== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2896 -
2897 -(% class="box warningmessage" %)
2898 -(((
2899 -**PUT /api/v3/notifications/**
2900 -)))
2901 -
2902 -Метод позволяет отредактировать уведомление.
2903 -
2904 -Метод запроса **PUT**
2905 -
2906 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2907 -
2908 2908  В заголовках запроса: X-Auth: Токен авторизации
2909 2909  
2910 -Тело запроса:
2911 -{
2912 - "id": 0, ~/~/ id уведомления
2913 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2914 - "userId": "", ~/~/ Пользователь, создавший уведомление
2915 - "parentId": "", ~/~/ Идентификатор клиента
2916 - "parentName": "string", ~/~/ Имя клиента
2917 - "name": "string", ~/~/ Название уведомления
2918 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2919 - "vehicleIds": [ ~/~/ Список id объектов для анализа
2920 - 0
2921 - ],
2922 - "geoids": [ ~/~/ Список id геообъектов для анализа
2923 - 0
2924 - ],
2925 - "fieldids": [ ~/~/ Список id полей для анализа
2926 - 0
2927 - ],
2928 - "settings": { ~/~/ Список параметров уведомления
2929 - "additionalProp1": "string",
2930 - "additionalProp2": "string",
2931 - "additionalProp3": "string"
2932 - },
2933 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2934 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2935 - ""
2936 - ],
2937 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2938 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2939 - "string"
2940 - ],
2941 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2942 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2943 - {
2944 - "id": 0, ~/~/ Идентификатор участника чата
2945 - "info": "string" ~/~/ Дополнительные сведения
2946 - }
2947 - ],
2948 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2949 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2950 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2951 - "kind": 0, ~/~/ Определяет вид уведомления
2952 - "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2953 - "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2954 - "timezone": 0, ~/~/ Сдвиг часового пояса
2955 - "validity": 0, ~/~/ Срок действия в днях (1-90)
2956 - "autoProlongation": true ~/~/ Автопродление срока действия
2957 -}
406 +Параметры в теле запроса (JSON): {
2958 2958  
2959 -Ответ:
408 +{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
409 + "date": "", // Дата смены статуса (null если сменить немедленно)
410 + "description": "", // Описание
411 + "data": "", // Данные
412 + "overwrite": false, // Флаг перезаписи
413 + "stage": "", // Состояние, может быть null}}}
2960 2960  
2961 -Success
2962 -
2963 -
2964 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2965 -
2966 -(% class="box warningmessage" %)
2967 -(((
2968 -**PUT** /api/v3/notifications/prolongation
2969 -)))
2970 -
2971 -Метод позволяет продлить уведомления.
2972 -
2973 -Метод запроса **PUT**
2974 -
2975 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2976 -
2977 -В заголовках запроса: X-Auth: Токен авторизации.
2978 -
2979 -Тело запроса:
2980 -
2981 -[
2982 -
2983 -0
2984 -
2985 -]
2986 -
2987 -где 0 идентификатор ids.
2988 -
2989 -== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2990 -
2991 -(% class="box errormessage" %)
2992 -(((
2993 -**DELETE /api/v3/notifications/{id}**
2994 -)))
2995 -
2996 -Метод позволяет удалить выбранное уведомление.
2997 -
2998 -Метод запроса **DELETE**
2999 -
3000 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3001 -
3002 -Передаваемый параметр: {id} - id уведомления
3003 -
3004 -В заголовках запроса: X-Auth: Токен авторизации
3005 -
3006 -Ответ:
3007 -
3008 -Success
3009 -
3010 -
3011 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3012 -
3013 -== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3014 -
3015 -(% class="box infomessage" %)
3016 -(((
3017 -**POST /api/v3/Drivers/find**
3018 -)))
3019 -
3020 -Передается параметр: parentId - ID клиента-родителя
3021 -
3022 -Ответ:
3023 -
3024 -[
3025 - {
3026 - "name": "string", ~/~/ Определяет наименование
3027 - "description": "string", ~/~/ Определяет описание
3028 - "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3029 - "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3030 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
3031 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3032 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3033 - "deleted": true ~/~/ Признак удаления
3034 - }
3035 -]
3036 -
3037 -== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3038 -
3039 -(% class="box infomessage" %)
3040 -(((
3041 -**GET /api/v3/Drivers/{driverGuid}**
3042 -)))
3043 -
3044 -Передается параметр: ID водителя
3045 -
3046 -Ответ:
3047 -
3048 -{
3049 - "name": "string", ~/~/ Определяет наименование
3050 - "description": "string", ~/~/ Определяет описание
3051 - "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3052 - "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3053 - "exclusive": true, ~/~/ Определяет признак "Исключительный"
3054 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3055 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3056 - "deleted": true ~/~/ Признак удаления
3057 3057  }
3058 3058  
3059 -== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
417 +Ответ: {
3060 3060  
3061 -(% class="box successmessage" %)
3062 -(((
3063 -**POST /api/v3/Drivers**
3064 -)))
419 +{{{ "status": "", // значение статуса
420 + "date": "", // Дата смены статуса
421 + "description": "", // Описание
422 + "data": "", // Данные
423 + "overwrite": false, // Флаг перезаписи
424 + "stage": "", // Состояние}}}
3065 3065  
3066 -Запрос:
3067 -
3068 -{
3069 - "name": "string",
3070 - "description": "string",
3071 - "hiredate": "2023-06-30T12:50:54.020Z",
3072 - "chopdate": "2023-06-30T12:50:54.020Z",
3073 - "exclusive": true,
3074 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3075 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3076 - "deleted": true
3077 3077  }
3078 3078  
3079 -Ответ:
428 + **Проверка авторизации**
3080 3080  
3081 -{
3082 - "name": "string",
3083 - "description": "string",
3084 - "hiredate": "2023-06-30T12:50:54.051Z",
3085 - "chopdate": "2023-06-30T12:50:54.051Z",
3086 - "exclusive": true,
3087 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3088 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3089 - "deleted": true
3090 -}
430 +Метод позволяет проверить статус авторизации Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации «X-Auth»
3091 3091  
432 +Метод запроса: GET
3092 3092  
3093 -== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
434 +URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
3094 3094  
3095 -(% class="box warningmessage" %)
3096 -(((
3097 -**PUT /api/v3/Drivers**
3098 -)))
3099 -
3100 -Запрос:
3101 -
3102 -{
3103 - "name": "string",
3104 - "description": "string",
3105 - "hiredate": "2023-06-30T12:50:27.910Z",
3106 - "chopdate": "2023-06-30T12:50:27.910Z",
3107 - "exclusive": true,
3108 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3109 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3110 - "deleted": true
3111 -}
3112 -
3113 -Ответ:
3114 -
3115 -{
3116 - "name": "string",
3117 - "description": "string",
3118 - "hiredate": "2023-06-30T12:50:27.929Z",
3119 - "chopdate": "2023-06-30T12:50:27.929Z",
3120 - "exclusive": true,
3121 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3122 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3123 - "deleted": true
3124 -}
3125 -
3126 -
3127 -== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3128 -
3129 -(% class="box errormessage" %)
3130 -(((
3131 -**DELETE /api/v3/Drivers/{driverGuid}**
3132 -)))
3133 -
3134 -Передается параметр: ID водителя
3135 -
3136 -Ответ:
3137 -
3138 -Success
3139 -
3140 -
3141 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3142 -
3143 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3144 -
3145 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3146 -
3147 -(% class="box infomessage" %)
3148 -(((
3149 -**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3150 -)))
3151 -
3152 -Запрос:
3153 -
3154 -{
3155 - "Ids": [
3156 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3157 - ],
3158 - "BeginTime": "2023-06-30T12:49:04.365Z",
3159 - "EndTime": "2023-06-30T12:49:04.365Z"
3160 -}
3161 -
3162 -Ответ:
3163 -
3164 -[
3165 - {
3166 - "VehicleId": 0,
3167 - "CreateTime": "2023-06-30T09:52:31.240Z",
3168 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3169 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3170 - "BeginTime": "2023-06-30T09:52:31.240Z",
3171 - "EndTime": "2023-06-30T09:52:31.240Z"
3172 - }
3173 -]
3174 -
3175 -
3176 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3177 -
3178 -(% class="box infomessage" %)
3179 -(((
3180 -**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3181 -)))
3182 -
3183 -Запрос:
3184 -
3185 -{
3186 - "Ids": [
3187 - 0
3188 - ],
3189 - "BeginTime": "2023-06-30T12:48:39.419Z",
3190 - "EndTime": "2023-06-30T12:48:39.419Z"
3191 -}
3192 -
3193 -Ответ:
3194 -
3195 -[
3196 - {
3197 - "VehicleId": 0,
3198 - "CreateTime": "2023-06-30T09:54:01.631Z",
3199 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3200 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3201 - "BeginTime": "2023-06-30T09:54:01.631Z",
3202 - "EndTime": "2023-06-30T09:54:01.631Z"
3203 - }
3204 -]
3205 -
3206 -
3207 -=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3208 -
3209 -(% class="box successmessage" %)
3210 -(((
3211 -**POST /api/v3/DriversVehiclesAssignments**
3212 -)))
3213 -
3214 -Передается массив назначений
3215 -
3216 -Запрос:
3217 -
3218 -[
3219 - {
3220 - "VehicleId": 0, ~/~/ Идентификатор объекта
3221 - "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3222 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3223 - "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3224 - "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3225 - }
3226 -]
3227 -
3228 -Ответ:
3229 -
3230 -[
3231 - {
3232 - "VehicleId": 0,
3233 - "CreateTime": "2023-06-30T11:04:46.903Z",
3234 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3235 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3236 - "BeginTime": "2023-06-30T11:04:46.903Z",
3237 - "EndTime": "2023-06-30T11:04:46.903Z"
3238 - }
3239 -]
3240 -
3241 -
3242 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3243 -
3244 -(% class="box warningmessage" %)
3245 -(((
3246 -**PUT /api/v3/DriversVehiclesAssignments**
3247 -)))
3248 -
3249 -Запрос:
3250 -
3251 -[
3252 - {
3253 - "VehicleId": 0,
3254 - "CreateTime": "2023-06-30T11:14:08.117Z",
3255 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3256 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3257 - "BeginTime": "2023-06-30T11:14:08.117Z",
3258 - "EndTime": "2023-06-30T11:14:08.117Z"
3259 - }
3260 -]
3261 -
3262 -Ответ:
3263 -
3264 -[
3265 - {
3266 - "VehicleId": 0,
3267 - "CreateTime": "2023-06-30T11:14:53.349Z",
3268 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3269 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3270 - "BeginTime": "2023-06-30T11:14:53.349Z",
3271 - "EndTime": "2023-06-30T11:14:53.349Z"
3272 - }
3273 -]
3274 -
3275 -
3276 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3277 -
3278 -(% class="box errormessage" %)
3279 -(((
3280 -**DELETE /api/v3/DriversVehiclesAssignments**
3281 -)))
3282 -
3283 -Запрос:
3284 -
3285 -[
3286 - "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3287 -]
3288 -
3289 -Ответ:
3290 -
3291 -Success
3292 -
3293 -
3294 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3295 -
3296 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3297 -
3298 -(% class="box infomessage" %)
3299 -(((
3300 -**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3301 -)))
3302 -
3303 -Запрос:
3304 -
3305 -{
3306 - "Ids": [
3307 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3308 - ],
3309 - "BeginTime": "2023-06-30T12:47:12.162Z",
3310 - "EndTime": "2023-06-30T12:47:12.162Z"
3311 -}
3312 -
3313 -Ответ:
3314 -
3315 -[
3316 - {
3317 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3318 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3319 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3320 - "BeginTime": "2023-06-30T11:19:40.703Z",
3321 - "EndTime": "2023-06-30T11:19:40.703Z"
3322 - }
3323 -]
3324 -
3325 -
3326 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3327 -
3328 -(% class="box infomessage" %)
3329 -(((
3330 -**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3331 -)))
3332 -
3333 -Запрос:
3334 -
3335 -{
3336 - "Ids": [
3337 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3338 - ],
3339 - "BeginTime": "2023-06-30T12:47:12.162Z",
3340 - "EndTime": "2023-06-30T12:47:12.162Z"
3341 -}
3342 -
3343 -Ответ:
3344 -
3345 -[
3346 - {
3347 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3348 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3349 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3350 - "BeginTime": "2023-06-30T11:19:40.703Z",
3351 - "EndTime": "2023-06-30T11:19:40.703Z"
3352 - }
3353 -]
3354 -
3355 -
3356 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3357 -
3358 -(% class="box successmessage" %)
3359 -(((
3360 -**POST /api/v3/DriversRfidsAssignments**
3361 -)))
3362 -
3363 -Запрос:
3364 -
3365 -[
3366 - {
3367 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3368 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3369 - "BeginTime": "2023-06-30T11:27:08.635Z",
3370 - "EndTime": "2023-06-30T11:27:08.635Z"
3371 - }
3372 -]
3373 -
3374 -Ответ:
3375 -
3376 -[
3377 - {
3378 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3379 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3380 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3381 - "BeginTime": "2023-06-30T11:27:08.677Z",
3382 - "EndTime": "2023-06-30T11:27:08.677Z"
3383 - }
3384 -]
3385 -
3386 -
3387 -=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3388 -
3389 -(% class="box warningmessage" %)
3390 -(((
3391 -**PUT /api/v3/DriversRfidsAssignments**
3392 -)))
3393 -
3394 -Запрос:
3395 -
3396 -[
3397 - {
3398 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3399 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3400 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3401 - "BeginTime": "2023-06-30T11:28:43.330Z",
3402 - "EndTime": "2023-06-30T11:28:43.330Z"
3403 - }
3404 -]
3405 -
3406 -Ответ:
3407 -
3408 -[
3409 - {
3410 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3412 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 - "BeginTime": "2023-06-30T11:28:43.331Z",
3414 - "EndTime": "2023-06-30T11:28:43.331Z"
3415 - }
3416 -]
3417 -
3418 -
3419 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3420 -
3421 -(% class="box errormessage" %)
3422 -(((
3423 -**DELETE /api/v3/DriversRfidsAssignments**
3424 -)))
3425 -
3426 -Запрос:
3427 -
3428 -[
3429 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3430 -]
3431 -
3432 -Ответ:
3433 -
3434 -Success
3435 -
3436 -
3437 -== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3438 -
3439 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3440 -
3441 -(% class="box infomessage" %)
3442 -(((
3443 -**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3444 -)))
3445 -
3446 -Запрос:
3447 -
3448 -{
3449 - "Ids": [
3450 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3451 - ],
3452 - "BeginTime": "2023-06-30T12:45:10.852Z",
3453 - "EndTime": "2023-06-30T12:45:10.852Z"
3454 -}
3455 -
3456 -Ответ:
3457 -
3458 -[
3459 - {
3460 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3461 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3462 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3463 - "BeginTime": "2023-06-30T11:58:04.695Z",
3464 - "EndTime": "2023-06-30T11:58:04.695Z"
3465 - }
3466 -]
3467 -
3468 -
3469 -=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3470 -
3471 -(% class="box infomessage" %)
3472 -(((
3473 -**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3474 -)))
3475 -
3476 -Запрос:
3477 -
3478 -{
3479 - "Ids": [
3480 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3481 - ],
3482 - "BeginTime": "2023-06-30T12:45:10.852Z",
3483 - "EndTime": "2023-06-30T12:45:10.852Z"
3484 -}
3485 -
3486 -Ответ:
3487 -
3488 -[
3489 - {
3490 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3491 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3492 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3493 - "BeginTime": "2023-06-30T11:58:04.695Z",
3494 - "EndTime": "2023-06-30T11:58:04.695Z"
3495 - }
3496 -]
3497 -
3498 -
3499 -=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3500 -
3501 -(% class="box successmessage" %)
3502 -(((
3503 -**POST /api/v3/DriversFuelCardsAssignments**
3504 -)))
3505 -
3506 -Запрос:
3507 -
3508 -[
3509 - {
3510 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3511 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3512 - "BeginTime": "2023-06-30T12:09:53.175Z",
3513 - "EndTime": "2023-06-30T12:09:53.175Z"
3514 - }
3515 -]
3516 -
3517 -Ответ:
3518 -
3519 -[
3520 - {
3521 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3522 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3523 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3524 - "BeginTime": "2023-06-30T12:09:53.201Z",
3525 - "EndTime": "2023-06-30T12:09:53.201Z"
3526 - }
3527 -]
3528 -
3529 -
3530 -=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3531 -
3532 -(% class="box warningmessage" %)
3533 -(((
3534 -**PUT /api/v3/DriversFuelCardsAssignments**
3535 -)))
3536 -
3537 -Запрос:
3538 -
3539 -[
3540 - {
3541 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3542 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3543 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3544 - "BeginTime": "2023-06-30T12:09:53.201Z",
3545 - "EndTime": "2023-06-30T12:09:53.201Z"
3546 - }
3547 -]
3548 -
3549 -Ответ:
3550 -
3551 -[
3552 - {
3553 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3554 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3555 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3556 - "BeginTime": "2023-06-30T12:09:53.201Z",
3557 - "EndTime": "2023-06-30T12:09:53.201Z"
3558 - }
3559 -]
3560 -
3561 -
3562 -=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3563 -
3564 -(% class="box errormessage" %)
3565 -(((
3566 -**DELETE /api/v3/DriversFuelCardsAssignments**
3567 -)))
3568 -
3569 -Запрос:
3570 -
3571 -[
3572 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3573 -]
3574 -
3575 -Ответ:
3576 -
3577 -Success
3578 -
3579 -
3580 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3581 -
3582 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3583 -
3584 -(% class="box infomessage" %)
3585 -(((
3586 -**POST /api/v3/Trailers**
3587 -)))
3588 -
3589 -Пример запроса:
3590 -
3591 -{
3592 - "startDate": "2023-11-14T10:48:03.671Z",
3593 - "endDate": "2023-11-14T10:48:03.671Z",
3594 - "ids": [ 0 ],
3595 - "timezone": 0
3596 -}
3597 -
3598 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3599 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3600 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3601 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3602 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3603 -
3604 -Пример ответа:
3605 -
3606 -[
3607 - {
3608 - "SD": "2023-11-14T10:48:03.717Z",
3609 - "ED": "2023-11-14T10:48:03.717Z", 
3610 - "id": 0,
3611 - "SLat": 0,
3612 - "SLon": 0,
3613 - "ELat": 0,
3614 - "ELon": 0,
3615 - "mileage": 0
3616 - "Duration": 0
3617 - "Address": "string",
3618 - "Address2": "string",
3619 - "name": "string",
3620 - "rid": "string",
3621 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3622 - "trailer": {
3623 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3624 - "Number": "string",
3625 - "Description": "string",
3626 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3627 - "ExternalID": "string",
3628 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3629 - "CreateTime": "2023-11-14T10:48:03.717Z",
3630 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3631 - "IsDeleted": true
3632 - },
3633 - "filesCount": 0,
3634 - }
3635 -]
3636 -
3637 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3638 -|SD|Дата и время начала события
3639 -|ED|Дата и время окончания события
3640 -|id|ID объекта
3641 -|SLat|Широта начальной координаты
3642 -|SLon|Долгота начальной координаты
3643 -|ELat|Широта конечной координаты
3644 -|ELon|Долгота конечной координаты
3645 -|mileage|Пробег
3646 -|Duration|Продолжительность
3647 -|Address|Адрес начального местоположения
3648 -|Address2|Адрес конечного местоположения
3649 -|name|Имя радиометки
3650 -|rid|Номер радиометки
3651 -|rguid|ID радиометки
3652 -|trailer|Информация об агрегате
3653 -|ModelGuid|ID агрегата
3654 -|Number|Название/номер агрегата
3655 -|Description|Текст примечания агрегата
3656 -
3657 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3658 -
3659 -== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3660 -
3661 -(% class="box infomessage" %)
3662 -(((
3663 -**POST /api/v3/Rfids/find**
3664 -)))
3665 -
3666 -Запрос:
3667 -
3668 -{
3669 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3670 -}
3671 -
3672 -Ответ:
3673 -
3674 -[
3675 - {
3676 - "name": "string",
3677 - "number": 0,
3678 - "period": 0,
3679 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3680 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681 - }
3682 -]
3683 -
3684 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3685 -|parentId|ID клиента
3686 -|name|Название карты-метки
3687 -|number|Номер
3688 -|period|Период запросов в секундах (работает только для агрегатов)
3689 -|id|ID карты-метки
3690 -
3691 -== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3692 -
3693 -(% class="box infomessage" %)
3694 -(((
3695 -**GET /api/v3/Rfids/{rfidGuid}**
3696 -)))
3697 -
3698 -Передаем параметр rfidGuid - идентификатор карты-метки
3699 -
3700 -Ответ:
3701 -
3702 -[
3703 - {
3704 - "name": "string",
3705 - "number": 0,
3706 - "period": 0,
3707 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3708 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3709 - }
3710 -]
3711 -
3712 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3713 -|name|Название карты-метки
3714 -|number|Номер
3715 -|period|Период запросов в секундах (работает только для агрегатов)
3716 -|id|ID карты-метки
3717 -|parentId|ID клиента
3718 -
3719 -== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3720 -
3721 -(% class="box successmessage" %)
3722 -(((
3723 -**POST /api/v3/Rfids**
3724 -)))
3725 -
3726 -Запрос:
3727 -
3728 -{
3729 - "name": "string",
3730 - "number": 0,
3731 - "period": 0,
3732 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3733 -}
3734 -
3735 -Ответ:
3736 -
3737 -{
3738 - "name": "string",
3739 - "number": 0,
3740 - "period": 0,
3741 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3742 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3743 -}
3744 -
3745 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3746 -|name|Название карты-метки
3747 -|number|Номер
3748 -|period|Период запросов в секундах (работает только для агрегатов)
3749 -|id|ID карты-метки
3750 -|parentId|ID клиента
3751 -
3752 -== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3753 -
3754 -(% class="box warningmessage" %)
3755 -(((
3756 -**PUT /api/v3/Rfids**
3757 -)))
3758 -
3759 -Запрос:
3760 -
3761 -{
3762 - "name": "string",
3763 - "number": 0,
3764 - "period": 0,
3765 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3766 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3767 -}
3768 -
3769 -Ответ:
3770 -
3771 -{
3772 - "name": "string",
3773 - "number": 0,
3774 - "period": 0,
3775 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3776 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3777 -}
3778 -
3779 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3780 -|name|Название карты-метки
3781 -|number|Номер
3782 -|period|Период запросов в секундах (работает только для агрегатов)
3783 -|id|ID карты-метки
3784 -|parentId|ID клиента
3785 -
3786 -== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3787 -
3788 -(% class="box errormessage" %)
3789 -(((
3790 -**DELETE /api/v3/Rfids/{rfidGuid}**
3791 -)))
3792 -
3793 -Передаем параметр **rfidGuid** - идентификатор карты-метки
3794 -
3795 -Ответ:
3796 -
3797 -Success
3798 -
3799 -
3800 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3801 -
3802 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3803 -
3804 -(% class="box infomessage" %)
3805 -(((
3806 -**GET /api/v3/Billing/client/balance/{clientId}**
3807 -)))
3808 -
3809 -Параметр запроса: **clientId **- идентификатор клиента.
3810 -
3811 -Ответ:
3812 -
3813 -{
3814 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3815 - "Balance": 0
3816 -}
3817 -
3818 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3819 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3820 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3821 -
3822 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3823 -
3824 -(% class="box infomessage" %)
3825 -(((
3826 -**GET /api/v3/Billing/client/constraint/{clientId}**
3827 -)))
3828 -
3829 -Параметр запроса: **clientId **- идентификатор клиента.
3830 -
3831 -Ответ:
3832 -
3833 -{
3834 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3835 - "CalculationType": 0,
3836 - "PermissibleBalance": 0,
3837 - "DefermentDays": 0,
3838 - "SendUiNotifications": true,
3839 - "SendEmailNotifications": true,
3840 - "IsPrivate": true,
3841 -}
3842 -
3843 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3844 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3845 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3846 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3847 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3848 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3849 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3850 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3851 -
3852 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3853 -
3854 -(% class="box infomessage" %)
3855 -(((
3856 -**GET /api/v3/Billing/client/plan/{clientId}**
3857 -)))
3858 -
3859 -Параметры запроса:
3860 -
3861 -**clientId **- идентификатор клиента.
3862 -
3863 -**planId **- идентификатор тарифного плана.
3864 -
3865 -Ответ:
3866 -
3867 -{
3868 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3869 - "Plan": { **~/~/ Описание тарифного плана**
3870 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3871 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3872 - "Name": "string",
3873 - "IsArchived": true,
3874 - "Constraint": {
3875 - "CalculationType": 0,
3876 - "PermissibleBalance": 0,
3877 - "DefermentDays": 0
3878 - },
3879 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3880 - {
3881 - "Feature": "string",
3882 - "IsFactual": true,
3883 - "Limit": 0,
3884 - "Price": 0,
3885 - "PeriodValue": 0,
3886 - "PeriodType": 0
3887 - }
3888 - ]
3889 - },
3890 - "DebitDate": "2023-10-18T12:46:24.213Z",
3891 - "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3892 - {
3893 - "Feature": "string",
3894 - "IsEnabled": true,
3895 - "IsPrivate": true,
3896 - "IsFactual": true,
3897 - "Limit": 0,
3898 - "Price": 0,
3899 - "DebitDate": "2023-10-18T12:46:24.213Z",
3900 - "PeriodValue": 0,
3901 - "PeriodType": 0
3902 - }
3903 - ]
3904 -}
3905 -
3906 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3907 -|ClientId|Идентификатор клиента
3908 -|Id|Идентификатор тарифного плана
3909 -|OwnerId|Идентификатор клиента-владельца
3910 -|Name|Наименование тарифного плана
3911 -|IsArchived|Признак, определяющий архивный тарифный план
3912 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3913 -|PermissibleBalance|Допустимый баланс
3914 -|DefermentDays|Отсрочка, количество дней
3915 -|Feature|Код услуги
3916 -|IsEnabled|Признак, определяющий активирована ли услуга
3917 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3918 -|IsFactual|Признак, определяющий расчёт по факту
3919 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3920 -|Price|Цена за единицу.
3921 -|DebitDate|Следующий момент времени списания с баланса за услугу.
3922 -|PeriodValue|Значение периода.
3923 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3924 -
3925 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3926 -
3927 -(% class="box infomessage" %)
3928 -(((
3929 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3930 -)))
3931 -
3932 -Параметр запроса: **clientId **- идентификатор клиента.
3933 -
3934 -Ответ:
3935 -
3936 -[
3937 - {
3938 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3939 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3940 - "Name": "string",
3941 - "IsArchived": true,
3942 - "Constraint": {
3943 - "CalculationType": 0,
3944 - "PermissibleBalance": 0,
3945 - "DefermentDays": 0
3946 - },
3947 - "Features": [
3948 - {
3949 - "Feature": "string",
3950 - "IsFactual": true,
3951 - "Limit": 0,
3952 - "Price": 0,
3953 - "PeriodValue": 0,
3954 - "PeriodType": 0
3955 - }
3956 - ]
3957 - }
3958 -]
3959 -
3960 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3961 -|ClientId|Идентификатор клиента
3962 -|Id|Идентификатор тарифного плана
3963 -|OwnerId|Идентификатор клиента-владельца
3964 -|Name|Наименование тарифного плана
3965 -|IsArchived|Признак, определяющий архивный тарифный план
3966 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3967 -|PermissibleBalance|Допустимый баланс
3968 -|DefermentDays|Отсрочка, количество дней
3969 -|Feature|Код услуги
3970 -|IsFactual|Признак, определяющий расчёт по факту
3971 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3972 -|Price|Цена за единицу.
3973 -|PeriodValue|Значение периода.
3974 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3975 -
3976 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3977 -
3978 -(% class="box infomessage" %)
3979 -(((
3980 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3981 -)))
3982 -
3983 -Параметр запроса: **clientId **- идентификатор клиента.
3984 -
3985 -Ответ:
3986 -
3987 -[
3988 - {
3989 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3990 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3991 - "Name": "string",
3992 - "IsArchived": true,
3993 - "Constraint": {
3994 - "CalculationType": 0,
3995 - "PermissibleBalance": 0,
3996 - "DefermentDays": 0
3997 - },
3998 - "Features": [
3999 - {
4000 - "Feature": "string",
4001 - "IsFactual": true,
4002 - "Limit": 0,
4003 - "Price": 0,
4004 - "PeriodValue": 0,
4005 - "PeriodType": 0
4006 - }
4007 - ]
4008 - }
4009 -]
4010 -
4011 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4012 -|ClientId|Идентификатор клиента
4013 -|Id|Идентификатор тарифного плана
4014 -|OwnerId|Идентификатор клиента-владельца
4015 -|Name|Наименование тарифного плана
4016 -|IsArchived|Признак, определяющий архивный тарифный план
4017 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4018 -|PermissibleBalance|Допустимый баланс
4019 -|DefermentDays|Отсрочка, количество дней
4020 -|Feature|Код услуги
4021 -|IsFactual|Признак, определяющий расчёт по факту
4022 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4023 -|Price|Цена за единицу.
4024 -|PeriodValue|Значение периода.
4025 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4026 -
4027 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4028 -
4029 -(% class="box warningmessage" %)
4030 -(((
4031 -**PUT /api/v3/Billing/client/balance**
4032 -)))
4033 -
4034 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4035 -
4036 -Тело запроса:
4037 -
4038 -{
4039 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4040 - "Balance": 0
4041 -}
4042 -
4043 -Ответ: Success
4044 -
4045 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4046 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4047 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4048 -
4049 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4050 -
4051 -(% class="box warningmessage" %)
4052 -(((
4053 -**PUT /api/v3/billing/client/balance/deposit**
4054 -)))
4055 -
4056 -Создает операцию **Пополнение **с указанной суммой
4057 -
4058 -Тело запроса:
4059 -
4060 -{
4061 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4062 - "Balance": 0
4063 -}
4064 -
4065 -Ответ: Success
4066 -
4067 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4068 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4069 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4070 -
4071 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4072 -
4073 -Создает операцию **Списание **с указанной суммой
4074 -
4075 -(% class="box warningmessage" %)
4076 -(((
4077 -**PUT /api/v3/billing/client/balance/withdraw**
4078 -)))
4079 -
4080 -Тело запроса:
4081 -
4082 -{
4083 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4084 - "Balance": 0
4085 -}
4086 -
4087 -Ответ: Success
4088 -
4089 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4090 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4091 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4092 -
4093 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4094 -
4095 -(% class="box warningmessage" %)
4096 -(((
4097 -**PUT /api/v3/Billing/client/constraint**
4098 -)))
4099 -
4100 -Тело запроса:
4101 -
4102 -{
4103 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4104 - "CalculationType": 0,
4105 - "PermissibleBalance": 0,
4106 - "DefermentDays": 0,
4107 - "SendUiNotifications": true,
4108 - "SendEmailNotifications": true,
4109 - "IsPrivate": true,
4110 -}
4111 -
4112 -Ответ: Success
4113 -
4114 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4115 -|ClientId|Идентификатор клиента
4116 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4117 -|PermissibleBalance|Допустимый баланс
4118 -|DefermentDays|(((
4119 -Отсрочка, количество дней
4120 -)))
4121 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4122 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4123 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4124 -
4125 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4126 -
4127 -(% class="box warningmessage" %)
4128 -(((
4129 -**PUT /api/v3/Billing/client/plan**
4130 -)))
4131 -
4132 -Тело запроса:
4133 -
4134 -{
4135 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4136 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4137 - "Features": [
4138 - {
4139 - "Feature": "string",
4140 - "IsEnabled": true,
4141 - "IsFactual": true,
4142 - "Limit": 0,
4143 - "Price": 0,
4144 - "DebitDate": "2023-10-18T13:26:58.987Z",
4145 - "PeriodValue": 0,
4146 - "PeriodType": 0
4147 - }
4148 - ]
4149 -}
4150 -
4151 -Ответ: Success
4152 -
4153 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4154 -|ClientId|Идентификатор клиента
4155 -|PlanId|Идентификатор тарифного плана
4156 -|Feature|Код услуги
4157 -|IsEnabled|Признак, определяющий активирована ли услуга
4158 -|IsFactual|Признак, определяющий расчёт по факту
4159 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4160 -|Price|Цена за единицу.
4161 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4162 -|PeriodValue|Значение периода.
4163 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4164 -
4165 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4166 -
4167 -(% class="box warningmessage" %)
4168 -(((
4169 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4170 -)))
4171 -
4172 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4173 -
4174 -(% class="box infomessage" %)
4175 -(((
4176 -**POST /api/v3/vehicles/import/{agentId}**
4177 -)))
4178 -
4179 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4180 -
4181 -В пути указывается **agentId** - id клиента.
4182 -
4183 -**Заголовок**
4184 -
4185 -**X-Auth: [токен авторизации]**
4186 -
4187 -**Параметры**
4188 -
4189 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4190 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4191 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4192 -
4193 -В теле использовать тип **form-data,** тип значения** file**
4194 -
4195 -**Ключи**
4196 -
4197 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4198 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
4199 -|csv|В значении передаем файл датчиков, формат **csv**
4200 -
4201 -Ответ:
4202 -
4203 -{
4204 - "vehicleId": 0,
4205 - "name": "string",
4206 - "errors": ["string"]
4207 -}
4208 -
4209 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4210 -|vehicleId|ID созданного объекта
4211 -|name|Имя созданного объекта
4212 -|errors|Ошибки и их описание
4213 -
4214 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4215 -
4216 -(% class="box infomessage" %)
4217 -(((
4218 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4219 -)))
4220 -
4221 -(% class="wikigeneratedid" %)
4222 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4223 -
4224 -(% class="wikigeneratedid" %)
4225 -В пути указывается **vehicleId **- id объекта.
4226 -
4227 -**Заголовок**
4228 -
4229 -**X-Auth: [токен авторизации]**
4230 -
4231 -В теле использовать тип **form-data.**
4232 -
4233 -Ключи:
4234 -
4235 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4236 -|**history**|В значении передавать файл с историей
4237 -
4238 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4239 -
4240 -Ответ:
4241 -
4242 -{
4243 - "results": [
4244 - {
4245 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4246 - "vehicleId": 0,
4247 - "errors": [
4248 - "string"
4249 - ],
4250 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
4251 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
4252 - "producedCount": 0,
4253 - "msgCount": 0
4254 - }
4255 - ]
4256 -}
4257 -
4258 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4259 -|results|Результаты импорта в разрезе ТС
4260 -|vehicleGuid|Guid ТС
4261 -|vehicleId|ID ТС
4262 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4263 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
4264 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4265 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
4266 -|msgCount|Кол-во обработанных сообщений всего
4267 -
4268 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4269 -
4270 -(% class="box infomessage" %)
4271 -(((
4272 -**GET /api/v3/vehicles/import/history/status**
4273 -)))
4274 -
4275 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4276 -
4277 -Ответ:
4278 -
4279 -{
4280 - "activity": true,
4281 - "progress": 0,
4282 - "message": "string"
4283 -}
4284 -
4285 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4286 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4287 -|progress|Guid ТС
4288 -
4289 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4290 -
4291 -(% class="box infomessage" %)
4292 -(((
4293 -**POST /api/v3/vehicles/export**
4294 -)))
4295 -
4296 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4297 -
4298 -Тело запроса:
4299 -
4300 -[
4301 - id
4302 -]
4303 -
4304 -Ответ: Success 200, получаете файлы с настройками.
4305 -
4306 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4307 -
4308 -(% class="box infomessage" %)
4309 -(((
4310 -**POST /api/v3/vehicles/export/history**
4311 -)))
4312 -
4313 -Метод возвращает список сообщений терминала объекта за выбранный период.
4314 -
4315 -Тело запроса:
4316 -
4317 -{
4318 - "vehicleId": 0,
4319 - "asArchive": true,
4320 - "from": "2023-09-27T12:17:45.973Z",
4321 - "to": "2023-09-27T12:17:45.973Z"
4322 -}
4323 -
4324 -Ответ:
4325 -
4326 -Получаете файл. Сообщение: Code 200/Success
4327 -
4328 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4329 -|vehicleId|ID объекта
4330 -|asArchive|true - Архивировать файл, False - не архивировать
4331 -|from|Дата и время начала запроса
4332 -|to|Дата и время окончания запроса
4333 -
4334 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4335 -
4336 -(% class="box infomessage" %)
4337 -(((
4338 -**GET /api/v3/vehicles/export/history/status**
4339 -)))
4340 -
4341 -Метод возвращает список сообщений терминала объекта за выбранный период.
4342 -
4343 -Ответ:
4344 -
4345 -{
4346 - "activity": true,
4347 - "progress": 0,
4348 - "message": "string"
4349 -}
4350 -
4351 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4352 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4353 -|progress|Прогресс экспорта, от 0 до 100%
4354 -|message|Текст описывающий статус
4355 -
4356 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4357 -
4358 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4359 -
4360 -(% class="box infomessage" %)
4361 -(((
4362 -**POST /api/v3/EcoDriving/rating**
4363 -)))
4364 -
4365 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4366 -
4367 -Тело запроса:
4368 -
4369 -{
4370 - "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4371 - "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4372 - "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4373 -}
4374 -
4375 -Ответ:
4376 -
4377 -{
4378 - "items": [  ~/~/ Список в разрезе ТС
4379 - {
4380 - "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4381 - "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4382 - "vehicleId": 0, ~/~/ ID ТС
4383 - "vehicleName": "string", ~/~/ Название ТС
4384 - "vehicleModel": "string", ~/~/ Модель ТС
4385 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4386 - "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4387 - "totalViolations": 0, ~/~/ Нарушений всего
4388 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4389 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4390 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4391 - "brakingViolations": 0, ~/~/ Нарушений торможения
4392 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4393 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4394 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4395 - },
4396 -
4397 -(((
4398 -
4399 -)))
4400 -
4401 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4402 - "mileage": 0, ~/~/ Пробег, м
4403 - "tripsCount": 0, ~/~/ Кол-во рейсов
4404 - "trips": [  ~/~/ Информация по рейсу
4405 - {
4406 - "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4407 - "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4408 - "violationsCount": 0, ~/~/ Всего нарушений
4409 - "violationsByType": { ~/~/ Информация о нарушениях по типу
4410 - "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4411 - "accelerationViolations": 0, ~/~/ Нарушений ускорения
4412 - "brakingViolations": 0, ~/~/ Нарушений торможения
4413 - "turningViolations": 0, ~/~/ Нарушений опасного поворота
4414 - "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4415 - "sensorViolations": 0 ~/~/ Нарушений по датчику
4416 - },
4417 -
4418 - "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4419 - "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4420 - "moveTime": 0, ~/~/ Продолжительность движения, сек
4421 - "mileage": 0, ~/~/ Пробег, м
4422 - "motohours": 0, ~/~/ Моточасы, секунды
4423 - "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4424 - "startAddress": "string", ~/~/ Адрес начала рейса
4425 - "endAddress": "string", ~/~/ Адрес конца рейса
4426 - "drivers": [  ~/~/ Список водителей
4427 - {
4428 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4429 - "driverName": "string", ~/~/ФИО водителя
4430 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4431 - }
4432 - ]
4433 - }
4434 - ]
4435 - }
4436 - ]
4437 -}
4438 -
4439 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4440 -
4441 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4442 -
4443 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4444 -
4445 -(% class="box infomessage" %)
4446 -(((
4447 -POST /api/v3/fuelcards/transactions
4448 -)))
4449 -
4450 -Метод запроса: POST
4451 -
4452 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4453 -\\В заголовках запроса: X-Auth: Токен авторизации
4454 -
4455 -Параметры в теле запроса (JSON):
4456 -
4457 -{
4458 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4459 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4460 - "ids": [ 
4461 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4462 - ],
4463 - "timezone": 0 ~/~/ Часовой пояс
4464 -}
4465 -
4466 -
4467 -Ответ:
4468 - {
4469 - "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4470 - "driver": "string", ~/~/ Водители, привязанные к ТК
4471 - "object": "string", ~/~/ Наименование ТС
4472 - "amount": 0, ~/~/ Количество топлива
4473 - "amountDut": 0, ~/~/ Количество по ДУТ
4474 - "amountDiff": 0, ~/~/ Разница, л
4475 - "amountDiffPerc": 0, ~/~/ Разница, %
4476 - "summa": 0, ~/~/ Стоимость, руб
4477 - "serviceName": "string", ~/~/ Тип топлива
4478 - "price": 0, ~/~/ Цена за литр, руб
4479 - "cardName": "string", ~/~/ Наименование ТК
4480 - "cardNum": "string", ~/~/ Номер ТК
4481 - "operator": "string", ~/~/ Оператор ТК
4482 - "address": "string" ~/~/ Адрес АЗС
4483 - }
4484 -
4485 -
4486 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4487 -
4488 -
4489 -== **Получение полных данных о ретрансляторе** ==
4490 -
4491 -(% class="box infomessage" %)
4492 -(((
4493 -**GET ** **/api/v3/retranslations/{id}**
4494 -)))
4495 -
4496 -id - Идентификатор ретранслятора
4497 -
4498 -
4499 -Пример ответа:
4500 -
4501 -{  
4502 -"description": "", ~/~/ Поле описания ретранслятора
4503 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4504 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4505 -"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4506 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4507 -"objects": [ ~/~/ Объекты для ретрансляции
4508 -{      
4509 -"id": "",  ~/~/ Идентификатор объекта ретрансляции
4510 -"name": "", ~/~/ Наименование объекта ретрансляции
4511 -"imei": "", ~/~/ IMEI объекта  ретрансляции
4512 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4513 -}
4514 - ],  
4515 -"id": "", ~/~/ Идентификатор ретранслятора 
4516 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4517 -"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4518 -}
4519 -
4520 -
4521 -== **Удаление данных ретранслятора** ==
4522 -
4523 -(% class="box infomessage" %)
4524 -(((
4525 -**DELETE** **/api/v3/retranslations/{id}**
4526 -)))
4527 -
4528 -id - Идентификатор ретранслятора
4529 -
4530 -
4531 -== **Создание ретранслятора** ==
4532 -
4533 -(% class="box infomessage" %)
4534 -(((
4535 -**POST ** **/api/v3/retranslations/{id}**
4536 -)))
4537 -
4538 -Запрос:
4539 -
4540 -{  
4541 -"description": "", ~/~/ Поле описания ретранслятора
4542 -"subscriberId": "", ~/~/ Идентификатор подписчика
4543 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4544 -"address": "", ~/~/ Адрес и порт принимающего сервера
4545 -"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4546 -"objects": [ ~/~/Объекты для ретрансляции
4547 -{      
4548 -"id": "", ~/~/ Идентификатор ретранслятора 
4549 -"imei": "", ~/~/ IMEI объекта ретрансляции
4550 -"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4551 -}
4552 - ]
4553 -}
4554 -
4555 -
4556 -Ответ:
4557 -
4558 -{  
4559 -"description": "", ~/~/ Поле описания ретранслятора
4560 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4561 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4562 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4563 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4564 -"objects": [ ~/~/ Объекты для ретрансляции
4565 -{      
4566 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4567 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4568 -"imei": "", ~/~/ IMEI объекта ретрансляции
4569 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4570 -}
4571 - ],
4572 -"id": "", ~/~/ Идентификатор ретранслятора   
4573 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4574 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4575 -}
4576 -
4577 -
4578 -== **Редактирование ретранслятора** ==
4579 -
4580 -(% class="box infomessage" %)
4581 -(((
4582 -**PUT** **/api/v3/retranslations**
4583 -)))
4584 -
4585 -Пример запроса:
4586 -
4587 -{  
4588 -"id": "", ~/~/ Идентификатор ретранслятора   
4589 -"description": "string", ~/~/ Поле описания ретранслятора
4590 -"subscriberId": "", ~/~/ Идентификатор подписчика
4591 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4592 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4593 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4594 -"objects": ~/~/ Объекты для ретрансляции
4595 -[    
4596 -{      
4597 -"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4598 -"imei": "", ~/~/ IMEI объекта ретрансляции
4599 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4600 -}
4601 - ]
4602 -}
4603 -
4604 -
4605 -Пример ответа:
4606 -
4607 -{  
4608 -"description": "", ~/~/ Поле описания ретранслятора
4609 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4610 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4611 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4612 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4613 -"objects": [ ~/~/ Объекты для ретрансляции
4614 -{      
4615 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4616 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4617 -"imei": "", ~/~/ IMEI объекта ретрансляции
4618 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4619 -}
4620 - ],
4621 -"id": "", ~/~/ Идентификатор ретранслятора   
4622 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4623 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4624 -}
4625 -
4626 -
4627 -== **Получение списка ретранслятора клиента** ==
4628 -
4629 -(% class="box infomessage" %)
4630 -(((
4631 -**POST /api/v3/retranslations/find**
4632 -)))
4633 -
4634 -Пример запроса:
4635 -
4636 -{  
4637 -"id": "", ~/~/ Идентификатор ретранслятора   
4638 -"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4639 -"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4640 -}
4641 -
4642 -Ответ:
4643 -
4644 -[ 
4645 -{    
4646 -"description": "", ~/~/ Поле описания ретранслятора
4647 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4648 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4649 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4650 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4651 -"id": "", ~/~/ Идентификатор ретранслятора   
4652 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4653 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4654 -}
4655 -]
4656 -
4657 -
4658 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4659 -
4660 -== **API для отчета по выгрузке комбайнов** ==
4661 -
4662 -(% class="box infomessage" %)
4663 -(((
4664 -**POST /api/v3/Reports/harvesterUnloading**
4665 -)))
4666 -
4667 -Пример запроса:
4668 -
4669 -{
4670 - "byTime": 0, ~/~/ Объединение событий по времени
4671 - "byDist": 0, ~/~/ Объединение событий по расстоянию
4672 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4673 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4674 - "showNearestObjects": true, ~/~/Показывать объекты рядом?
4675 - "vehicleIds": [ ~/~/ Список id объектов для анализа
4676 - 0
4677 - ],
4678 - "from": "", ~/~/ Дата и время начало запроса
4679 - "to": "", ~/~/ Дата и время окончания запроса
4680 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4681 -}
4682 -
4683 -Пример ответа:
4684 -
4685 -[ 
4686 - {
4687 - "harvesterName": "", ~/~/Комбайн, номер
4688 - "harvesterId": 0, ~/~/Комбайн, id
4689 -"harvesterModel": "", ~/~/ Модель комбайна
4690 -"hopperCapacity": 0, ~/~/ Объем бункера м3
4691 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4692 - "events": [ ~/~/Список событий в разрезе комбайна
4693 - {
4694 - "driverId": "", ~/~/Идентификатор водителя
4695 - "driverName": "", ~/~/Водитель комбайна, ФИО
4696 - "RFID": "", ~/~/ идентификатор карты-метки
4697 - "rfidName": "", ~/~/Водитель комбайна, имя метки
4698 - "vehicleId": 0, ~/~/идентификатор объекта
4699 - "vehicleName": "string", ~/~/ Имя объекта
4700 - "modelName": "string", ~/~/ Имя модели объекта
4701 - "nearestVehicles": [ ~/~/Объекты рядом
4702 - {
4703 - "vehicleId": 0, ~/~/идентификатор объекта
4704 - "vehicleName": "string" ~/~/ Имя объекта
4705 - }
4706 - ],
4707 - "fields": [ ~/~/Поля, где происходила выгрузка
4708 - {
4709 - "id": 0, ~/~/ идентификатор пользователя 
4710 - "name": "string" ~/~/ имя пользователя 
4711 - }
4712 - ],
4713 - "event": "string", ~/~/Событие
4714 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4715 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4716 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4717 - "cultureName": "string", ~/~/ название культуры
4718 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4719 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4720 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4721 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4722 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4723 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4724 - "issued": 0, ~/~/Выдано, бункеров
4725 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4726 - "latitude": 0, ~/~/Широта
4727 - "longitude": 0, ~/~/ Долгота
4728 - "litresAway": 0, ~/~/Отдано, л
4729 - "m3Away": 0 ~/~/Отдано, м3
4730 - }
4731 - ]
4732 - }
4733 -]
4734 -
4735 -
4736 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4737 -
4738 -
4739 -== **Запрос списка полей** ==
4740 -
4741 -(% class="box successmessage" %)
4742 -(((
4743 -**POST /api/v3/agroLands/find**
4744 -)))
4745 -
4746 -Пример запроса:
4747 -
4748 -(((
4749 -(((
4750 -(((
4751 -{
4752 - "year": 0, ~/~/ Фильтр по году
4753 - "name": "string", ~/~/ Фильтр по названию
4754 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4755 -}
4756 -)))
4757 -)))
4758 -
4759 -
4760 -)))
4761 -
4762 -Пример ответа:
4763 -
4764 -(((
4765 -[
4766 - {
4767 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4768 - "year": 0, ~/~/ Год поля
4769 - "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4770 - "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4771 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4772 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4773 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4774 - "counts": { ~/~/ Счётчики с/х поля 
4775 - "fieldOperations": 0, ~/~/ Количество операций на поле
4776 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4777 - "facts": 0 ~/~/ Счётчик факта
4778 - },
4779 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4780 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4781 - "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4782 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4783 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4784 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4785 - "planComment": "string", ~/~/ Комментарий к полю
4786 - "productivity": 0, ~/~/ Урожайность.
4787 - "id": 0, ~/~/ Идентификатор объекта геозоны
4788 - "name": "string", ~/~/ Название объекта геозоны
4789 - "type": 0, ~/~/ Тип объекта геозоны
4790 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4791 - "fname": "string", ~/~/ Имя файла
4792 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4793 - "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4794 - "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4795 - "description": "string", ~/~/ Описание объекта геозоны
4796 - "area": 0, ~/~/ Площадь, м2
4797 - "perimetr": 0, ~/~/ Периметр, м
4798 - "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4799 - }
4800 -]
4801 -
4802 -
4803 -== **Создание нового поля ** ==
4804 -
4805 -(% class="box successmessage" %)
4806 -(((
4807 -**POST /api/v3/agroLands**
4808 -)))
4809 -
4810 -Пример запроса:
4811 -
4812 -(((
4813 -{
4814 - "extId": "string", 
4815 - "shape": "string", ~/~/ Форма поля
4816 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
4817 - "display": "string", ~/~/ Настройки отображения
4818 - "year": 0, ~/~/ Год поля
4819 - "name": "string", ~/~/ Наименование
4820 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4821 - "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4822 - "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4823 - "planComment": "string", ~/~/ Комментарий к полю
4824 - "cropRotations": [ ~/~/ Данные по севообороту
4825 - {
4826 - "landId": 0, ~/~/ ID поля
4827 - "landName": "string", ~/~/ Название поля
4828 - "year": 0, ~/~/ Год урожая
4829 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4830 - "cultureName": "string", ~/~/ Название культуры
4831 - "productivity": 0, ~/~/ Урожайность
4832 - "area": 0, ~/~/ Площадь поля, Га
4833 - "total": 0, ~/~/ Валовый сбор
4834 - "productivityFact": 0, ~/~/ Фактическая урожайность
4835 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4836 - "totalFact": 0, ~/~/ Фактический валовый сбор
4837 - "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4838 - "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4839 - "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4840 - "isyearplan": true, ~/~/ Годовой план 
4841 - "comment": "string" ~/~/ Комментарий
4842 - }
4843 - ]
4844 -}
4845 -)))
4846 -
4847 -(((
4848 -
4849 -)))
4850 -
4851 -Пример ответа:
4852 -
4853 -(((
4854 -(((
4855 -{
4856 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4857 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4858 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4859 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4860 - "cropRotations": [ ~/~/ Данные по севообороту
4861 - {
4862 - "landId": 0, ~/~/ ID поля
4863 - "landName": "string", ~/~/ Название поля
4864 - "year": 0, ~/~/ Год урожая 
4865 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4866 - "cultureName": "string", ~/~/ Название культуры
4867 - "productivity": 0, ~/~/ Урожайность
4868 - "area": 0, ~/~/ Площадь поля, Га.
4869 - "total": 0, ~/~/ Валовый сбор
4870 - "productivityFact": 0, ~/~/ Фактическая урожайность
4871 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4872 - "totalFact": 0, ~/~/ Фактический валовый сбор
4873 - "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4874 - "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4875 - "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4876 - "isyearplan": true, ~/~/ годовой план 
4877 - "comment": "string" ~/~/ Комментарий
4878 - }
4879 - ],
4880 - "cropVegetation": [ ~/~/ История вегетации поля
4881 - {
4882 - "values": [  ~/~/ Данные вегетации и состояния посева
4883 - {
4884 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4885 - "ndvi": 0 ~/~/ Индекс вегетации
4886 - }
4887 - ],
4888 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4889 - {
4890 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4891 - "type": "string", ~/~/ Тип
4892 - "pictureid": "string" ~/~/ Идентификатор ресурса
4893 - }
4894 - ],
4895 - "states": [ ~/~/ Ключевые даты развития поля
4896 - {
4897 - "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4898 - "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4899 - }
4900 - ]
4901 - }
4902 - ],
4903 - "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4904 - "counts": {
4905 - "fieldOperations": 0, ~/~/ Количество операций на поле
4906 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4907 - "facts": 0 ~/~/ Счётчик факта
4908 - },
4909 - "planComment": "string", ~/~/ Комментарий к полю
4910 -)))
4911 -
4912 -(((
4913 - "productivity": 0, ~/~/ Урожайность.
4914 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4915 - "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
4916 - "year": 0, ~/~/ Год поля
4917 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4918 - "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4919 - "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4920 - "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4921 - "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
4922 - "id": 0, ~/~/ Идентификатор объекта геозоны
4923 - "name": "string", ~/~/ Название объекта геозоны
4924 - "type": 0, ~/~/ Тип объекта геозоны
4925 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4926 - "fname": "string", ~/~/ Имя файла
4927 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4928 - "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
4929 - "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
4930 - "description": "string", ~/~/ Описание объекта геозоны
4931 - "area": 0, ~/~/ Площадь, м2
4932 - "perimetr": 0, ~/~/ Периметр, м
4933 - "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
4934 -}
4935 -
4936 -
4937 -)))
4938 -)))
4939 -)))
4940 -
4941 -== **Получение поля по id** ==
4942 -
4943 -(% class="box infomessage" %)
4944 -(((
4945 -**GET /api/v3/agroLands/{id}**
4946 -)))
4947 -
4948 -Пример запроса:
4949 -id  ~/~/ Идентификатор поля
4950 -
4951 -Пример ответа:
4952 -
4953 -(((
4954 -{
4955 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4956 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4957 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4958 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4959 - "cropRotations": [ ~/~/ Данные по севообороту
4960 - {
4961 - "landId": 0, ~/~/ ID поля
4962 - "landName": "string", ~/~/ Название поля
4963 - "year": 0, ~/~/ Год урожая
4964 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4965 - "cultureName": "string", ~/~/ Название культуры
4966 - "productivity": 0, ~/~/ Урожайность
4967 - "area": 0, ~/~/ Площадь поля, Га
4968 - "total": 0, ~/~/ Валовый сбор
4969 - "productivityFact": 0, ~/~/ Фактическая урожайность
4970 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4971 - "totalFact": 0, ~/~/ Фактический валовый сбор
4972 - "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
4973 - "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
4974 - "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
4975 - "isyearplan": true, ~/~/ План года 
4976 - "comment": "string" ~/~/ Комментарий
4977 - }
4978 - ],
4979 - "cropVegetation": [ ~/~/ История вегетации поля
4980 - {
4981 - "values": [ ~/~/ Данные вегетации и состояния посева
4982 - {
4983 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4984 - "ndvi": 0 ~/~/ Индекс вегетации
4985 - }
4986 - ],
4987 - "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
4988 - {
4989 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4990 - "type": "string", ~/~/ Тип 
4991 - "pictureid": "string" ~/~/ Идентификатор ресурса
4992 - }
4993 - ],
4994 - "states": [ ~/~/ Ключевые даты развития поля
4995 - {
4996 - "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
4997 - "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
4998 - }
4999 - ]
5000 - }
5001 - ],
5002 - "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5003 - "counts": {
5004 - "fieldOperations": 0, ~/~/ Количество операций на поле
5005 - "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5006 - "facts": 0 ~/~/ Счётчик факта
5007 - },
5008 - "planComment": "string", ~/~/ Комментарий к полю
5009 - "productivity": 0, ~/~/ Урожайность.
5010 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5011 -)))
5012 -
5013 -(((
5014 -(((
5015 - "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5016 - "year": 0, ~/~/ Год поля
5017 - "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5018 - "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5019 - "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5020 - "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5021 - "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5022 - "id": 0, ~/~/ Идентификатор объекта геозоны
5023 - "name": "string", ~/~/ Название объекта геозоны
5024 - "type": 0, ~/~/ Тип объекта геозоны 
5025 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5026 - "fname": "string", ~/~/ Имя файла
5027 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5028 - "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5029 - "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5030 - "description": "string", ~/~/ Описание объекта геозоны
5031 - "area": 0, ~/~/ Площадь, м2
5032 - "perimetr": 0, ~/~/ Периметр, м
5033 - "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5034 -}
5035 -)))
5036 -
5037 -
5038 -== **Удаление существующего поля** ==
5039 -
5040 -(% class="box errormessage" %)
5041 -(((
5042 -**DELETE /api/v3/agroLands/{id}**
5043 -)))
5044 -
5045 -Пример запроса:
5046 -id  ~/~/ Идентификатор поля
5047 -
5048 -Пример ответа:
5049 -
5050 -(((
5051 -200 ~/~/ Успех
5052 -)))
5053 -
5054 -(((
5055 -
5056 -)))
5057 -
5058 -(((
5059 -(((
5060 -(((
5061 -
5062 -)))
5063 -
5064 -(((
5065 -== **Изменение поля** ==
5066 -
5067 -(% class="box infomessage" %)
5068 -(((
5069 -**PUT /api/v3/agroLands**
5070 -)))
5071 -
5072 -Пример запроса:
5073 -
5074 -(((
5075 -(((
5076 -{
5077 - "id": 0, ~/~/ Идентификатор поля
5078 - "extId": "string", ~/~/ ExtId
5079 - "shape": "string", ~/~/ Форма поля
5080 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5081 - "display": "string", ~/~/ Настройки отображения
5082 - "year": 0, ~/~/ Год поля
5083 - "name": "string", ~/~/ Наименование
5084 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5085 - "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5086 - "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5087 - "planComment": "string", ~/~/Комментарий к полю
5088 - "cropRotations": [  ~/~/ Данные по севообороту
5089 - {
5090 - "landId": 0, ~/~/ ID поля
5091 - "landName": "string", ~/~/ Название поля
5092 - "year": 0, ~/~/ Год урожая
5093 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5094 - "cultureName": "string", ~/~/ Название культуры
5095 - "productivity": 0, ~/~/ Урожайность
5096 - "area": 0, ~/~/ Площадь поля, Га.
5097 - "total": 0, ~/~/ Валовый сбор
5098 - "productivityFact": 0, ~/~/ Фактическая урожайность
5099 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5100 - "totalFact": 0, ~/~/ Фактический валовый сбор
5101 - "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5102 - "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5103 - "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5104 - "isyearplan": true, 
5105 - "comment": "string" ~/~/ Комментарий
5106 - }
5107 - ],
5108 - "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5109 -}
5110 -)))
5111 -)))
5112 -
5113 -(((
5114 -
5115 -)))
5116 -
5117 -Пример ответа:
5118 -
5119 -(((
5120 -(((
5121 -(((
5122 -{
5123 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5124 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5125 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5126 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5127 - "cropRotations": [ ~/~/ Данные по севообороту
5128 - {
5129 - "landId": 0, ~/~/ ID поля
5130 - "landName": "string", ~/~/ Название поля
5131 - "year": 0, ~/~/  Год урожая
5132 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5133 - "cultureName": "string", ~/~/ Название культуры
5134 - "productivity": 0, ~/~/ Урожайность
5135 - "area": 0, ~/~/ Площадь поля, Га
5136 - "total": 0, ~/~/ Валовый сбор
5137 - "productivityFact": 0, ~/~/ Фактическая урожайность
5138 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5139 - "totalFact": 0, ~/~/ Фактический валовый сбор
5140 - "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5141 - "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5142 - "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5143 - "isyearplan": true, ~/~/ 
5144 - "comment": "string" ~/~/ Комментарий
5145 - }
5146 - ],
5147 - "cropVegetation": [ ~/~/ История вегетации поля
5148 - {
5149 - "values": [ ~/~/ Данные вегетации и состояния посева
5150 - {
5151 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5152 - "ndvi": 0 ~/~/ Индекс вегетации
5153 - }
5154 - ],
5155 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5156 - {
5157 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5158 - "type": "string", ~/~/ Тип
5159 - "pictureid": "string" ~/~/ Идентификатор ресурса
5160 - }
5161 - ],
5162 - "states": [ ~/~/ Ключевые даты развития поля 
5163 - {
5164 - "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5165 - "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5166 - }
5167 - ]
5168 - }
5169 - ],
5170 - "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5171 - "counts": { 
5172 - "fieldOperations": 0, ~/~/ Количество операций на поле
5173 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5174 - "facts": 0 ~/~/ Счётчик факта
5175 - },
5176 - "planComment": "string", ~/~/ Комментарий к полю
5177 - "productivity": 0, ~/~/ Урожайность.
5178 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5179 - "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5180 - "year": 0, ~/~/ Год поля
5181 - "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5182 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5183 - "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5184 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5185 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5186 - "id": 0, ~/~/ Идентификатор объекта геозоны
5187 - "name": "string", ~/~/ Название объекта геозоны
5188 - "type": 0, ~/~/ Тип объекта геозоны
5189 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5190 - "fname": "string", ~/~/ Имя файла
5191 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5192 - "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5193 - "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5194 - "description": "string", ~/~/ Описание объекта геозоны
5195 - "area": 0, ~/~/ Площадь, м2
5196 - "perimetr": 0, ~/~/ Периметр, м
5197 - "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5198 -}
5199 -)))
5200 -)))
5201 -)))
5202 -)))
5203 -)))
5204 -
5205 -
5206 -== **Редактирование года урожая ** ==
5207 -
5208 -(% class="box successmessage" %)
5209 -(((
5210 -**POST /api/v3/agroLands/updateOpenCloseYear**
5211 -)))
5212 -
5213 -Пример запроса:
5214 -
5215 -(((
5216 -(((
5217 -{
5218 - "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5219 - 0
5220 - ],
5221 - "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5222 - "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5223 -}
5224 -)))
5225 -
5226 -
5227 -)))
5228 -
5229 -Пример ответа:
5230 -
5231 -(((
5232 -(((
5233 -{
5234 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5235 - "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5236 - "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5237 - "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5238 - "cropRotations": [ ~/~/ Данные по севообороту
5239 - {
5240 - "landId": 0, ~/~/ ID поля
5241 - "landName": "string", ~/~/ Название поля
5242 - "year": 0, ~/~/ Год урожая
5243 - "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5244 - "cultureName": "string", ~/~/ Название культуры
5245 - "productivity": 0, ~/~/ Урожайность
5246 - "area": 0, ~/~/ Площадь поля, Га.
5247 - "total": 0, ~/~/ Валовый сбор
5248 - "productivityFact": 0, ~/~/ Фактическая урожайность
5249 - "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5250 - "totalFact": 0, ~/~/ Фактический валовый сбор
5251 - "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5252 - "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5253 - "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5254 - "isyearplan": true, ~/~/ 
5255 - "comment": "string" ~/~/ Комментарий
5256 - }
5257 - ],
5258 - "cropVegetation": [ ~/~/ История вегетации поля
5259 - {
5260 - "values": [ ~/~/ Данные вегетации и состояния посева
5261 - {
5262 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5263 - "ndvi": 0 ~/~/ Индекс вегетации
5264 - }
5265 - ],
5266 - "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5267 - {
5268 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5269 - "type": "string", ~/~/ Тип
5270 - "pictureid": "string" ~/~/ Идентификатор ресурса
5271 - }
5272 - ],
5273 - "states": [ ~/~/ Ключевые даты развития поля
5274 - {
5275 - "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5276 - "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5277 - }
5278 - ]
5279 - }
5280 - ],
5281 - "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5282 - "counts": { 
5283 - "fieldOperations": 0, ~/~/ Количество операций на поле
5284 - "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5285 - "facts": 0 ~/~/ Счётчик факта
5286 - },
5287 - "planComment": "string", ~/~/ Комментарий к полю
5288 - "productivity": 0, ~/~/ Урожайность.
5289 - "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5290 - "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5291 - "year": 0, ~/~/ Год поля
5292 - "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5293 - "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5294 - "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5295 - "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5296 - "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5297 - "id": 0, ~/~/ Идентификатор объекта геозоны
5298 - "name": "string", ~/~/ Название объекта геозоны
5299 - "type": 0, ~/~/ Тип объекта геозоны
5300 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5301 - "fname": "string", ~/~/ Имя файла
5302 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5303 - "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5304 - "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5305 - "description": "string", ~/~/ Описание объекта геозоны
5306 - "area": 0, ~/~/ Площадь, м2
5307 - "perimetr": 0, ~/~/ ериметр, м
5308 - "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5309 -}
5310 -)))
5311 -
5312 -
5313 -== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==
5314 -)))
5315 -)))
5316 -)))
5317 -
5318 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5319 -
5320 -
5321 -(% class="box infomessage" %)
5322 -(((
5323 -**GET api/v3/Vehicles/recyclebin/all**
5324 -)))
5325 -
5326 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5327 -
5328 -Параметр запроса: {parentId} - идентификатор агента
5329 -
5330 5330  В заголовках запроса: X-Auth: Токен авторизации
5331 5331  
5332 -Ответ:
438 +Ответ: В случае если сессия активна HTTP ответ «200» В случае если сессия разорвана HTTP ответ «401»
5333 5333  
5334 -[ 
5335 - {
5336 - "recordTime": "", ~/~/Время записи
5337 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5338 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5339 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
5340 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5341 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5342 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5343 - "items": [ ~/~/ 
5344 -nullable: true ~/~/Детали
5345 - {
5346 - "name": "string", ~/~/наименование столбца
5347 - "value": "string" ~/~/содержание столбца
5348 - }
5349 - ]
5350 - },
5351 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5352 - "string"
5353 - ]
5354 - }
5355 -]
5356 -
5357 -
5358 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
5359 -
5360 -(% class="box infomessage" %)
5361 -(((
5362 -**POST api/v3/Vehicles/recyclebin/erase**
5363 -)))
5364 -
5365 -В заголовках запроса: X-Auth: Токен авторизации
5366 -
5367 -Пример запроса:
5368 -
5369 -[
5370 -0
5371 -]
5372 -
5373 -
5374 -Пример ответа:
5375 -
5376 -[ 
5377 -{
5378 - "recordTime": "", ~/~/Время записи
5379 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5380 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5381 - "objectId": 0, ~/~/ID объекта, помещённого в корзин
5382 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5383 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5384 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5385 - "items": [ ~/~/Детали
5386 - {
5387 - "name": "", ~/~/Имя свойства
5388 - "value": "" ~/~/Значение свойства
5389 - }
5390 - ]
5391 - },
5392 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5393 - ""
5394 - ]
5395 - }
5396 -]
5397 -
5398 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5399 -
5400 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5401 -
5402 -(% class="box infomessage" %)
5403 -(((
5404 -**POST api/v3/Vehicles/recyclebin/restore**
5405 -)))
5406 -
5407 -В заголовках запроса: X-Auth: Токен авторизации
5408 -
5409 -Параметры в теле запроса (JSON):
5410 -
5411 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5412 -
5413 -В заголовках запроса: X-Auth: Токен авторизации
5414 -
5415 -
5416 -Пример запроса:
5417 -
5418 -(((
5419 -[
5420 -)))
5421 -
5422 -(((
5423 - 0
5424 -)))
5425 -
5426 -(((
5427 -]
5428 -)))
5429 -
5430 -
5431 -Пример ответа:
5432 -
5433 -[
5434 -{
5435 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5436 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5437 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5438 - "objectId": 0, ~/~/ID объекта, помещённого в корзину
5439 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5440 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5441 - "details": { ~/~/Список деталей объекта, помещённого в корзину
5442 - "items": [ ~/~/Детали
5443 - {
5444 - "name": "string", ~/~/Имя свойства
5445 - "value": "string" ~/~/Значение свойства
5446 - }
5447 - ]
5448 - },
5449 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5450 - "string"
5451 - ]
5452 - }
5453 -]
5454 -
5455 -
5456 -
5457 -(% class="box" lang="en-US" style="text-align: center;" %)
5458 -(((
5459 -(% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
5460 -)))
440 +**Расширенное описание API доступно по запросу на support@glonasssoft.ru**
Icon image-20231020124453-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.krainovim
Size
... ... @@ -1,1 +1,0 @@
1 -268.0 KB
Content Icon

Меню

ГЛОНАССSoft wiki - 2024 г.